Learn how to use the Axiom CLI to ingest data, manage authentication state, and configure multiple deployments.
axiom
commands from any directory.
To update:
axiom auth login
or simply axiom
if no prior configuration exists. This will guide you through a straightforward login process.
axiom auth switch-org
lets you change your active organization, or you can set the AXIOM_ORG_ID
environment variable for the same purpose.
Every setting in Axiom CLI can be overwritten via environment variables configured in the ~/.axiom.toml
file. Specifically, AXIOM_URL
, AXIOM_TOKEN
, and AXIOM_ORG_ID
are important for configuring your environment. Set AXIOM_URL
to your Axiom domain. For more information, see Regions. You can switch between environments using the axiom auth select
command.
To view available environment variables, run axiom help environment
for an up to date list of env vars:
Field list
axiom
on your terminal:
Commands | Description |
---|---|
axiom ingest | Ingest data |
axiom query | Query data using APL |
axiom stream | Live stream data |
Commands | Description |
---|---|
axiom auth login | Login to Axiom |
axiom auth logout | Logout of Axiom |
axiom auth select | Select an Axiom environment configuration |
axiom auth status | View authentication status |
axiom auth switch-org | Switch the organization |
axiom auth update-token | Update the token used to authenticate |
axiom config edit | Edit the configuration file |
axiom config get | Get a configuration value |
axiom config set | Set a configuration value |
axiom config export | Export the configuration values |
axiom dataset create | Create a dataset |
axiom dataset delete | Delete a dataset |
axiom dataset list | List all datasets |
axiom dataset trim | Trim a dataset to a given size |
axiom dataset update | Update a dataset |
Commands | Description |
---|---|
axiom completion bash | Generate shell completion script for bash |
axiom completion fish | Generate shell completion script for fish |
axiom completion powershell | Generate shell completion script for powershell |
axiom completion zsh | Generate shell completion script for zsh |
axiom help | Help about any command |
axiom version | Print version |
axiom web | Open Axiom in the browser |
help
with the name of the command.