docs-v2/content/v2.0/reference/cli/influx/_index.md

4.4 KiB

title seotitle description menu weight v2.0/tags
influx - InfluxDB command line interface influx - InfluxDB command line interface The `influx` CLI includes commands to manage many aspects of InfluxDB, including buckets, organizations, users, tasks, etc.
v2_0_ref
name parent
influx Command line tools
101
cli

The influx command line interface (CLI) includes commands to manage many aspects of InfluxDB, including buckets, organizations, users, tasks, etc.

Usage

influx [flags]
influx [command]

{{% note %}}

Store your InfluxDB authentication token

To avoid having to pass your InfluxDB authentication token with each influx command, use one of the following methods to store your token:

  1. Set the INFLUX_TOKEN environment variable using your token.

    export INFLUX_TOKEN=oOooYourAuthTokenOoooOoOO==
    
  2. Store your token in ~/.influxdbv2/credentials. The content of the credentials file should be only your token.

If you set up InfluxDB using the CLI, InfluxDB stores your token in the credentials files automatically.

See View tokens for information about retrieving authentication tokens. {{% /note %}}

Commands

Command Description
apply Apply an InfluxDB template
auth Authorization management commands
backup Back up data
bucket Bucket management commands
completion Generate completion scripts
config Configuration management commands
dashboards List dashboards
delete Delete points from InfluxDB
export Export resources as a template
help Help about any command
org Organization management commands
ping Check the InfluxDB /health endpoint
query Execute a Flux query
repl Interactive REPL (read-eval-print-loop)
secret Manage secrets
setup Create default username, password, org, bucket, etc.
stacks Manage InfluxDB stacks
task Task management commands
telegrafs Telegraf configuration management commands
template Summarize and validate an InfluxDB template
transpile Manually transpile an InfluxQL query to Flux
user User management commands
write Write points to InfluxDB

Mapped environment variables

Some influx CLI flags are mapped to environment variables. Mapped flags get the value of the environment variable. To override environment variables, set the flag explicitly in your command.

Flags

Flag Description
-h --help Help for the influx command