docs-v2/content/influxdb/v2.1/tools/influx-cli.md

title	description	menu	weight	influxdb/v2.1/tags	aliases	related
Install and use the influx CLI	Use the `influx` and `influxd` command line interfaces to interact with and manage InfluxDB.	influxdb_2_1 name parent identifier Use the influx CLI Tools & integrations influx-cli-task-based	101	cli	/influxdb/v2.1/tools/clis/	/influxdb/v2.1/reference/cli/influx/

Use the influx CLI to interact with and manage your InfluxDB {{% cloud-only %}}Cloud{{% /cloud-only %}} instance. Write and query data, generate InfluxDB templates, export data, and more.

{{% oss-only %}}

{{% note %}} The influx CLI is packaged and versioned separately from the InfluxDB server (influxd). {{% /note %}}

{{% /oss-only %}}

• Install the influx CLI
• Set up the influx CLI
• Use influx CLI commands

Install the influx CLI

{{< tabs-wrapper >}} {{% tabs %}} macOS Linux Windows {{% /tabs %}}

{{% tab-content %}}

Do one of the following:

• Use Homebrew
• Manually download and install

Use Homebrew

brew install influxdb-cli

{{% oss-only %}}

{{% note %}} If you used Homebrew to install InfluxDB v{{< current-version >}}, 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

{{% /note %}}

{{% /oss-only %}}

Manually download and install

1. Download the influx CLI package.

   influx CLI v{{< latest-patch cli=true >}} (macOS)

2. Unpackage the downloaded package.

   Do one of the following:

   • Double-click the downloaded package file in Finder.

   • Run the following command in a macOS command prompt application such Terminal or iTerm2:

     # Unpackage contents to the current working directory
     tar zxvf ~/Downloads/influxdb2-client-{{< latest-patch cli=true >}}-darwin-amd64.tar.gz
     

3. (Optional) Place the binary in your $PATH.

   # (Optional) Copy the influx binary to your $PATH
   sudo cp ~/Downloads/influxdb2-client-{{< latest-patch cli=true >}}-darwin-amd64/influx /usr/local/bin/
   

   If you do not move the influx binary into your $PATH, prefix the executable ./ to run it in place.

4. (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 the influx binary:

   1. Attempt to run an influx command.
   2. Open System Preferences and click Security & Privacy.
   3. Under the General tab, there is a message about influx being blocked. Click Open Anyway.

{{% /tab-content %}}

{{% tab-content %}}

1. Download the influx CLI package.

   Download the influx CLI package from your browser or from the command line.

   Download from your browser

   influx CLI v{{< latest-patch cli=true >}} (amd64) influx CLI v{{< latest-patch cli=true >}} (arm)

   Download from the command line

   # amd64
   wget https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-linux-amd64.tar.gz
   
   # arm
   wget https://dl.influxdata.com/influxdb/releases/influxdb2-client-{{< latest-patch cli=true >}}-linux-arm64.tar.gz
   

2. Unpackage the downloaded package.

   Note: The following commands are examples. Adjust the filenames, paths, and utilities if necessary.

   # amd64
   tar xvzf path/to/influxdb2-client-{{< latest-patch cli=true >}}-linux-amd64.tar.gz
   
   # arm
   tar xvzf path/to/influxdb2-client-{{< latest-patch cli=true >}}-linux-arm64.tar.gz
   

3. (Optional) Place the unpackaged influx executable in your system $PATH.

   # amd64
   sudo cp influxdb2-client-{{< latest-patch cli=true >}}-linux-amd64/influx /usr/local/bin/
   
   # arm
   sudo cp influxdb2-client-{{< latest-patch cli=true >}}-linux-arm64/influx /usr/local/bin/
   

   If you do not move the influx binary into your $PATH, prefix the executable ./ to run it in place.

{{% /tab-content %}}

{{% tab-content %}}

1. Download the influx CLI package.

   influx CLI v{{< latest-patch cli=true >}} (Windows)

2. Expand the downloaded archive.

   Expand the downloaded archive into C:\Program Files\InfluxData\ and rename it if desired.

   > Expand-Archive .\influxdb2-client-{{< latest-patch cli=true >}}-windows-amd64.zip -DestinationPath 'C:\Program Files\InfluxData\'
   > mv 'C:\Program Files\InfluxData\influxdb2-client-{{< latest-patch cli=true >}}-windows-amd64' 'C:\Program Files\InfluxData\influx'
   

3. Grant network access to the influx CLI.

   When using the influx CLI for the first time, Windows Defender displays the following message:

   Windows Defender Firewall has blocked some features of this app.

   To grant the influx CLI the required access, do the following:

   1. Select Private networks, such as my home or work network.
   2. Click Allow access.

{{% /tab-content %}}

{{< /tabs-wrapper >}}

Set up the influx CLI

• Provide required authentication credentials
• Enable shell completion (Optional)

Provide required authentication credentials

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 influx config create command 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> \
  --active

For more information about managing CLI configurations, see the influx config documentation.

For instructions on how to create API tokens, see Create a token.

Enable shell completion (Optional)

To install influx shell completion scripts, see influx completion.

Use influx CLI commands

For information about influx CLI commands, see the influx CLI reference documentation.