Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

udpated influx cli docs with mapped environment variables, resolves #656

pull/778/head
Scott Anderson 2020-02-24 11:15:18 -07:00
parent fd329659fe
commit 3c55d46923
59 changed files with 250 additions and 227 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
assets/styles/layouts/_article.scss
View File

@ -121,11 +121,21 @@
//////////////////////////////// Miscellaneous /////////////////////////////// //////////////////////////////// Miscellaneous ///////////////////////////////
.required { .required, .req {
color:#FF8564; color:#FF8564;
font-weight:700; font-weight:700;
font-style: italic; font-style: italic;
} }
a.q-link {
font-size: .8rem;
vertical-align: super;
line-height: 0;
color: $g20-white;
opacity: .5;
transition: opacity .2s;
&:hover {opacity: 1;}
}
} }
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////

8
content/v2.0/reference/cli/influx/_index.md
View File

@ -62,9 +62,15 @@ retrieving authentication tokens._
| [user](/v2.0/reference/cli/influx/user) | User management commands | | [user](/v2.0/reference/cli/influx/user) | User management commands |
| [write](/v2.0/reference/cli/influx/write) | Write points to InfluxDB | | [write](/v2.0/reference/cli/influx/write) | Write points to InfluxDB |
{{% influx-cli-global-flags %}} ## Mapped environment variables
Some `influx` CLI flags are mapped to environment variables.
If those environment variables are set, the flag automatically assumes the value
of the environment variable.
If the flag is included, the specified value overrides the mapped environment variable.
## Flags ## Flags
| Flag | Description | | Flag | Description |
|:---------------|:------------------------------| |:---------------|:------------------------------|
| `-h`, `--help` | Help for the `influx` command | | `-h`, `--help` | Help for the `influx` command |
{{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/auth/_index.md
View File

@ -34,4 +34,4 @@ influx auth [command]
|:---- |:----------- | |:---- |:----------- |
| `-h`, `--help` | Help for the `auth` command | | `-h`, `--help` | Help for the `auth` command |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/auth/active.md
View File

@ -21,4 +21,4 @@ influx auth active [flags]
| `-h`, `--help` | Help for the `active` command | | | `-h`, `--help` | Help for the `active` command | |
| `-i`, `--id` | The authorization ID **(Required)** | string | | `-i`, `--id` | The authorization ID **(Required)** | string |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

41
content/v2.0/reference/cli/influx/auth/create.md
View File

@ -16,24 +16,25 @@ influx auth create [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------: | |:---- |:----------- |:----------: |:------------------ |
| `-h`, `--help` | Help for the `create` command | | | `-h`, `--help` | Help for the `create` command | | |
| `-o`, `--org` | The organization name **(Required)** | string | | `-o`, `--org` | The organization name **(Required)** | string | `INFLUX_ORG` |
| `--read-bucket` | The bucket ID | stringArray | | `--org-id` | The organization ID | string | `INFLUX_ORG_ID` |
| `--read-buckets` | Grants the permission to perform read actions against organization buckets | | | `--read-bucket` | The bucket ID | stringArray | |
| `--read-dashboards` | Grants the permission to read dashboards | | | `--read-buckets` | Grants the permission to perform read actions against organization buckets | | |
| `--read-orgs` | Grants the permission to read organizations | | | `--read-dashboards` | Grants the permission to read dashboards | | |
| `--read-tasks` | Grants the permission to read tasks | | | `--read-orgs` | Grants the permission to read organizations | | |
| `--read-telegrafs` | Grants the permission to read telegraf configs | | | `--read-tasks` | Grants the permission to read tasks | | |
| `--read-user` | Grants the permission to perform read actions against organization users | | | `--read-telegrafs` | Grants the permission to read telegraf configs | | |
| `-u`, `--user` | The user name | string | | `--read-user` | Grants the permission to perform read actions against organization users | | |
| `--write-bucket` | The bucket ID | stringArray | | `-u`, `--user` | The user name | string | |
| `--write-buckets` | Grants the permission to perform mutative actions against organization buckets | | | `--write-bucket` | The bucket ID | stringArray | |
| `--write-dashboards` | Grants the permission to create dashboards | | | `--write-buckets` | Grants the permission to perform mutative actions against organization buckets | | |
| `--write-orgs` | Grants the permission to create organizations | | | `--write-dashboards` | Grants the permission to create dashboards | | |
| `--write-tasks` | Grants the permission to create tasks | | | `--write-orgs` | Grants the permission to create organizations | | |
| `--write-telegrafs` | Grants the permission to create telegraf configs | | | `--write-tasks` | Grants the permission to create tasks | | |
| `--write-user` | Grants the permission to perform mutative actions against organization users | | | `--write-telegrafs` | Grants the permission to create telegraf configs | | |
| `--write-user` | Grants the permission to perform mutative actions against organization users | | |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/auth/delete.md
View File

@ -21,4 +21,4 @@ influx auth delete [flags]
| `-h`, `--help` | Help for the `delete` command | | | `-h`, `--help` | Help for the `delete` command | |
| `-i`, `--id` | The authorization ID **(Required)** | string | | `-i`, `--id` | The authorization ID **(Required)** | string |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/auth/find.md
View File

@ -25,4 +25,4 @@ influx auth find [flags]
| `-u`, `--user` | The user | string | | `-u`, `--user` | The user | string |
| `--user-id` | The user ID | string | | `--user-id` | The user ID | string |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/auth/inactive.md
View File

@ -21,4 +21,4 @@ influx auth inactive [flags]
| `-h`, `--help` | Help for the `inactive` command | | | `-h`, `--help` | Help for the `inactive` command | |
| `-i`, `--id` | The authorization ID **(Required)** | string | | `-i`, `--id` | The authorization ID **(Required)** | string |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

10
content/v2.0/reference/cli/influx/backup/_index.md
View File

@ -19,9 +19,9 @@ influx backup [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------:| |:---- |:----------- |:----------:|:------------------ |
| `-h`, `--help` | Help for the `backup` command | | | `-h`, `--help` | Help for the `backup` command | | |
| `-p`, `--path` | Directory path to write backup files to | string | | `-p`, `--path` | Directory path to write backup files to | string | `INFLUX_PATH` |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/bucket/_index.md
View File

@ -30,4 +30,4 @@ influx bucket [command]
|:---- |:----------- | |:---- |:----------- |
| `-h`, `--help` | Help for the `bucket` command | | `-h`, `--help` | Help for the `bucket` command |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

16
content/v2.0/reference/cli/influx/bucket/create.md
View File

@ -16,12 +16,12 @@ influx bucket create [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------: | |:---- |:----------- |:----------: |:------------------ |
| `-h`, `--help` | Help for the `create` command | | | `-h`, `--help` | Help for the `create` command | | |
| `-n`, `--name` | Name of bucket that will be created | string | | `-n`, `--name` | Name of bucket that will be created | string | `INFLUX_BUCKET_NAME` |
| `-o`, `--org` | The name of the organization that owns the bucket | string | | `-o`, `--org` | The name of the organization that owns the bucket | string | `INFLUX_ORG` |
| `--org-id` | The ID of the organization that owns the bucket | string | | `--org-id` | The ID of the organization that owns the bucket | string | `INFLUX_ORG_ID` |
| `-r`, `--retention` | Duration in nanoseconds data will live in bucket | duration | | `-r`, `--retention` | Duration in nanoseconds data will live in bucket | duration | |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/bucket/delete.md
View File

@ -21,4 +21,4 @@ influx bucket delete [flags]
| `-h`, `--help` | Help for the `delete` command | | | `-h`, `--help` | Help for the `delete` command | |
| `-i`, `--id` | The bucket ID **(Required)** | string | | `-i`, `--id` | The bucket ID **(Required)** | string |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

16
content/v2.0/reference/cli/influx/bucket/find.md
View File

@ -16,12 +16,12 @@ influx bucket find [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------: | |:---- |:----------- |:----------: |:------------------ |
| `-h`, `--help` | Help for the `find` command | | | `-h`, `--help` | Help for the `find` command | | |
| `-i`, `--id` | The bucket ID | string | | `-i`, `--id` | The bucket ID | string | |
| `-n`, `--name` | The bucket name | string | | `-n`, `--name` | The bucket name | string | `INFLUX_BUCKET_NAME` |
| `-o`, `--org` | The bucket organization name | string | | `-o`, `--org` | The bucket organization name | string | `INFLUX_ORG` |
| `--org-id` | The bucket organization ID | string | | `--org-id` | The bucket organization ID | string | `INFLUX_ORG_ID` |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

14
content/v2.0/reference/cli/influx/bucket/update.md
View File

@ -16,11 +16,11 @@ influx bucket update [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------: | |:---- |:----------- |:----------: |:------------------ |
| `-h`, `--help` | Help for the `update` command | | | `-h`, `--help` | Help for the `update` command | | |
| `-i`, `--id` | The bucket ID **(Required)** | string | | `-i`, `--id` | The bucket ID **(Required)** | string | |
| `-n`, `--name` | New bucket name | string | | `-n`, `--name` | New bucket name | string | `INFLUX_BUCKET_NAME` |
| `-r`, `--retention` | New duration data will live in bucket | duration | | `-r`, `--retention` | New duration data will live in bucket | duration | |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

22
content/v2.0/reference/cli/influx/delete/_index.md
View File

@ -23,15 +23,15 @@ timestamps between the specified `--start` and `--stop` times in the specified b
{{% /warn %}} {{% /warn %}}
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------:| |:---- |:----------- |:----------:|:------------------ |
| `-b`, `--bucket` | The name of bucket to remove data from | string | | `-b`, `--bucket` | The name of bucket to remove data from | string | `INFLUX_BUCKET_NAME` |
| `--bucket-id` | The ID of the bucket to remove data from | string | | `--bucket-id` | The ID of the bucket to remove data from | string | `INFLUX_BUCKET_ID` |
| `-h`, `--help` | Help for the `delete` command | | | `-h`, `--help` | Help for the `delete` command | | |
| `-o`, `--org` | The name of the organization that owns the bucket | string | | `-o`, `--org` | The name of the organization that owns the bucket | string | `INFLUX_ORG` |
| `--org-id` | The ID of the organization that owns the bucket | string | | `--org-id` | The ID of the organization that owns the bucket | string | `INFLUX_ORG_ID` |
| `-p`, `--predicate` | InfluxQL-like predicate string (see [Delete predicate](/v2.0/reference/syntax/delete-predicate)) | string | | `-p`, `--predicate` | InfluxQL-like predicate string (see [Delete predicate](/v2.0/reference/syntax/delete-predicate)) | string | |
| `--start` | The start time in RFC3339 format (i.e. `2009-01-02T23:00:00Z`) | string | | `--start` | The start time in RFC3339 format (i.e. `2009-01-02T23:00:00Z`) | string | |
| `--stop` | The stop time in RFC3339 format (i.e. `2009-01-02T23:00:00Z`) | string | | `--stop` | The stop time in RFC3339 format (i.e. `2009-01-02T23:00:00Z`) | string | |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/help/_index.md
View File

@ -20,4 +20,4 @@ influx help [command] [flags]
|:---- |:----------- | |:---- |:----------- |
| `-h`, `--help` | Help for help | | `-h`, `--help` | Help for help |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/org/_index.md
View File

@ -34,4 +34,4 @@ influx org [command]
|:---- |:----------- | |:---- |:----------- |
| `-h`, `--help` | Help for the `org` command | | `-h`, `--help` | Help for the `org` command |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/org/create.md
View File

@ -22,4 +22,4 @@ influx org create [flags]
| `-h`, `--help` | Help for `create` | | | `-h`, `--help` | Help for `create` | |
| `-n`, `--name` | Name of organization | string | | `-n`, `--name` | Name of organization | string |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

10
content/v2.0/reference/cli/influx/org/delete.md
View File

@ -16,9 +16,9 @@ influx org delete [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------: | |:---- |:----------- |:----------: |:------------------ |
| `-h`, `--help` | Help for `delete` | | | `-h`, `--help` | Help for `delete` | | |
| `-i`, `--id` | **(Required)** Organization ID | string | | `-i`, `--id` | **(Required)** Organization ID | string | `INFLUX_ORG_ID` |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

12
content/v2.0/reference/cli/influx/org/find.md
View File

@ -16,10 +16,10 @@ influx org find [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------: | |:---- |:----------- |:----------: |:------------------ |
| `-h`, `--help` | Help for `find` | | | `-h`, `--help` | Help for `find` | | |
| `-i`, `--id` | Organization ID | string | | `-i`, `--id` | Organization ID | string | `INFLUX_ORG` |
| `-n`, `--name` | Organization name | string | | `-n`, `--name` | Organization name | string | `INFLUX_ORG_ID` |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/org/members/_index.md
View File

@ -29,4 +29,4 @@ influx org members [command]
|:---- |:----------- | |:---- |:----------- |
| `-h`, `--help` | Help for `members` | | `-h`, `--help` | Help for `members` |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

14
content/v2.0/reference/cli/influx/org/members/add.md
View File

@ -16,11 +16,11 @@ influx org members add [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------: | |:---- |:----------- |:----------: |:------------------ |
| `-h`, `--help` | Help for `add` | | | `-h`, `--help` | Help for `add` | | |
| `-i`, `--id` | The organization ID | string | | `-i`, `--id` | The organization ID | string | `INFLUX_ORG_ID` |
| `-o`, `--member` | The member ID | string | | `-o`, `--member` | The member ID | string | |
| `-n`, `--name` | The organization name | string | | `-n`, `--name` | The organization name | string | `INFLUX_ORG` |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

12
content/v2.0/reference/cli/influx/org/members/list.md
View File

@ -16,10 +16,10 @@ influx org members list [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------: | |:---- |:----------- |:----------: |:------------------ |
| `-h`, `--help` | Help for `list` | | | `-h`, `--help` | Help for `list` | | |
| `-i`, `--id` | The organization ID | string | | `-i`, `--id` | The organization ID | string | `INFLUX_ORG_ID` |
| `-n`, `--name` | The organization name | string | | `-n`, `--name` | The organization name | string | `INFLUX_ORG` |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

14
content/v2.0/reference/cli/influx/org/members/remove.md
View File

@ -16,11 +16,11 @@ influx org members remove [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------: | |:---- |:----------- |:----------: |:------------------ |
| `-h`, `--help` | Help for `remove` | | | `-h`, `--help` | Help for `remove` | | |
| `-i`, `--id` | The organization ID | string | | `-i`, `--id` | The organization ID | string | `INFLUX_ORG_ID` |
| `-o`, `--member` | The member ID | string | | `-o`, `--member` | The member ID | string | |
| `-n`, `--name` | The organization name | string | | `-n`, `--name` | The organization name | string | `INFLUX_ORG` |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

14
content/v2.0/reference/cli/influx/org/update.md
View File

@ -16,11 +16,11 @@ influx org update [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------:| |:---- |:----------- |:----------:|:------------------ |
| `-d`, `--description` | Description for the organization | string | | `-d`, `--description` | Description for the organization | string | `INFLUX_ORG_DESCRIPTION` |
| `-h`, `--help` | Help for `update` | | | `-h`, `--help` | Help for `update` | | |
| `-i`, `--id` | **(Required)** Organization ID | string | | `-i`, `--id` | **(Required)** Organization ID | string | `INFLUX_ORG_ID` |
| `-n`, `--name` | Organization name | string | | `-n`, `--name` | Organization name | string | `INFLUX_ORG` |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/ping/_index.md
View File

@ -25,4 +25,4 @@ influx ping [flags]
|:---- |:----------- | |:---- |:----------- |
| `-h`, `--help` | Help for the `ping` command | | `-h`, `--help` | Help for the `ping` command |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

32
content/v2.0/reference/cli/influx/pkg/_index.md
View File

@ -26,20 +26,20 @@ influx pkg [command]
## Flags ## Flags
| Flag | Description | Input Type | | Flag | Description | Input Type | {{< cli/mapped >}} |
|:---- |:----------------------------- |:---------- | |:---- |:----------------------------- |:---------- |:------------------ |
| `-c`, `--disable-color` | Disable color in output | | | `-c`, `--disable-color` | Disable color in output | | |
| `--disable-table-borders` | Disable table borders | | | `--disable-table-borders` | Disable table borders | | |
| `-e`, `--encoding` | Encoding of the input stream | string | | `-e`, `--encoding` | Encoding of the input stream | string | |
| `--env-ref` | Environment references to provide alongside the package (format: `--env-ref=REF_KEY=REF_VALUE`) | string | | `--env-ref` | Environment references to provide alongside the package (format: `--env-ref=REF_KEY=REF_VALUE`) | string | |
| `-f`, `--file` | Path to package file | string | | `-f`, `--file` | Path to package file | string | |
| `--force` | Ignore warnings about destructive changes | | | `--force` | Ignore warnings about destructive changes | | |
| `-h`, `--help` | Help for the `pkg` command | | | `-h`, `--help` | Help for the `pkg` command | | |
| `-o`, `--org` | The name of the organization that owns the bucket | string | | `-o`, `--org` | The name of the organization that owns the bucket | string | `INFLUX_ORG` |
| `--org-id` | The ID of the organization that owns the bucket | string | | `--org-id` | The ID of the organization that owns the bucket | string | `INFLUX_ORG_ID` |
| `-q`, `--quiet` | Disable output printing | | | `-q`, `--quiet` | Disable output printing | | |
| `-R`, `--recurse` | Recurse through files in the directory specified in `-f`, `--file` | | | `-R`, `--recurse` | Recurse through files in the directory specified in `-f`, `--file` | | |
| `--secret` | Secrets to provide alongside the package (format: `--secret=SECRET_KEY=SECRET_VALUE`) | string | | `--secret` | Secrets to provide alongside the package (format: `--secret=SECRET_KEY=SECRET_VALUE`) | string | |
| `-u`, `--url` | URL of package file | string | | `-u`, `--url` | URL of package file | string | |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/pkg/export/_index.md
View File

@ -37,4 +37,4 @@ influx pkg export [command]
| `--telegraf-configs` | Comma-separated list of Telegraf configuration IDs | string | | `--telegraf-configs` | Comma-separated list of Telegraf configuration IDs | string |
| `--variables` | Comma-separated list of variable IDs | string | | `--variables` | Comma-separated list of variable IDs | string |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

15
content/v2.0/reference/cli/influx/pkg/export/all.md
View File

@ -17,12 +17,11 @@ influx pkg export all [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input Type | {{< cli/mapped >}} |
|:---- |:----------- |:---------- |:------------------ |
| `-f`, `--file` | Package output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string | |
| `-h`, `--help` | Help for the `export` command | | |
| `-o`, `--org` | The name of the organization that owns the resources | string | `INFLUX_ORG` |
| `--org-id` | The ID of the organization that owns the resources | string | `INFLUX_ORG_ID` |
| Flag | Description | Input Type | {{% cli/influx-global-flags %}}
|:---- |:----------- |:---------- |
| `-f`, `--file` | Package output file. Defaults to stdout. Use `.yml` or `.json` file extensions. | string |
| `-h`, `--help` | Help for the `export` command | |
| `-o`, `--org` | The name of the organization that owns the resources | string |
| `--org-id` | The ID of the organization that owns the resources | string |
{{% influx-cli-global-flags %}}

2
content/v2.0/reference/cli/influx/pkg/summary.md
View File

@ -28,4 +28,4 @@ influx pkg summary [flags]
| `-u`, `--url` | URL of package file to summarize | string | | `-u`, `--url` | URL of package file to summarize | string |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/pkg/validate.md
View File

@ -25,4 +25,4 @@ influx pkg validate [flags]
| `-R`, `--recurse` | Recurse through files in the directory specified in `-f`, `--file` | | | `-R`, `--recurse` | Recurse through files in the directory specified in `-f`, `--file` | |
| `-u`, `--url` | URL of package file to validate | string | | `-u`, `--url` | URL of package file to validate | string |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

11
content/v2.0/reference/cli/influx/query/_index.md
View File

@ -20,9 +20,10 @@ influx query [query literal or @/path/to/query.flux] [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------:| |:---- |:----------- |:----------:|:------------------ |
| `-h`, `--help` | Help for the query command | | | `-h`, `--help` | Help for the query command | | |
| `--org-id` | The organization ID | string | | `-o`, `--org` | The organization name | string | `INFLUX_ORG` |
| `--org-id` | The organization ID | string | `INFLUX_ORG_ID` |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

12
content/v2.0/reference/cli/influx/repl/_index.md
View File

@ -26,10 +26,10 @@ Use **ctrl + d** to exit the REPL.
To use the Flux REPL, you must first authenticate with a [token](/v2.0/security/tokens/view-tokens/). To use the Flux REPL, you must first authenticate with a [token](/v2.0/security/tokens/view-tokens/).
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------:| |:---- |:----------- |:----------:|:------------------ |
| `-h`, `--help` | Help for the `repl` command | | | `-h`, `--help` | Help for the `repl` command | | |
| `-o`, `--org` | The name of the organization | string | | `-o`, `--org` | The name of the organization | string | `INFLUX_ORG` |
| `--org-id` | The ID of organization to query | string | | `--org-id` | The ID of organization to query | string | `INFLUX_ORG_ID` |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/secret/_index.md
View File

@ -29,4 +29,4 @@ influx secret [subcommand]
|:---- |:----------- | |:---- |:----------- |
| `-h`, `--help` | Help for the `secret` command | | `-h`, `--help` | Help for the `secret` command |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

14
content/v2.0/reference/cli/influx/secret/delete.md
View File

@ -17,11 +17,11 @@ influx secret delete [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------:| |:---- |:----------- |:----------:|:------------------ |
| `-h`, `--help` | Help for `secret delete` | | | `-h`, `--help` | Help for `secret delete` | | |
| `-k`, `--key` | Secret key _**(required)**_ | string | | `-k`, `--key` | Secret key _**(required)**_ | string | |
| `-o`, `--org` | Organization name | string | | `-o`, `--org` | Organization name | string | `INFLUX_ORG` |
| `--org-id` | Organization ID | string | | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

12
content/v2.0/reference/cli/influx/secret/find.md
View File

@ -17,10 +17,10 @@ influx secret find [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------:| |:---- |:----------- |:----------:|:------------------ |
| `-h`, `--help` | Help for `secret find` | | | `-h`, `--help` | Help for `secret find` | | |
| `-o`, `--org` | Organization name | string | | `-o`, `--org` | Organization name | string | `INFLUX_ORG` |
| `--org-id` | Organization ID | string | | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

14
content/v2.0/reference/cli/influx/secret/update.md
View File

@ -19,11 +19,11 @@ influx secret update [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------:| |:---- |:----------- |:----------:|:------------------ |
| `-h`, `--help` | Help for `secret update` | | | `-h`, `--help` | Help for `secret update` | | |
| `-k`, `--key` | Secret key _**(required)**_ | string | | `-k`, `--key` | Secret key _**(required)**_ | string | |
| `-o`, `--org` | Organization name | string | | `-o`, `--org` | Organization name | string | `INFLUX_ORG` |
| `--org-id` | Organization ID | string | | `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/setup/_index.md
View File

@ -24,4 +24,4 @@ influx setup [flags]
|:---- |:----------- | |:---- |:----------- |
| `-h`, `--help` | Help for the `setup` command | | `-h`, `--help` | Help for the `setup` command |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/task/_index.md
View File

@ -33,4 +33,4 @@ influx task [command]
|:---- |:----------- | |:---- |:----------- |
| `-h`, `--help` | Help for the `task` command | | `-h`, `--help` | Help for the `task` command |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

12
content/v2.0/reference/cli/influx/task/create.md
View File

@ -16,10 +16,10 @@ influx task create [query literal or @/path/to/query.flux] [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------: | |:---- |:----------- |:----------: |:------------------ |
| `-h`, `--help` | Help for `create` | | | `-h`, `--help` | Help for `create` | | |
| `--org` | Organization name | string | | `--org` | Organization name | string | `INFLUX_ORG` |
| `--org-id` | ID of the organization that owns the task | string | | `--org-id` | ID of the organization that owns the task | string | `INFLUX_ORG_ID` |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/task/delete.md
View File

@ -21,4 +21,4 @@ influx task delete [flags]
| `-h`, `--help` | Help for `delete` | | | `-h`, `--help` | Help for `delete` | |
| `-i`, `--id` | Task id **(Required)** | string | | `-i`, `--id` | Task id **(Required)** | string |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

18
content/v2.0/reference/cli/influx/task/find.md
View File

@ -16,13 +16,13 @@ influx task find [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------: | |:---- |:----------- |:----------: |:------------------ |
| `-h`, `--help` | Help for `find` | | | `-h`, `--help` | Help for `find` | | |
| `-i`, `--id` | Task ID | string | | `-i`, `--id` | Task ID | string | |
| `--limit` | The number of tasks to find (default `100`) | integer | | `--limit` | The number of tasks to find (default `100`) | integer | |
| `--org` | Task organization name | string | | `--org` | Task organization name | string | `INFLUX_ORG` |
| `--org-id` | Task organization ID | string | | `--org-id` | Task organization ID | string | `INFLUX_ORG_ID` |
| `-n`, `--user-id` | Task owner ID | string | | `-n`, `--user-id` | Task owner ID | string | |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/task/log/_index.md
View File

@ -27,4 +27,4 @@ influx task log [command]
|:---- |:----------- | |:---- |:----------- |
| `-h`, `--help` | Help for `log` | | `-h`, `--help` | Help for `log` |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

3
content/v2.0/reference/cli/influx/task/log/find.md
View File

@ -19,8 +19,7 @@ influx task log find [flags]
| Flag | Description | Input type | | Flag | Description | Input type |
|:---- |:----------- |:----------: | |:---- |:----------- |:----------: |
| `-h`, `--help` | Help for `find` | | | `-h`, `--help` | Help for `find` | |
| `--org-id` | Organization ID | string |
| `--run-id` | Run ID | string | | `--run-id` | Run ID | string |
| `--task-id` | Task ID **(Required)** | string | | `--task-id` | Task ID **(Required)** | string |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/task/retry.md
View File

@ -22,4 +22,4 @@ influx task retry [flags]
| `-r`, `--run-id` | Run id **(Required)** | string | | `-r`, `--run-id` | Run id **(Required)** | string |
| `-i`, `--task-id` | Task id **(Required)** | string | | `-i`, `--task-id` | Task id **(Required)** | string |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/task/run/_index.md
View File

@ -28,4 +28,4 @@ influx task run [command]
|:---- |:----------- | |:---- |:----------- |
| `-h`, `--help` | Help for `run` | | `-h`, `--help` | Help for `run` |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

3
content/v2.0/reference/cli/influx/task/run/find.md
View File

@ -22,8 +22,7 @@ influx task run find [flags]
| `--before` | Before-time for filtering | string | | `--before` | Before-time for filtering | string |
| `-h`,`--help` | Help for `find` | | | `-h`,`--help` | Help for `find` | |
| `--limit` | Limit the number of results | integer | | `--limit` | Limit the number of results | integer |
| `--org-id` | Organization ID | string |
| `--run-id` | Run ID | string | | `--run-id` | Run ID | string |
| `--task-id` | Task ID **(Required)** | string | | `--task-id` | Task ID **(Required)** | string |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/task/update.md
View File

@ -22,4 +22,4 @@ influx task update [flags]
| `-i`, `--id` | Task ID **(Required)** | string | | `-i`, `--id` | Task ID **(Required)** | string |
| `--status` | Update task status | string | | `--status` | Update task status | string |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/transpile/_index.md
View File

@ -25,4 +25,4 @@ influx transpile [InfluxQL query] [flags]
| `-h`, `--help` | Help for the `transpile` command | | `-h`, `--help` | Help for the `transpile` command |
| `--now` | RFC3339Nano timestamp to use as `now()` time (default is current UTC time) | | `--now` | RFC3339Nano timestamp to use as `now()` time (default is current UTC time) |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/user/_index.md
View File

@ -31,4 +31,4 @@ influx user [command]
|:---- |:----------- | |:---- |:----------- |
| `-h`, `--help` | Help for the `user` command | | `-h`, `--help` | Help for the `user` command |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

16
content/v2.0/reference/cli/influx/user/create.md
View File

@ -16,12 +16,12 @@ influx user create [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------: | |:---- |:----------- |:----------: |:------------------ |
| `-h`, `--help` | Help for `create` | | | `-h`, `--help` | Help for `create` | | |
| `-n`, `--name` | The username **(Required)** | string | | `-n`, `--name` | The username **(Required)** | string | `INFLUX_NAME` |
| `-o`, `--org` | The name of the organization to add the user to | string | | `-o`, `--org` | The name of the organization to add the user to | string | `INFLUX_ORG` |
| `--org-id` | The ID of the organization to add the user to | string | | `--org-id` | The ID of the organization to add the user to | string | `INFLUX_ORG_ID` |
| `-p`, `--password` | The user password | string | | `-p`, `--password` | The user password | string | |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/user/delete.md
View File

@ -21,4 +21,4 @@ influx user delete [flags]
| `-h`, `--help` | Help for `delete` | | | `-h`, `--help` | Help for `delete` | |
| `-i`, `--id` | The user ID **(Required)** | string | | `-i`, `--id` | The user ID **(Required)** | string |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/user/find.md
View File

@ -22,4 +22,4 @@ influx user find [flags]
| `-i`, `--id` | The user ID | string | | `-i`, `--id` | The user ID | string |
| `-n`, `--name` | The username | string | | `-n`, `--name` | The username | string |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/user/password.md
View File

@ -24,4 +24,4 @@ influx user password [flags]
| `-i`, `--id` | The user ID | string | | `-i`, `--id` | The user ID | string |
| `-n`, `--name` | The username | string | | `-n`, `--name` | The username | string |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

2
content/v2.0/reference/cli/influx/user/update.md
View File

@ -23,4 +23,4 @@ influx user update [flags]
| `-i`, `--id` | The user ID **(Required)** | string | | `-i`, `--id` | The user ID **(Required)** | string |
| `-n`, `--name` | The username | string | | `-n`, `--name` | The username | string |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

18
content/v2.0/reference/cli/influx/write/_index.md
View File

@ -20,13 +20,13 @@ influx write [line protocol or @/path/to/points.txt] [flags]
``` ```
## Flags ## Flags
| Flag | Description | Input type | | Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------:| |:---- |:----------- |:----------:|:------------------ |
| `-b`, `--bucket` | The name of destination bucket | string | | `-b`, `--bucket` | The name of destination bucket | string | `INFLUX_BUCKET_NAME` |
| `--bucket-id` | The ID of destination bucket | string | | `--bucket-id` | The ID of destination bucket | string | `INFLUX_BUCKET_ID` |
| `-h`, `--help` | Help for the write command | | | `-h`, `--help` | Help for the write command | | |
| `-o`, `--org` | The name of the organization that owns the bucket | string | | `-o`, `--org` | The name of the organization that owns the bucket | string | `INFLUX_ORG` |
| `--org-id` | The ID of the organization that owns the bucket | string | | `--org-id` | The ID of the organization that owns the bucket | string | `INFLUX_ORG_ID` |
| `-p`, `--precision` | Precision of the timestamps of the lines (default `ns`) | string | | `-p`, `--precision` | Precision of the timestamps of the lines (default `ns`) | string | `INFLUX_PRECISION` |
{{% influx-cli-global-flags %}} {{% cli/influx-global-flags %}}

11
layouts/shortcodes/cli/influx-global-flags.md Normal file
View File

@ -0,0 +1,11 @@
{{ $currentVersion := (index (findRE "[^/]+.*?" .Page.RelPermalink) 0) }}
{{ $link := print "/" $currentVersion "/reference/cli/influx/#mapped-environment-variables"}}
## Global Flags
| Flag | Description | Input type | Maps to <a class ="q-link" href ="{{ $link }}">?</a> |
|:----------------|:--------------------------------------------------------------------------------------------|:----------:|:---------------------------------------------------- |
| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string | `INFLUX_HOST` |
| `--local` | Run commands against the local filesystem | | |
| `--skip-verify` | Skip certificate verification (use when connecting over TLS with a self-signed certificate) | | |
| `-t`, `--token` | API token to use in client calls | string | `INFLUX_TOKEN` |

5
layouts/shortcodes/cli/mapped.html Normal file
View File

@ -0,0 +1,5 @@
{{ $currentVersion := (index (findRE "[^/]+.*?" .Page.RelPermalink) 0) }}
{{ $cli := replaceRE "/cli/" "" (index (findRE "/cli/[a-z]*" .Page.RelPermalink) 0) }}
{{ $link := print "/" $currentVersion "/reference/cli/" $cli "/#mapped-environment-variables"}}
Maps to <a class="q-link" href="{{ $link }}">?</a>

8
layouts/shortcodes/influx-cli-global-flags.md
View File

@ -1,8 +0,0 @@
## Global Flags
| Flag | Description | Input type |
|:----------------|:--------------------------------------------------------------------------------------------|:----------:|
| `--host` | HTTP address of InfluxDB (default `http://localhost:9999`) | string |
| `--local` | Run commands against the local filesystem | |
| `--skip-verify` | Skip certificate verification (use when connecting over TLS with a self-signed certificate) | |
| `-t`, `--token` | API token to use in client calls | string |