influx-cli

CLI for managing resources in InfluxDB v2

Motivation

This repository decouples the influx CLI from the OSS influxdb codebase. Our goals are to:

1. Make it easier to keep the CLI up-to-date with InfluxDB Cloud API changes
2. Enable faster turn-around on fixes/features that only affect the CLI
3. Allow the CLI to be built & released for a wider range of platforms than the server can support

Building the CLI

Follow these steps to build the CLI. If you're updating your CLI build, see Updating openapi below.

1. Clone this repo (influx-cli) and change to your influx-cli directory.

   git clone [email protected]:influxdata/influx-cli.git
   cd influx-cli
   

2. Build the CLI. The make and make influx commands write the new binary to bin/$(GOOS)/influx.

   make
   

Updating openapi

If you change or update your branch, you may also need to update influx-cli/openapi and regenerate the client code. influx-cli/openapi is a Git submodule that contains the underlying API contracts and client used by the CLI. We use OpenAPITools/openapi-generator to generate the HTTP client.

To update, run the following commands in your influx-cli repo:

1. Update the openapi Git submodule. The following command pulls the latest commits for the branch and all submodules.

   git pull --recurse-submodules

2. With Docker running locally, regenerate openapi.

   make openapi

3. Rebuild the CLI

   make

Running the CLI

After building, use influx -h to see the list of available commands.

Enabling Completions

The CLI supports generating completions for bash, zsh, and powershell. To enable completions for a single shell session, run one of these commands:

# For bash:
source <(influx completion bash)
# For zsh:
source <(influx completion zsh)
# For pwsh:
Invoke-Expression ((influx completion powershell) -join "`n`")

To enable completions across sessions, add the appropriate line to your shell's login profile (i.e. ~/.bash_profile).

Testing

Run make test to run unit tests.