The Axiom command-line application is a fast and straightforward tool for interacting with Axiom.
The official command line client for Axiom. Axiom CLI brings the power of Axiom to the command-line.
The Goal of the Axiom CLI is to create, manage, build and test your Axiom projects.
Installing the CLI globally provides access to the Axiom command.
Binary releases are available on GitHub Releases.
Install using Homebrew
brew tap axiomhq/tap
brew install axiomTo update:
brew upgrade axiomgo install github.com/axiomhq/cli/cmd/axiom@latestgit clone https://github.com/axiomhq/cli.git
cd cli
make install # Build and install binary into $GOPATHDocker images are available on DockerHub.
docker pull axiomhq/cli
docker run axiomhq/cliIn all cases the installation can be validated by running axiom -v in the
terminal which will return the CLI version number. Example:
$ axiom -v
Axiom CLI version 1.0.0Install using Snap
sudo snap install axiomTo send all system logs to Axiom:
# Allow Axiom to access system logs
sudo snap connect axiom:log-observe
# Configure the background service
sudo snap set axiom journald-dataset=DATASET journald-url=URL journald-token=TOKENaxiom <command>
axiom <command> <subcommand> [flags]To learn how to log in to Axiom and start gaining instant, actionable insights, and start storing and querying unlimited machine data, visit the documentation on Axiom.
For full command reference, see the list below, or visit cli.axiom.com.
Core Commands
| Commands | Description |
|---|---|
| axiom ingest | Ingest data |
| axiom query | Query data using APL |
| axiom stream | Live stream data |
Management Commands
| Commands | Description |
|---|---|
| axiom auth login | Login to an Axiom deployment |
| axiom auth logout | Logout of an Axiom deployment |
| axiom auth select | Select an Axiom deployment |
| axiom auth status | View authentication status |
| axiom auth switch-org | Switch the organization |
| axiom auth update-token | Update the token of a deloyment |
| axiom config edit | Edit the configuration file |
| axiom config get | Get a configuration value |
| axiom config set | Set a configuration value |
| axiom dataset create | Create a dataset |
| axiom dataset delete | Delete a dataset |
| axiom dataset info | Get info about a dataset |
| axiom dataset list | List all datasets |
| axiom dataset stats | Get statistics about all datasets |
| axiom dataset trim | Trim a dataset to a given size |
| axiom dataset update | Update a dataset |
| axiom organization info | Get info about an organization |
| axiom organization license | Get an organizations license |
| axiom organization list | List all organizations |
| axiom organization keys get | Get shared access keys of an organization |
| axiom organization keys rotate | Rotate shared access keys of an organization |
| axiom token api create | Create a token |
| axiom token api delete | Delete a token |
| axiom token personal create | Create a token |
| axiom token personal delete | Delete a token |
Additional Commands
| 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 |
# To get help on any information
axiom help
# For more information about a command.
axiom <command> --help
axiom <command> <subcommand> --helpRead the manual at https://www.axiom.co/docs/reference/cli
Feel free to submit PRs or to fill issues. Every kind of help is appreciated.
Before committing, make should run without any issues.
Kindly check our Contributing guide on how to propose bugfixes and improvements, and submitting pull requests to the project.
More information about the project layout is documented here.
© Axiom, Inc., 2022
Distributed under MIT License (The MIT License).
See LICENSE for more information.