README
¶
Axiom CLI
The Axiom command-line application is a fast and straightforward tool for interacting with Axiom.
Table of Contents
Introduction
The official command line client for Axiom. Axiom CLI brings the power of Axiom to the command-line.
Goal
The Goal of the Axiom CLI is to create, manage, build and test your Axiom projects.
Installation
Installing the CLI globally provides access to the Axiom command.
Download and install the pre-compiled binary manually
Binary releases are available on GitHub Releases.
Install using Homebrew
brew tap axiomhq/tap
brew install axiom
To update:
brew upgrade axiom
Install using go install
go install github.com/axiomhq/cli/cmd/axiom@latest
Install from source
git clone https://github.com/axiomhq/cli.git
cd cli
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
Validate installation
In all cases the installation can be validated by running axiom -v in the
terminal:
Axiom CLI version 1.0.0
Usage
axiom <command>
axiom <command> <subcommand> [flags]
Configuration
The default configuration file is .axiom.toml located in the home directory.
Configuration values can also be set using flags or the environment. Flags get
precedence over environment variables which get precedence over the
configuration file values.
Troubleshooting
When axiom does not respect your configuration or unexpected errors occur,
make sure your environment is clean of any AXIOM_ prefixed variables.
Documentation
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.
Commands
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 Axiom |
| axiom auth logout | Logout of Axiom |
| axiom auth select | Select an Axiom 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 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 an api token |
| axiom token api delete | Delete an api token |
| axiom token personal create | Create a personal token |
| axiom token personal delete | Delete a personal 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 |
Learn more
# To get help on any information
axiom help
# For more information about a command.
axiom <command> --help
axiom <command> <subcommand> --help
Read the manual at https://www.axiom.co/docs/reference/cli
Contributing
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.
License
© Axiom, Inc., 2022
Distributed under MIT License (The MIT License).
See LICENSE for more information.
Documentation
Source Files
Directories