aleleba/photocraft
1
0
Fork 0
mirror of https://github.com/storytold/photocraft.git synced 2026-10-24 01:47:08 -06:00
Code Issues Packages Projects Releases Wiki Activity

Docs: launch-option wording for missing values and --help

Browse Source 
Name missing values alongside empty ones, and say `--help`/`-h` are the
options that take no value (CodeRabbit review on #8035).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Khawar Zamman Wani
2026-10-21 01:32:14 +05:30
co-authored by Claude Opus 5.5
parent 9af7b2416f
commit ec9b6b7ee5
3 changed files with 12 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
book/src/automation/cli.md
+4 -4
View File
@@ -65,7 +65,7 @@ Paths supplied to the current CLI are ordinary operating-system paths. The CLI d
CLI parsing reports malformed flags and JSON as errors, and a flag the subcommand doesn't take (a typo such as `--fromat`) is a usage error (exit status 2) rather than being ignored. It is not a security policy layer. Engine commands remain responsible for validating their own parameters.
`mcp` and `serve` reject positional arguments, repeated options, empty values and options for
the wrong mode before starting a server. Explicit control-token flags require `mcp --bridge`
or `serve --port`. Configure automation roots on the desktop process when using bridge mode;
the CLI rejects root flags there. See the [MCP launch guide](mcp.md) for examples.
`mcp` and `serve` reject positional arguments, repeated options, missing or empty values and
options for the wrong mode before starting a server. Explicit control-token flags require
`mcp --bridge` or `serve --port`. Configure automation roots on the desktop process when using
bridge mode; the CLI rejects root flags there. See the [MCP launch guide](mcp.md) for examples.
book/src/automation/mcp.md
+3 -2
View File
@@ -25,8 +25,9 @@ client's launch directory. In bridge mode the roots are configured on the deskto
flags on `photocraft-cli mcp --bridge` are rejected. Explicit `--control-token` and
`--control-token-file` flags require `--bridge` and are mutually exclusive; bridge credentials can
also come from `PHOTOCRAFT_CONTROL_TOKEN` or `PHOTOCRAFT_CONTROL_TOKEN_FILE`. Each launch option
takes one non-empty value and cannot be repeated. Stray positional arguments, missing values and
options for the wrong mode are usage errors (exit 2) reported on stderr before the server starts.
except `--help`/`-h` takes one non-empty value and cannot be repeated. Stray positional arguments,
missing values and options for the wrong mode are usage errors (exit 2) reported on stderr before
the server starts.
Tools cover session/document operations, command discovery and execution, batching, and—when bridged—UI inspection and control. Tool schemas improve correctness but are not authorization boundaries.
docs/mcp.md
+5 -4
View File
@@ -63,10 +63,11 @@ flags on `photocraft-cli mcp --bridge` are rejected. Explicit `--control-token`
`--control-token-file` flags require `--bridge` and are mutually exclusive. Bridge credentials
can also come from `PHOTOCRAFT_CONTROL_TOKEN` or `PHOTOCRAFT_CONTROL_TOKEN_FILE`.
MCP and `serve` launch options take one non-empty value each and cannot be repeated. Missing
values, stray positional arguments and options for the wrong mode are usage errors (exit 2),
reported on stderr before the server starts; stdout stays available for protocol messages.
For `serve`, explicit credential flags require `--port`; stdio needs no control token.
MCP and `serve` launch options (all but `--help`/`-h`) take one non-empty value each and cannot
be repeated. Missing values, stray positional arguments and options for the wrong mode are
usage errors (exit 2), reported on stderr before the server starts; stdout stays available for
protocol messages. For `serve`, explicit credential flags require `--port`; stdio needs no
control token.
## Tools and resources