Install and use the influx CLI
The influx CLI is packaged and versioned separately from the InfluxDB server (influxd
).
Do one of the following:
If you used Homebrew to install InfluxDB v2.2, the influxdb-cli
formula was downloaded as a dependency and should already be installed. If installed, influxdb-cli
will appear in the output of the following command:
brew list | grep influxdb-cli
Download the
influx
CLI package.(Optional) Place the binary in your
$PATH
.(macOS Catalina and newer) Authorize the
influx
binary.macOS requires downloaded binaries to be signed by registered Apple developers. When you first attempt to run
influx
, macOS will prevent it from running. To authorize theinflux
binary:- Attempt to run an
influx
command. - Open System Preferences and click Security & Privacy.
- Under the General tab, there is a message about being blocked. Click Open Anyway.
- Attempt to run an
Download the influx CLI package.
Download the
influx
CLI package from your browser or .Download from your browser
Download from the command line
# amd64
wget https://dl.influxdata.com/influxdb/releases/influxdb2-client--linux-amd64.tar.gz
# arm
wget https://dl.influxdata.com/influxdb/releases/influxdb2-client--linux-arm64.tar.gz
Unpackage the downloaded package.
*Note: The following commands are examples. Adjust the filenames, paths, and utilities if necessary.*
# amd64
# arm
tar xvzf path/to/influxdb2-client--linux-arm64.tar.gz
(Optional) Place the unpackaged
influx
executable in your system$PATH
.If you do not move the
influx
binary into your$PATH
, prefix the executable to run it in place.Download the
influx
CLI package.-
Expand the downloaded archive into
C:\Program Files\InfluxData\
and rename it if desired.> Expand-Archive .\influxdb2-client--windows-amd64.zip -DestinationPath 'C:\Program Files\InfluxData\'
> mv 'C:\Program Files\InfluxData\influxdb2-client--windows-amd64' 'C:\Program Files\InfluxData\influx'
Grant network access to the
influx
CLI.When using the
influx
CLI for the first time, Windows Defender displays the following message:To grant the
influx
CLI the required access, do the following:- Select Private networks, such as my home or work network.
- Click Allow access.
To avoid having to pass your InfluxDB host, API token, and organization with each command, store them in an influx
CLI configuration (config). influx
commands that require these credentials automatically retrieve these credentials from the active config.
Use the to create an influx
CLI config and set it as active:
influx config create --config-name <config-name> \
--host-url http://localhost:8086 \
--org <your-org> \
--token <your-auth-token> \
For more information about managing CLI configurations, see the influx config documentation.
For instructions on how to create API tokens, see .
To install shell completion scripts, see influx completion.
For information about influx
CLI commands, see the .