Skip to content

Commit 5939eab

Browse files
committed
Clarify workflow input file reference docs
1 parent 365b2a4 commit 5939eab

2 files changed

Lines changed: 6 additions & 3 deletions

File tree

docs/reference/workflows.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ specify workflow run <source>
1010

1111
| Option | Description |
1212
| ------------------- | ------------------------------------------------------------------------------------------------ |
13-
| `-i` / `--input` | Pass workflow inputs/parameters as `key=value` (repeatable); use `key=@path` to read text files |
13+
| `-i` / `--input` | Pass workflow inputs/parameters as `key=value` (repeatable); `key=@path` reads an existing text file, otherwise `@` values stay literal |
1414
| `--input-file` | Load workflow inputs/parameters from a JSON object file; repeatable `--input` values override file values |
1515

16-
Runs a workflow from an installed workflow ID or a local `.yml`/`.yaml` file path. Inputs/parameters declared by the workflow can be provided via `--input` or will be prompted interactively.
16+
Runs a workflow from an installed workflow ID or a local `.yml`/`.yaml` file path. Inputs/parameters declared by the workflow can be provided via `--input` or `--input-file`, or will be prompted interactively.
1717

1818
Example:
1919

src/specify_cli/__init__.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5085,7 +5085,10 @@ def workflow_run(
50855085
None,
50865086
"--input",
50875087
"-i",
5088-
help="Input values as key=value pairs; use key=@path to read a text file",
5088+
help=(
5089+
"Input values as key=value pairs; key=@path reads an existing text "
5090+
"file, otherwise @ values stay literal"
5091+
),
50895092
),
50905093
input_file: str | None = typer.Option(
50915094
None, "--input-file", help="Load input values from a JSON object file"

0 commit comments

Comments
 (0)