Axiom's command line interface (CLI) is an Axiom tool that lets you test, manage, and build your Axiom projects by typing commands on the command-line.
You can use the command line to Ingest data, manage authentication state, and configure multiple organizations.
Install using go install
To install Axiom CLI, make sure you have Go version 1.16 or higher, then run this command from any directory in your terminal.
go install github.com/axiomhq/cli/cmd/axiom@latest
Install using Homebrew
You can also install the CLI using Homebrew
brew tap axiomhq/tap
brew install axiom
This installs Axiom command globally so you can run
axiom commands from any directory.
brew upgrade axiom
Install from source
git clone https://github.com/axiomhq/cli.git
make install # Build and install binary into $GOPATH
Run the Docker image
Docker images are available on DockerHub.
docker pull axiomhq/cli
docker run axiomhq/cli
You can check the version and find out basic commands about Axiom CLI by running the following command:
The easiest way to start using Axiom CLI is by logging in through the command line. Simply run
axiom auth login or simply
axiom if no prior configuration exists. This will guide you through a straightforward login process.
While most users will only need to manage a single Axiom deployment, Axiom CLI provides the capability to switch between multiple organizations for those who require it. You can easily switch between organizations using straightforward CLI commands. For example,
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_ORG_ID are important for configuring your environment. The
AXIOM_URL should be set to
https://api.axiom.co. 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:
AXIOM_DEPLOYMENT: The deployment to use. Overwrites the choice loaded
from the configuration file.
AXIOM_ORG_ID: The organization ID of the organization the access
token is valid for. Only valid for Axiom Cloud.
AXIOM_PAGER, PAGER (in order of precedence): A terminal paging
program to send standard output to, e.g. "less".
AXIOM_TOKEN: Token The access token to use. Overwrites the choice
loaded from the configuration file.
AXIOM_URL: The deployment url to use. Overwrites the choice loaded
from the configuration file.
VISUAL, EDITOR (in order of precedence): The editor to use for
NO_COLOR: Set to any value to avoid printing ANSI escape sequences
for color output.
CLICOLOR: Set to "0" to disable printing ANSI colors in output.
CLICOLOR_FORCE: Set to a value other than "0" to keep ANSI colors in
output even when the output is piped.
The One-Click Login is an easier way to authenticate Axiom-CLI and log in to your Axiom deployments and account resources directly on your terminal using the Axiom CLI.
You can generate an ingest and personal token manually in your Axiom user settings.
See Tokens to know more about managing access and authorization.
Axiom CLI lets you ingest, authenticate, and stream data.
For more information about Configuration, managing authentication status, ingesting, streaming, and more, visit the Axiom CLI repository on GitHub.
Axiom CLI supports the ingestion of different formats of data ( JSON, NDJSON, and CSV)
Get deeper insights into your data using Axiom Processing Language
Import, transfer, load and process data for later use or storage using the Axiom CLI. With Axiom CLI you can Ingest the contents of a JSON, NDJSON, CSV logfile into a dataset.
To view a list of all the available commands run
axiom on your terminal:
➜ ~ axiom
The power of Axiom on the command-line.
axiom <command> <subcommand> [flags]
ingest: Ingest structured data
query: Query data using APL
stream: Livestream data
auth: Manage authentication state
config: Manage configuration
dataset: Manage datasets
completion: Generate shell completion scripts
help: Help about any command
version: Print version
web: Open Axiom in the browser
-O, --auth-org-id string Organization ID to use
-T, --auth-token string Token to use
-C, --config string Path to configuration file to use
-D, --deployment string Deployment to use
-h, --help Show help for command
--no-spinner Disable the activity indicator
-v, --version Show axiom version
$ axiom auth login
$ axiom version
$ cat http-logs.json | axiom ingest http-logs
See 'axiom help credentials' for help and guidance on authentication.
See 'axiom help environment' for the list of supported environment variables.
Use 'axiom <command> <subcommand> --help' for more information about a command.
Read the manual at https://axiom.co/docs/reference/cli
Below are the commonly used commands on Axiom CLI
|Query data using APL
|Live stream data
|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
|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
|Help about any command
|Open Axiom in the browser
To get usage tips and learn more about available commands from within Axiom CLI, run the following:
For more information about a specific command, run
help with the name of the command.
axiom help auth
This also works for sub-commands.
axiom help auth status
if you have questions, or any opinions you can start an issue on Axiom CLI's open source repository.
You can also visit our Discord community to start or join a discussion. We’d love to hear from you!