Remove @ from examples

pull/936/head
noramullen1 2020-04-09 12:36:08 -07:00
parent d89422b6d8
commit 6723b58a79
6 changed files with 13 additions and 10 deletions

View File

@ -92,10 +92,10 @@ It accepts either a file path or raw Flux.
###### Create a task using a file
```sh
# Syntax
influx task create --org <org-name> @</path/to/task-script>
influx task create --org -f </path/to/task-script>
# Example
influx task create --org my-org @/tasks/cq-mean-1h.flux
influx task create --org my-org -f /tasks/cq-mean-1h.flux
```
###### Create a task using raw Flux

View File

@ -48,10 +48,10 @@ script are also updated.
```sh
# Syntax
influx task update -i <task-id> @/path/to/updated-task-script
influx task update -i <task-id> -f </path/to/updated-task-script>
# Example
influx task update -i 0343698431c35000 @/tasks/cq-mean-1h.flux
influx task update -i 0343698431c35000 -f /tasks/cq-mean-1h.flux
```
#### Update the status of a task

View File

@ -41,7 +41,7 @@ as either a file or raw Flux via stdin.
###### Run a query from a file
```bash
influx query @/path/to/query.flux
influx query --file /path/to/query.flux
```
###### Pass raw Flux via stdin pipe

View File

@ -16,15 +16,16 @@ or a literal Flux query contained in a file by specifying the file prefixed with
## Usage
```
influx query [query literal or @/path/to/query.flux] [flags]
influx query [query literal] [flags]
```
## Flags
| Flag | Description | Input type | {{< cli/mapped >}} |
|----------------|------------------------------|:----------:|--------------------|
| `-f`, `--file` | Path to Flux script file | string | |
| `-h`, `--help` | Help for the `query` command | | |
| `-o`, `--org` | Organization name | string | `INFLUX_ORG` |
| `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| `-f`, `--file` | Path to Flux script file | string | |
{{% cli/influx-global-flags %}}

View File

@ -12,17 +12,18 @@ The `influx task create` command creates a new task in InfluxDB.
## Usage
```
influx task create [query literal or @/path/to/query.flux] [flags]
influx task create [query literal] [flags]
```
## Flags
| Flag | Description | Input type | {{< cli/mapped >}} |
|------------------|---------------------------------------|:----------:|-----------------------|
| `-f`, `--file` | Path to Flux script file | string | |
| `-h`, `--help` | Help for the `create` command | | |
| `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `--org` | Organization name | string | `INFLUX_ORG` |
| `--org-id` | Organization ID | string | `INFLUX_ORG_ID` |
| `-f`, `--file` | Path to Flux script file | string | |
{{% cli/influx-global-flags %}}

View File

@ -18,11 +18,12 @@ influx task update [flags]
## Flags
| Flag | Description | Input type | {{< cli/mapped >}} |
|:---- |:----------- |:----------: |:------------------ |
| `-f`, `--file` | Path to Flux script file | string | |
| `-h`, `--help` | Help for the `update` command | | |
| `--hide-headers` | Hide table headers (default `false`) | | `INFLUX_HIDE_HEADERS` |
| `-i`, `--id` | **(Required)** Task ID | string | |
| `--json` | Output data as JSON (default `false`) | | `INFLUX_OUTPUT_JSON` |
| `--status` | Update task status | string | |
| `-f`, `--file` | Path to Flux script file | string | |
{{% cli/influx-global-flags %}}