From 0b8094b55dd922d14a0656e240d866d3acd6a509 Mon Sep 17 00:00:00 2001 From: heimanba <371510756@qq.com> Date: Sat, 18 Jul 2026 18:57:23 +0800 Subject: [PATCH] docs: clarify validate provider behavior Change-Id: I3191f74b3289234db0aae9bbe7d92ca4a4d708df --- docs/reference/cli.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/reference/cli.md b/docs/reference/cli.md index a8e0671..f449fba 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -6,13 +6,13 @@ The `agents` command. This page documents every command and option defined in `p | Option | Description | |--------|-------------| -| `-f, --config ` | Path to the config file. Defaults to `agents.yaml`. | +| `-f, --file ` | Path to the config file. Defaults to `agents.yaml`. | | `-v, --verbose` | Increase logging verbosity. Repeat: `-vv`. | | `-q, --quiet` | Suppress non-error output. | | `--no-color` | Disable colored output. | | `-V, --version` | Print the CLI version. | -Most commands accept `--config ` and `--provider ` to target a single provider. Run `agents --help` for the definitive list. +Provider-backed commands such as `plan`, `apply`, `models`, `session`, and `deployment` accept `--provider ` to target a single provider. `validate` is an offline whole-file check and does not accept a provider filter. Run `agents --help` for the definitive option list. ## `agents init` @@ -30,7 +30,7 @@ Launch the local web UI (fetches `@openagentpack/playground` on demand) and open ## `agents validate` -Validate the configuration file offline — checks YAML shape and field validity without making API calls. +Validate the whole configuration file offline — checks YAML shape and field validity without making API calls. This command does not accept `--provider`; use `plan --provider --refresh false` when you want to inspect one provider's projected changes without contacting remote APIs. ## `agents plan`