Install and use the influx CLI
Use the influx CLI to interact with and manage your
InfluxDB Cloud instance.
Write and query data, generate InfluxDB templates, export data, and more.
Install the influx CLI
We recommend running influx CLI commands in Powershell.
Command Prompt is not fully compatible.
Download the
influxCLI package.Expand the downloaded archive.
Expand the downloaded archive into
C:\Program Files\InfluxData\and rename it if desired.> Expand-Archive .\influxdb2-client-2.7.5-windows-amd64.zip -DestinationPath 'C:\Program Files\InfluxData\' > mv 'C:\Program Files\InfluxData\influxdb2-client-2.7.5-windows-amd64' 'C:\Program Files\InfluxData\influx'Grant network access to the
influxCLI.When using the
influxCLI for the first time, Windows Defender displays the following message:Windows Defender Firewall has blocked some features of this app.
To grant the
influxCLI the required access, do the following:- Select Private networks, such as my home or work network.
- Click Allow access.
Set up the influx CLI
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 https://cloud2.influxdata.com \
--org ORG \
--token API_TOKEN \
--active
Replace the following:
CONFIG_NAME: Connection configuration name.ORG_NAME: your InfluxDB organization.API_TOKEN: your API token.
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.
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support. Customers using a trial license can email trial@influxdata.com for assistance.