added influx cli command docs
Scott Anderson
parent
1a2dbc0e64
commit
1cd30efb1d
|
|
@ -139,15 +139,18 @@
|
||||||
code,pre {
|
code,pre {
|
||||||
background: $article-code-bg;
|
background: $article-code-bg;
|
||||||
font-family: 'Inconsolata', monospace;
|
font-family: 'Inconsolata', monospace;
|
||||||
|
color: $article-code;
|
||||||
}
|
}
|
||||||
|
|
||||||
p code {
|
p, li, table{
|
||||||
|
code {
|
||||||
padding: .15rem .45rem .25rem;
|
padding: .15rem .45rem .25rem;
|
||||||
border-radius: $border-radius;
|
border-radius: $border-radius;
|
||||||
color: $article-code;
|
color: $article-code;
|
||||||
white-space: nowrap;
|
white-space: nowrap;
|
||||||
font-style: normal;
|
font-style: normal;
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
a {
|
a {
|
||||||
code {
|
code {
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,40 @@
|
||||||
|
---
|
||||||
|
title: influx CLI
|
||||||
|
seotitle: "'influx' command line client"
|
||||||
|
description: placeholder
|
||||||
|
menu:
|
||||||
|
v2_0_ref:
|
||||||
|
name: influx
|
||||||
|
parent: Command line tools
|
||||||
|
wieght: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
The `influx` command line interface (CLI).
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
```
|
||||||
|
influx [flags]
|
||||||
|
influx [command]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
| Command | Description |
|
||||||
|
|:------- |:----------- |
|
||||||
|
| [auth](/v2.0/reference/cli/influx/auth) | Authorization management commands |
|
||||||
|
| [bucket](/v2.0/reference/cli/influx/bucket) | Bucket management commands |
|
||||||
|
| [help](/v2.0/reference/cli/influx/help) | Help about any command |
|
||||||
|
| [org](/v2.0/reference/cli/influx/org) | Organization management commands |
|
||||||
|
| [query](/v2.0/reference/cli/influx/query) | Execute a Flux query |
|
||||||
|
| [repl](/v2.0/reference/cli/influx/repl) | Interactive REPL (read-eval-print-loop) |
|
||||||
|
| [setup](/v2.0/reference/cli/influx/setup) | Create default username, password, org, bucket... |
|
||||||
|
| [task](/v2.0/reference/cli/influx/task) | Task management commands |
|
||||||
|
| [user](/v2.0/reference/cli/influx/user) | User management commands |
|
||||||
|
| [write](/v2.0/reference/cli/influx/write) | Write points to InfluxDB |
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
| Flag | Description | Input type |
|
||||||
|
|:---- |:----------- |:----------:|
|
||||||
|
| `-h`, `--help` | Help for the influx command | |
|
||||||
|
| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string |
|
||||||
|
| `--local` | Run commands locally against the filesystem | |
|
||||||
|
| `-t`, `--token` | API token to be used throughout client calls | string |
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
---
|
||||||
|
title: Influx authorization management commands
|
||||||
|
description: placeholder
|
||||||
|
menu:
|
||||||
|
v2_0_ref:
|
||||||
|
name: influx auth
|
||||||
|
parent: influx
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
Authorization management commands
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
```
|
||||||
|
influx auth [flags]
|
||||||
|
influx auth [command]
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Aliases
|
||||||
|
`auth`, `authorization`
|
||||||
|
|
||||||
|
## Subcommands
|
||||||
|
| Subcommand | Description |
|
||||||
|
|:---------- |:----------- |
|
||||||
|
| active | Active authorization |
|
||||||
|
| create | Create authorization |
|
||||||
|
| delete | Delete authorization |
|
||||||
|
| find | Find authorization |
|
||||||
|
| inactive | Inactive authorization |
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
| Flag | Description |
|
||||||
|
|:---- |:----------- |
|
||||||
|
| `-h`, `--help` | Help for the auth command |
|
||||||
|
|
||||||
|
## Global Flags
|
||||||
|
| Global flag | Description | Input type |
|
||||||
|
|:----------- |:----------- |:----------:|
|
||||||
|
| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string |
|
||||||
|
| `--local` | Run commands locally against the filesystem | |
|
||||||
|
| `-t`, `--token` | API token to be used throughout client calls | string |
|
||||||
|
|
@ -0,0 +1,37 @@
|
||||||
|
---
|
||||||
|
title: Influx bucket management commands
|
||||||
|
description: placeholder
|
||||||
|
menu:
|
||||||
|
v2_0_ref:
|
||||||
|
name: influx bucket
|
||||||
|
parent: influx
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
Bucket management commands
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
```
|
||||||
|
influx bucket [flags]
|
||||||
|
influx bucket [command]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Subcommands
|
||||||
|
| Subcommand | Description |
|
||||||
|
|:---------- |:----------- |
|
||||||
|
| create | Create bucket |
|
||||||
|
| delete | Delete bucket |
|
||||||
|
| find | Find buckets |
|
||||||
|
| update | Update bucket |
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
| Flag | Description |
|
||||||
|
|:---- |:----------- |
|
||||||
|
| `-h`, `--help` | Help for the bucket command |
|
||||||
|
|
||||||
|
## Global Flags
|
||||||
|
| Global flag | Description | Input type |
|
||||||
|
|:----------- |:----------- |:----------:|
|
||||||
|
| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string |
|
||||||
|
| `--local` | Run commands locally against the filesystem | |
|
||||||
|
| `-t`, `--token` | API token to be used throughout client calls | string |
|
||||||
|
|
@ -0,0 +1,29 @@
|
||||||
|
---
|
||||||
|
title: Influx help command
|
||||||
|
description: placeholder
|
||||||
|
menu:
|
||||||
|
v2_0_ref:
|
||||||
|
name: influx help
|
||||||
|
parent: influx
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
Help provides help for any command in the application.
|
||||||
|
Simply type influx help [path to command] for full details.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
```
|
||||||
|
influx help [command] [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
| Flag | Description |
|
||||||
|
|:---- |:----------- |
|
||||||
|
| `-h`, `--help` | help for help |
|
||||||
|
|
||||||
|
## Global Flags
|
||||||
|
| Global flag | Description | Input type |
|
||||||
|
|:----------- |:----------- |:----------:|
|
||||||
|
| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string |
|
||||||
|
| `--local` | Run commands locally against the filesystem | |
|
||||||
|
| `-t`, `--token` | API token to be used throughout client calls | string |
|
||||||
|
|
@ -0,0 +1,41 @@
|
||||||
|
---
|
||||||
|
title: Influx organization management commands
|
||||||
|
description: placeholder
|
||||||
|
menu:
|
||||||
|
v2_0_ref:
|
||||||
|
name: influx org
|
||||||
|
parent: influx
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
Organization management commands
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
```
|
||||||
|
influx org [flags]
|
||||||
|
influx org [command]
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Aliases
|
||||||
|
`org`, `organization`
|
||||||
|
|
||||||
|
## Subcommands
|
||||||
|
| Subcommand | Description |
|
||||||
|
|:---------- |:----------- |
|
||||||
|
| create | Create organization |
|
||||||
|
| delete | Delete organization |
|
||||||
|
| find | Find organizations |
|
||||||
|
| members | Organization membership commands |
|
||||||
|
| update | Update organization |
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
| Flag | Description |
|
||||||
|
|:---- |:----------- |
|
||||||
|
| `-h`, `--help` | Help for the org command |
|
||||||
|
|
||||||
|
## Global Flags
|
||||||
|
| Global flag | Description | Input type |
|
||||||
|
|:----------- |:----------- |:----------:|
|
||||||
|
| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string |
|
||||||
|
| `--local` | Run commands locally against the filesystem | |
|
||||||
|
| `-t`, `--token` | API token to be used throughout client calls | string |
|
||||||
|
|
@ -0,0 +1,30 @@
|
||||||
|
---
|
||||||
|
title: Influx query command
|
||||||
|
description: placeholder
|
||||||
|
menu:
|
||||||
|
v2_0_ref:
|
||||||
|
name: influx query
|
||||||
|
parent: influx
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
Execute a literal Flux query provided as a string,
|
||||||
|
or execute a literal Flux query contained in a file by specifying the file prefixed with an @ sign.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
```
|
||||||
|
influx query [query literal or @/path/to/query.flux] [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
| Flag | Description | Input type |
|
||||||
|
|:---- |:----------- |:----------:|
|
||||||
|
| `-h`, `--help` | Help for the query command | |
|
||||||
|
| `--org-id` | The organization ID | string |
|
||||||
|
|
||||||
|
## Global Flags
|
||||||
|
| Global flag | Description | Input type |
|
||||||
|
|:----------- |:----------- |:----------:|
|
||||||
|
| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string |
|
||||||
|
| `--local` | Run commands locally against the filesystem | |
|
||||||
|
| `-t`, `--token` | API token to be used throughout client calls | string |
|
||||||
|
|
@ -0,0 +1,30 @@
|
||||||
|
---
|
||||||
|
title: Influx repl command
|
||||||
|
description: placeholder
|
||||||
|
menu:
|
||||||
|
v2_0_ref:
|
||||||
|
name: influx repl
|
||||||
|
parent: influx
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
Interactive REPL (read-eval-print-loop)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
```
|
||||||
|
influx repl [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
| Flag | Description | Input type |
|
||||||
|
|:---- |:----------- |:----------:|
|
||||||
|
| `-h`, `--help` | Help for the repl command | |
|
||||||
|
| `-o`, `--org` | The name of the organization | string |
|
||||||
|
| `--org-id` | The ID of organization to query | string |
|
||||||
|
|
||||||
|
## Global Flags
|
||||||
|
| Global flag | Description | Input type |
|
||||||
|
|:----------- |:----------- |:----------:|
|
||||||
|
| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string |
|
||||||
|
| `--local` | Run commands locally against the filesystem | |
|
||||||
|
| `-t`, `--token` | API token to be used throughout client calls | string |
|
||||||
|
|
@ -0,0 +1,28 @@
|
||||||
|
---
|
||||||
|
title: Influx setup command
|
||||||
|
description: placeholder
|
||||||
|
menu:
|
||||||
|
v2_0_ref:
|
||||||
|
name: influx setup
|
||||||
|
parent: influx
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
Create default username, password, org, bucket...
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
```
|
||||||
|
influx setup [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
| Flag | Description |
|
||||||
|
|:---- |:----------- |
|
||||||
|
| `-h`, `--help` | Help for the `setup` command |
|
||||||
|
|
||||||
|
## Global Flags
|
||||||
|
| Global flag | Description | Input type |
|
||||||
|
|:----------- |:----------- |:----------:|
|
||||||
|
| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string |
|
||||||
|
| `--local` | Run commands locally against the filesystem | |
|
||||||
|
| `-t`, `--token` | API token to be used throughout client calls | string |
|
||||||
|
|
@ -0,0 +1,40 @@
|
||||||
|
---
|
||||||
|
title: Influx task management commands
|
||||||
|
description: placeholder
|
||||||
|
menu:
|
||||||
|
v2_0_ref:
|
||||||
|
name: influx task
|
||||||
|
parent: influx
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
Task management commands
|
||||||
|
|
||||||
|
### Usage
|
||||||
|
```
|
||||||
|
influx task [flags]
|
||||||
|
influx task [command]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Subcommands
|
||||||
|
| Subcommand | Description |
|
||||||
|
|:---------- |:----------- |
|
||||||
|
| create | Create task |
|
||||||
|
| delete | Delete task |
|
||||||
|
| find | Find tasks |
|
||||||
|
| log | Log related commands |
|
||||||
|
| retry | retry a run |
|
||||||
|
| run | Run related commands |
|
||||||
|
| update | Update task |
|
||||||
|
|
||||||
|
### Flags
|
||||||
|
| Flag | Description |
|
||||||
|
|:---- |:----------- |
|
||||||
|
| `-h`, `--help` | Help for the `task` command |
|
||||||
|
|
||||||
|
### Global Flags
|
||||||
|
| Global flag | Description | Input type |
|
||||||
|
|:----------- |:----------- |:----------:|
|
||||||
|
| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string |
|
||||||
|
| `--local` | Run commands locally against the filesystem | |
|
||||||
|
| `-t`, `--token` | API token to be used throughout client calls | string |
|
||||||
|
|
@ -0,0 +1,37 @@
|
||||||
|
---
|
||||||
|
title: Influx user management commands
|
||||||
|
description: placeholder
|
||||||
|
menu:
|
||||||
|
v2_0_ref:
|
||||||
|
name: influx user
|
||||||
|
parent: influx
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
User management commands
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
```
|
||||||
|
influx user [flags]
|
||||||
|
influx user [command]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Subcommands
|
||||||
|
| Subcommand | Description |
|
||||||
|
|:---------- |:----------- |
|
||||||
|
| create | Create user |
|
||||||
|
| delete | Delete user |
|
||||||
|
| find | Find user |
|
||||||
|
| update | Update user |
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
| Flag | Description |
|
||||||
|
|:---- |:----------- |
|
||||||
|
| `-h`, `--help` | Help for the `user` command |
|
||||||
|
|
||||||
|
## Global Flags
|
||||||
|
| Global flag | Description | Input type |
|
||||||
|
|:----------- |:----------- |:----------:|
|
||||||
|
| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string |
|
||||||
|
| `--local` | Run commands locally against the filesystem | |
|
||||||
|
| `-t`, `--token` | API token to be used throughout client calls | string |
|
||||||
|
|
@ -0,0 +1,34 @@
|
||||||
|
---
|
||||||
|
title: Influx write command
|
||||||
|
description: placeholder
|
||||||
|
menu:
|
||||||
|
v2_0_ref:
|
||||||
|
name: influx write
|
||||||
|
parent: influx
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
Write a single line of line protocol to InfluxDB,
|
||||||
|
or add an entire file specified with an @ prefix.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
```
|
||||||
|
influx write [line protocol or @/path/to/points.txt] [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Flags
|
||||||
|
| Flag | Description | Input type |
|
||||||
|
|:---- |:----------- |:----------:|
|
||||||
|
| `-b`, `--bucket` | The name of destination bucket | string |
|
||||||
|
| `--bucket-id` | The ID of destination bucket | string |
|
||||||
|
| `-h`, `--help` | Help for the write command | |
|
||||||
|
| `-o`, `--org` | The name of the organization that owns the bucket | string |
|
||||||
|
| `--org-id` | The ID of the organization that owns the bucket | string |
|
||||||
|
| `-p`, `--precision` | Precision of the timestamps of the lines (default `ns`) | string |
|
||||||
|
|
||||||
|
## Global Flags
|
||||||
|
| Global flag | Description | Input type |
|
||||||
|
|:----------- |:----------- |:----------:|
|
||||||
|
| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string |
|
||||||
|
| `--local` | Run commands locally against the filesystem | |
|
||||||
|
| `-t`, `--token` | API token to be used throughout client calls | string |
|
||||||
Loading…
Reference in New Issue