/cli

The power of Axiom on the command line.

Primary LanguageGoMIT LicenseMIT

Axiom CLI

Documentation Go Workflow Coverage Status Go Report Latest Release License

The Axiom command-line application is a fast and straightforward tool for interacting with Axiom.

Table of Contents

  1. Introduction
  2. Goal
  3. Installation
  4. Usage
  5. Documentation
  6. Commands
  7. Contributing
  8. License

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

Install using go get

$ go get -u github.com/axiomhq/cli/cmd/axiom

Install from source

This project uses native go mod support.

$ git clone https://github.com/axiomhq/cli.git
$ cd cli
$ make install # Build and install binary into $GOPATH

Validate installation

In all cases the installation can be validated by running axiom -v in the terminal:

Axiom CLI version 0.1.0

Usage

$ axiom <command> 
$ axiom <command> <subcommand> [flags]

# Run `help` for detailed information about commands
$ axiom help <command>

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 stream Live stream data

Management Commands

Commands Description
axiom auth Manage Authentication State
axiom config Manage Configuration
axiom dataset Manage datasets

Additional Commands

Commands Description
axiom auth login Login to an Axiom deployment
axiom auth status View authentication status
axiom auth select Select an Axiom deployment
axiom auth logout Logout of an Axiom deployment
axiom config get Get a configuration value
axiom config set Set a configuration value
axiom config edit Edit the configuration file
axiom dataset create Create a dataset
axiom dataset list List all datasets
axiom dataset info Get info about a dataset
axiom dataset update Update a dataset
axiom dataset delete Delete a dataset
axiom dataset stats Get statistics about all datasets
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

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://docs.axiom.co/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., 2020

Distributed under MIT License (The MIT License).

See LICENSE for more information.

License Status