---
title: influxdb3 CLI
description: The influxdb3 CLI runs and interacts with the InfluxDB 3 Enterprise server.
url: https://docs.influxdata.com/influxdb3/enterprise/reference/cli/influxdb3/
estimated_tokens: 1508
product: InfluxDB 3 Enterprise
version: enterprise
publisher: InfluxData
canonical: https://docs.influxdata.com/influxdb3/enterprise/reference/cli/influxdb3/
date: '2026-07-08T14:40:21+00:00'
lastmod: '2026-07-08T14:40:21+00:00'
---

The `influxdb3` CLI runs and interacts with the InfluxDB 3 Enterprise server.

## Usage

```bash
influxdb3 [GLOBAL-OPTIONS] [COMMAND]
```

## Commands

|                             Command                             |            Description             |
|-----------------------------------------------------------------|------------------------------------|
| [create](/influxdb3/enterprise/reference/cli/influxdb3/create/) |          Create resources          |
|  [debug](/influxdb3/enterprise/reference/cli/influxdb3/debug/)  |          Diagnostic tools          |
| [delete](/influxdb3/enterprise/reference/cli/influxdb3/delete/) |          Delete resources          |
|[disable](/influxdb3/enterprise/reference/cli/influxdb3/disable/)|         Disable resources          |
| [enable](/influxdb3/enterprise/reference/cli/influxdb3/enable/) |          Enable resources          |
| [import](/influxdb3/enterprise/reference/cli/influxdb3/import/) |    Manage bulk Parquet imports     |
|[install](/influxdb3/enterprise/reference/cli/influxdb3/install/)|          Install plugins           |
|  [query](/influxdb3/enterprise/reference/cli/influxdb3/query/)  |    Query InfluxDB 3 Enterprise     |
|  [serve](/influxdb3/enterprise/reference/cli/influxdb3/serve/)  |Run the InfluxDB 3 Enterprise server|
|   [show](/influxdb3/enterprise/reference/cli/influxdb3/show/)   |           List resources           |
|   [stop](/influxdb3/enterprise/reference/cli/influxdb3/stop/)   |       Mark nodes as stopped        |
|   [test](/influxdb3/enterprise/reference/cli/influxdb3/test/)   |            Test plugins            |
| [update](/influxdb3/enterprise/reference/cli/influxdb3/update/) |          Update resources          |
|  [write](/influxdb3/enterprise/reference/cli/influxdb3/write/)  |   Write to InfluxDB 3 Enterprise   |

## Global options

|Option|            |                              Description                              |
|------|------------|-----------------------------------------------------------------------|
| `-h` |  `--help`  |                        Print help information                         |
|      |`--help-all`|Print detailed help information including runtime configuration options|
| `-V` |`--version` |                             Print version                             |

For advanced global configuration options (including `--num-io-threads` and other runtime settings), see [Configuration options](/influxdb3/enterprise/reference/config-options/#global-configuration-options).

## Quick-Start Mode

For development, testing, and home use, you can start InfluxDB 3 Enterprise by running `influxdb3` without the `serve` subcommand or any configuration parameters. The system automatically generates required values:

* **`node-id`**: `{hostname}-node` (fallback: `primary-node`)
* **`cluster-id`**: `{hostname}-cluster` (fallback: `primary-cluster`)
* **`object-store`**: `file`
* **`data-dir`**: `~/.influxdb`

The system displays warning messages showing the auto-generated identifiers:

```
Using auto-generated node id: mylaptop-node. For production deployments, explicitly set --node-id
Using auto-generated cluster id: mylaptop-cluster. For production deployments, explicitly set --cluster-id
```

#### Production deployments

Quick-start mode is designed for development and testing environments.
For production deployments, use explicit configuration with the `serve` subcommand
and specify all required parameters as shown in the [Examples](#examples) below.

**Configuration precedence**: CLI flags \> environment variables \> auto-generated defaults

For more information about quick-start mode, see [Get started](/influxdb3/enterprise/get-started/setup/#quick-start-mode-development).

## Examples

In the examples below, replace the following:

* `my-host-01`:
  a unique identifier for your InfluxDB 3 Enterprise server.
* `my-cluster-01`:
  a unique identifier for your InfluxDB 3 Enterprise cluster.
  The value you use must be different from `--node-id` values in the cluster.

### Quick-start influxdb3 server

```bash
# Zero-config startup
influxdb3

# Override specific defaults
influxdb3 --object-store memory

# Use environment variables to override defaults
INFLUXDB3_NODE_IDENTIFIER_PREFIX=my-node influxdb3
```

### Run the InfluxDB 3 server

```bash
influxdb3 serve \
  --object-store file \
  --data-dir ~/.influxdb3 \
  --node-id my-host-01 \
  --cluster-id my-cluster-01
```

### Run the InfluxDB 3 server with custom IO threads

```bash
influxdb3 --num-io-threads=8 serve \
  --object-store file \
  --data-dir ~/.influxdb3 \
  --node-id my-host-01 \
  --cluster-id my-cluster-01
```

### Display short-form help for all commands

```bash
influxdb3 -h
```

### Display long-form help for all commands

```bash
influxdb3 --help
```

### Run the InfluxDB 3 Enterprise server with extra verbose logging

```bash
influxdb3 serve \
  --object-store file \
  --data-dir ~/.influxdb3 \
  --node-id my-host-01 \
  --cluster-id my-cluster-01 \
  --verbose
```

### Run InfluxDB 3 Enterprise with debug logging using LOG\_FILTER

```bash
LOG_FILTER=debug influxdb3 serve \
  --object-store file \
  --data-dir ~/.influxdb3 \
  --node-id my-host-01 \
  --cluster-id my-cluster-01
```
| Command | Description |
| --- | --- |
| Command | Description |
| create | Create resources |
| debug | Diagnostic tools |
| delete | Delete resources |
| disable | Disable resources |
| enable | Enable resources |
| import | Manage bulk Parquet imports |
| install | Install plugins |
| query | Query InfluxDB 3 Enterprise |
| serve | Run the InfluxDB 3 Enterprise server |
| show | List resources |
| stop | Mark nodes as stopped |
| test | Test plugins |
| update | Update resources |
| write | Write to InfluxDB 3 Enterprise |

| Option |  | Description |
| --- | --- | --- |
| Option |  | Description |
| -h | --help | Print help information |
|  | --help-all | Print detailed help information including runtime configuration options |
| -V | --version | Print version |
