SETUP GUIDE
AntOps CLI
Use the published AntOps command-line client with a workspace API key kept outside command history and source control.
Before you start
- Python 3.12 or later
- A workspace API key
- A shell environment or secret manager
Setup
- Install the current release with python -m pip install antops==0.2.1.
- Export ANTOPS_API_KEY from a secure environment source.
- Run antops auth status.
- Run a bounded useful command such as antops company lookup GB 00000006 --json.
Verify and expected result
auth status reads the workspace endpoint using the configured key. CLI errors return a non-zero exit code and omit the API key.
The CLI defaults to https://api.antops.dev. Set ANTOPS_BASE_URL only for a compatible non-production endpoint.
Common safe checks
No API key
Set ANTOPS_API_KEY or use antops auth login --stdin only from a secure local input source. API keys are never command-line flags.
Request failed
Check the key's active state and connection. Timeout, authentication and rate-limit failures remain safe and do not reveal the key.
Security and revocation
Do not commit ANTOPS_API_KEY. The CLI uses bounded response sizes and a 15-second default client timeout.
Remove the local environment or runbook reference and revoke the associated API key in AntOps.