freemo/cleveragents-core
0
0
Fork 0
forked from cleveragents/cleveragents-core
Code Pull Requests Activity

docs(spec): remove optional parentheses from required --config flags in command synopsis (#1573)

Browse Source 
Co-authored-by: Jeffrey Phillips Freeman <the@jeffreyfreeman.me>
Co-committed-by: Jeffrey Phillips Freeman <the@jeffreyfreeman.me>
This commit is contained in:
Jeffrey Phillips Freeman
2026-04-02 22:00:58 +00:00
committed by Forgejo
parent 36e6a4a520
commit 48cdcb6ea7
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/specification.md
+15 -15
View File
@@ -266,7 +266,7 @@ The following standards are integrated into the architecture:
[<span style="color: cyan;">--strategy</span> <span style="color: #66cc66;">&lt;STRATEGY&gt;</span>]...
<span style="color: #66cc66;">&lt;PROJECT&gt;</span>
<span style="color: cyan; font-weight: 600;">agents</span> validation add (<span style="color: magenta;"><span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span></span>) <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]
<span style="color: cyan; font-weight: 600;">agents</span> validation add <span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span> <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]
<span style="color: cyan; font-weight: 600;">agents</span> validation attach [<span style="color: cyan;">--project</span> <span style="color: #66cc66;">&lt;PROJECT&gt;</span>|<span style="color: cyan;">--plan</span> <span style="color: #66cc66;">&lt;PLAN_ID&gt;</span>]
<span style="color: #66cc66;">&lt;RESOURCE&gt;</span> <span style="color: #66cc66;">&lt;VALIDATION&gt;</span> [<span style="color: #66cc66;">&lt;ARGS&gt;</span>...]
<span style="color: cyan; font-weight: 600;">agents</span> validation detach [<span style="color: cyan;">--yes</span>|<span style="color: yellow;">-y</span>] <span style="color: #66cc66;">&lt;ATTACHMENT_ID&gt;</span>
@@ -276,7 +276,7 @@ The following standards are integrated into the architecture:
[<span style="color: cyan;">--context-dir</span> <span style="color: #66cc66;">&lt;CONTEXT_PATH&gt;</span>] [<span style="color: cyan;">--load-context</span> <span style="color: #66cc66;">&lt;LOAD_CONTEXT_NAME&gt;</span>]
[(<span style="color: magenta;"><span style="color: cyan;">--temperature</span>|<span style="color: yellow;">-t</span></span>) <span style="color: #66cc66;">&lt;TEMP&gt;</span>] [<span style="color: cyan;">--allow-rxpy-in-run-mode</span>]
[<span style="color: cyan;">--skill</span> <span style="color: #66cc66;">&lt;SKILL&gt;</span>]... <span style="color: #66cc66;">&lt;NAME&gt;</span> <span style="color: #66cc66;">&lt;PROMPT&gt;</span>
<span style="color: cyan; font-weight: 600;">agents</span> actor add (<span style="color: magenta;"><span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span></span>) <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]
<span style="color: cyan; font-weight: 600;">agents</span> actor add <span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span> <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]
<span style="color: cyan; font-weight: 600;">agents</span> actor remove <span style="color: #66cc66;">&lt;NAME&gt;</span>
<span style="color: cyan; font-weight: 600;">agents</span> actor list
<span style="color: cyan; font-weight: 600;">agents</span> actor show <span style="color: #66cc66;">&lt;NAME&gt;</span>
@@ -287,24 +287,24 @@ The following standards are integrated into the architecture:
<span style="color: cyan; font-weight: 600;">agents</span> actor context import [<span style="color: cyan;">--update</span>] (<span style="color: magenta;"><span style="color: cyan;">--input</span>|<span style="color: yellow;">-i</span></span>) <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: #66cc66;">&lt;NAME&gt;</span>]
<span style="color: cyan; font-weight: 600;">agents</span> actor context clear [<span style="color: cyan;">--yes</span>|<span style="color: yellow;">-y</span>] (<span style="color: magenta;"><span style="color: cyan;">--all</span>|<span style="color: yellow;">-a</span>|<span style="color: #66cc66;">&lt;NAME&gt;</span></span>)
<span style="color: cyan; font-weight: 600;">agents</span> skill add (<span style="color: magenta;"><span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span></span>) <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]
<span style="color: cyan; font-weight: 600;">agents</span> skill add <span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span> <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]
<span style="color: cyan; font-weight: 600;">agents</span> skill remove [<span style="color: cyan;">--yes</span>|<span style="color: yellow;">-y</span>] <span style="color: #66cc66;">&lt;NAME&gt;</span>
<span style="color: cyan; font-weight: 600;">agents</span> skill list [(<span style="color: magenta;"><span style="color: cyan;">--namespace</span>|<span style="color: yellow;">-n</span></span>) <span style="color: #66cc66;">&lt;NS&gt;</span>] [<span style="color: cyan;">--source</span> <span style="color: #66cc66;">&lt;SOURCE&gt;</span>]
<span style="color: cyan; font-weight: 600;">agents</span> skill show <span style="color: #66cc66;">&lt;NAME&gt;</span>
<span style="color: cyan; font-weight: 600;">agents</span> skill tools <span style="color: #66cc66;">&lt;NAME&gt;</span>
<span style="color: cyan; font-weight: 600;">agents</span> tool add (<span style="color: magenta;"><span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span></span>) <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]
<span style="color: cyan; font-weight: 600;">agents</span> tool add <span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span> <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]
<span style="color: cyan; font-weight: 600;">agents</span> tool remove [<span style="color: cyan;">--yes</span>|<span style="color: yellow;">-y</span>] <span style="color: #66cc66;">&lt;NAME&gt;</span>
<span style="color: cyan; font-weight: 600;">agents</span> tool list [(<span style="color: magenta;"><span style="color: cyan;">--namespace</span>|<span style="color: yellow;">-n</span></span>) <span style="color: #66cc66;">&lt;NS&gt;</span>] [<span style="color: cyan;">--source</span> <span style="color: #66cc66;">&lt;SOURCE&gt;</span>] [<span style="color: cyan;">--type</span> (<span style="color: magenta;">tool|validation</span>)] [<span style="color: #66cc66;">&lt;REGEX&gt;</span>]
<span style="color: cyan; font-weight: 600;">agents</span> tool show <span style="color: #66cc66;">&lt;NAME&gt;</span>
<span style="color: cyan; font-weight: 600;">agents</span> lsp add (<span style="color: magenta;"><span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span></span>) <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]
<span style="color: cyan; font-weight: 600;">agents</span> lsp add <span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span> <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]
<span style="color: cyan; font-weight: 600;">agents</span> lsp remove [<span style="color: cyan;">--yes</span>|<span style="color: yellow;">-y</span>] <span style="color: #66cc66;">&lt;NAME&gt;</span>
<span style="color: cyan; font-weight: 600;">agents</span> lsp list [(<span style="color: magenta;"><span style="color: cyan;">--namespace</span>|<span style="color: yellow;">-n</span></span>) <span style="color: #66cc66;">&lt;NS&gt;</span>] [<span style="color: cyan;">--language</span> <span style="color: #66cc66;">&lt;LANG&gt;</span>]
<span style="color: cyan; font-weight: 600;">agents</span> lsp show <span style="color: #66cc66;">&lt;NAME&gt;</span>
<span style="color: cyan; font-weight: 600;">agents</span> lsp serve [<span style="color: cyan;">--log-level</span> <span style="color: #66cc66;">&lt;LEVEL&gt;</span>]
<span style="color: cyan; font-weight: 600;">agents</span> resource type add (<span style="color: magenta;"><span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span></span>) <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]
<span style="color: cyan; font-weight: 600;">agents</span> resource type add <span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span> <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]
<span style="color: cyan; font-weight: 600;">agents</span> resource type remove [<span style="color: cyan;">--yes</span>|<span style="color: yellow;">-y</span>] <span style="color: #66cc66;">&lt;NAME&gt;</span>
<span style="color: cyan; font-weight: 600;">agents</span> resource type list [<span style="color: #66cc66;">&lt;REGEX&gt;</span>]
<span style="color: cyan; font-weight: 600;">agents</span> resource type show <span style="color: #66cc66;">&lt;NAME&gt;</span>
@@ -345,12 +345,12 @@ The following standards are integrated into the architecture:
<span style="color: cyan; font-weight: 600;">agents</span> plan prompt <span style="color: #66cc66;">&lt;PLAN_ID&gt;</span> <span style="color: #66cc66;">&lt;GUIDANCE&gt;</span>
<span style="color: cyan; font-weight: 600;">agents</span> plan rollback [<span style="color: cyan;">--yes</span>|<span style="color: yellow;">-y</span>] <span style="color: #66cc66;">&lt;PLAN_ID&gt;</span> <span style="color: #66cc66;">&lt;CHECKPOINT_ID&gt;</span>
<span style="color: cyan; font-weight: 600;">agents</span> action create (<span style="color: magenta;"><span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span></span>) <span style="color: #66cc66;">&lt;CFG_FILE&gt;</span>
<span style="color: cyan; font-weight: 600;">agents</span> action create <span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span> <span style="color: #66cc66;">&lt;CFG_FILE&gt;</span>
<span style="color: cyan; font-weight: 600;">agents</span> action list [(<span style="color: magenta;"><span style="color: cyan;">--namespace</span>|<span style="color: yellow;">-n</span></span>) <span style="color: #66cc66;">&lt;NS&gt;</span>] [(<span style="color: magenta;"><span style="color: cyan;">--state</span>|<span style="color: yellow;">-s</span></span>) <span style="color: #66cc66;">&lt;STATE&gt;</span>] [<span style="color: #66cc66;">&lt;REGEX&gt;</span>]
<span style="color: cyan; font-weight: 600;">agents</span> action show <span style="color: #66cc66;">&lt;ACTION_NAME&gt;</span>
<span style="color: cyan; font-weight: 600;">agents</span> action archive <span style="color: #66cc66;">&lt;ACTION_NAME&gt;</span>
<span style="color: cyan; font-weight: 600;">agents</span> automation-profile add (<span style="color: magenta;"><span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span></span>) <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]
<span style="color: cyan; font-weight: 600;">agents</span> automation-profile add <span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span> <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]
<span style="color: cyan; font-weight: 600;">agents</span> automation-profile remove [<span style="color: cyan;">--yes</span>|<span style="color: yellow;">-y</span>] <span style="color: #66cc66;">&lt;NAME&gt;</span>
<span style="color: cyan; font-weight: 600;">agents</span> automation-profile list [<span style="color: #66cc66;">&lt;REGEX&gt;</span>]
<span style="color: cyan; font-weight: 600;">agents</span> automation-profile show <span style="color: #66cc66;">&lt;NAME&gt;</span>
@@ -4936,7 +4936,7 @@ Saving actor output to a file:
##### agents actor add
<div class="highlight"><pre><code><span style="color: cyan; font-weight: 600;">agents</span> actor add (<span style="color: magenta;"><span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span></span>) <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]</code></pre></div>
<div class="highlight"><pre><code><span style="color: cyan; font-weight: 600;">agents</span> actor add <span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span> <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]</code></pre></div>
**Purpose**
Add a new actor configuration, or replace an existing one with `--update`. The actor is fully defined by the YAML configuration file specified with `--config`. If a local actor with the same name already exists, the command fails unless the `--update` flag is provided, which replaces the existing actor.
@@ -6359,7 +6359,7 @@ Clear all files from a context but keep the context itself.
##### agents skill add
<div class="highlight"><pre><code><span style="color: cyan; font-weight: 600;">agents</span> skill add (<span style="color: magenta;"><span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span></span>) <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]</code></pre></div>
<div class="highlight"><pre><code><span style="color: cyan; font-weight: 600;">agents</span> skill add <span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span> <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]</code></pre></div>
**Purpose**
Register a new skill. The skill is fully defined by the YAML configuration file specified with `--config`. If a skill with the same name already exists, the command fails unless the `--update` flag is provided, which allows overwriting the existing registration with the new configuration.
@@ -7544,7 +7544,7 @@ List all tools provided by a skill, including those inherited from included skil
##### agents tool add
<div class="highlight"><pre><code><span style="color: cyan; font-weight: 600;">agents</span> tool add (<span style="color: magenta;"><span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span></span>) <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]</code></pre></div>
<div class="highlight"><pre><code><span style="color: cyan; font-weight: 600;">agents</span> tool add <span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span> <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]</code></pre></div>
**Purpose**
Register a new tool. The tool is fully defined by the YAML configuration file specified with `--config`. If a tool with the same name already exists, the command fails unless the `--update` flag is provided, which allows overwriting the existing registration with the new configuration.
@@ -9279,7 +9279,7 @@ When multiple attachment scopes apply, the union of all applicable validations i
##### agents validation add
<div class="highlight"><pre><code><span style="color: cyan; font-weight: 600;">agents</span> validation add (<span style="color: magenta;"><span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span></span>) <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--required</span> | <span style="color: cyan;">--informational</span>] [<span style="color: cyan;">--update</span>]</code></pre></div>
<div class="highlight"><pre><code><span style="color: cyan; font-weight: 600;">agents</span> validation add <span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span> <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--required</span> | <span style="color: cyan;">--informational</span>] [<span style="color: cyan;">--update</span>]</code></pre></div>
**Purpose**
Register a new validation. The validation is fully defined by the YAML configuration file specified with `--config`. The validation is registered in the shared Tool Registry under the name specified in the config file; the name must not conflict with any existing tool or validation. If a validation with the same name already exists, the command fails unless `--update` is provided. The validation YAML may use `wraps` to reference an existing Tool, reusing its implementation and interpreting its output through a `transform` function (see Tool Wrapping under Core Concepts > Validation). When `wraps` is used, the wrapped Tool must already be registered.
@@ -9879,7 +9879,7 @@ Manage resource type definitions. Resource types are schema-level definitions th
##### agents resource type add
<div class="highlight"><pre><code><span style="color: cyan; font-weight: 600;">agents</span> resource type add (<span style="color: magenta;"><span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span></span>) <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]</code></pre></div>
<div class="highlight"><pre><code><span style="color: cyan; font-weight: 600;">agents</span> resource type add <span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span> <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]</code></pre></div>
**Purpose**
Register a new custom resource type. The resource type is fully defined by the YAML configuration file specified with `--config`.
@@ -16128,7 +16128,7 @@ Provide additional guidance to a plan, typically when it is errored or awaiting
##### agents action create
<div class="highlight"><pre><code><span style="color: cyan; font-weight: 600;">agents</span> action create (<span style="color: magenta;"><span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span></span>) <span style="color: #66cc66;">&lt;CFG_FILE&gt;</span></code></pre></div>
<div class="highlight"><pre><code><span style="color: cyan; font-weight: 600;">agents</span> action create <span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span> <span style="color: #66cc66;">&lt;CFG_FILE&gt;</span></code></pre></div>
**Purpose**
Create a new action template from a YAML configuration file. The `--config` file is required and must fully define the action.
@@ -16712,7 +16712,7 @@ Archive an action.
##### agents automation-profile add
<div class="highlight"><pre><code><span style="color: cyan; font-weight: 600;">agents</span> automation-profile add (<span style="color: magenta;"><span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span></span>) <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]</code></pre></div>
<div class="highlight"><pre><code><span style="color: cyan; font-weight: 600;">agents</span> automation-profile add <span style="color: cyan;">--config</span>|<span style="color: yellow;">-c</span> <span style="color: #66cc66;">&lt;FILE&gt;</span> [<span style="color: cyan;">--update</span>]</code></pre></div>
**Purpose**
Register a new custom automation profile from a YAML configuration file. The profile is fully defined by the config file. If a profile with the same name already exists, the command fails unless the `--update` flag is provided.