influx CLI release notes

This page documents an earlier version of InfluxDB. InfluxDB v2.7 is the latest stable version. View this page in the v2.7 documentation.

v2.3 [2022-04-08]

Features

  • Add influx remote command.
  • Add influx replication command.
  • Enhanced error messaging for InfluxDB and OSS specific commands.
  • Add api/v2/config endpoint to display the runtime configuration (for example, when you run influxd print-config). This endpoint lets you review runtime configuration while the instance is live.

Bug fixes

  • Auth create command supports multiple buckets.
  • Use influx-debug-id header for tracing.
  • Duration parser shows duration missing units on error.
  • Template apply uses improved diff checking.
  • Fix error applying -e jsonnet template.

v2.3.1 [2021-11-09]

This release includes two new bug fixes.

Bug fixes

  • Improve error messages for unknown subcommands (Error: command “…” not recognized.) by describing how to run ./influx --help to see a list of valid commands. Thanks @slai!

  • Ensure org members remove API calls successfully remove a member from an organization by fixing accidental swap of orgID and userID. Thanks @geek981108!

v2.3.0 [2021-10-21]

This release includes three new features and bug fixes.

Features

This release makes it easier to create API tokens with the influx CLI, adds support for viewing more than 20 buckets using influx bucket list, and adds a shorthand flag for bucket (-b) to influx delete.

Create an Operator token in the influx CLI

Add the ability to use the influx CLI to create an Operator token with read and write permissions to all resources in all organizations available in InfluxDB. (Note, this is the same permissions generated for the initial token created by influx setup or influxd upgrade.)

Create an All-Access token in the influx CLI

Add the ability to use the influx CLI to create an All-Access API token with read and write permissions to all resources in an organization.

View more buckets in the influx CLI

Update influx bucket list with pagination to support displaying more than 20 buckets. By default, buckets are fetched in batches of 20; set --page-size to override this default value. You may also limit the total number of buckets to display with --limit (by default, there’s no limit).

New bucket shorthand for influx delete

Add the shorthand flag -b for --bucket to influx delete.

Bug fixes

  • Detect and warn when the Operator token is changed using influx restore (either setting a new --active config or updating the INFLUX_TOKEN variable).
  • Set newly-created connection configuration as active in influx setup.
  • Embed timezone data into Windows builds to avoid errors.

v2.1.1 [2021-09-24]

Go version

Upgrade to Go 1.17.

Bug fixes

  • Fix shell completion for top-level influx commands.
  • Make global --http-debug flag visible in help text.
  • Don’t set empty strings for IDs in permission resources.
  • Detect and error out on incorrect positional arguments.
  • Respect value of --host flag when writing CLI configs in setup.

v2.1.0 [2021-07-29]

New repository

This is the initial release of the influx CLI from the influxdata/influx-cli GitHub repository.

Breaking changes

influx write skip-header parsing

To simplify the CLI parser, the write command no longer supports --skipHeader as short-hand for --skipHeader 1.

Stricter input validation for influx template commands

The apply, export, and stacks commands now raise errors when CLI options fail to parse instead of silently discarding bad inputs. This change was made to help users debug when their commands fail to execute as expected.

Server-side template summarization and validation

The template and template validate commands now use an API request to the server to perform their logic, instead of performing the work on the client-side. Offline summarization and validation is no longer supported. This change was made to avoid significant code duplication between influxdb and influx CLI, and to allow server-side template logic to evolve without requiring coordinated CLI changes.

influx stacks --json output conventions

The output of influx stacks --json previously used an UpperCamelCase naming convention for most keys. The command now uses lowerCamelCase consistently for all objects keys, matching the schema returned by the API.

Features

  • Add global --http-debug flag to all influx commands to help inspect communication with InfluxDB servers.
  • Update bucket create to allow setting a schema type.
  • Update bucket list to display schema types.
  • Bind --skip-verify flag to the INFLUX_SKIP_VERIFY environment variable.
  • (InfluxDB Cloud only) Add [`buck
  • (InfluxDB OSS only) Updates to backup and restore:
    • Reimplement backup to support downloading embedded SQL store from InfluxDB 2.0 or later.
    • Add --compression flag to support GZIP compression of downloaded files.
    • Reimplement restore to support uploading embedded SQL store from InfluxDB v2.1.x.
  • (InfluxDB OSS only) Add --password flag to user password command to allow bypassing interactive prompt.

Bug fixes

  • Fix interactive password collection and color rendering in PowerShell.
  • org members list no longer hangs on organizations with more than 10 members.
  • Detect and warn when inputs to write contain standalone CR characters.
  • dashboards command now accepts --org flag, or falls back to default org in config.
  • Return a consistent error when responses fail to decode, including hints for OSS-only and Cloud-only commands.