docs: Update CLI Reference for Agent Runtime#130
Conversation
Co-authored-by: yacosta738 <33158051+yacosta738@users.noreply.github.com>
Deploying corvus with
|
| Latest commit: |
657aa2f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://e394d85a.corvus-42x.pages.dev |
| Branch Preview URL: | https://docs-cli-reference-audit-735.corvus-42x.pages.dev |
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
📝 WalkthroughSummary by CodeRabbitRelease NotesDocumentation
WalkthroughThis PR updates docs and journal entries to record a completed CLI reference audit and to document newly supported CLI flags: Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
✅ Contributor ReportUser: @yacosta738
Contributor Report evaluates based on public GitHub activity. Analysis period: 2025-03-04 to 2026-03-04 |
yacosta738
changed the title
yacosta738
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.agents/journal/scribe-journal.md:
- Around line 73-93: Add missing blank lines around markdown headings and fenced
code blocks in the journal entry for "2026-05-22 - CLI Reference Audit & Update
- COMPLETE": ensure there is an empty line before and after each
top-level/sub-heading (e.g., the "Verification:", "Changes:", "Validation:", and
"Notes:" sections) and before/after any fenced code blocks mentioned in the
entry so markdownlint warnings are resolved; specifically insert blank lines
around the blocks near the end of that entry so spacing is consistent with the
rest of the file.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 9b39ae4e-4e51-4b94-889a-d6b65898aaf3
📒 Files selected for processing (3)
.agents/journal/scribe-journal.mdclients/web/apps/docs/src/content/docs/en/guides/cli-reference.mdclients/web/apps/docs/src/content/docs/es/guides/cli-reference.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: sonar
- GitHub Check: pr-checks
- GitHub Check: Cloudflare Pages
- GitHub Check: pr-checks-build-logic
- GitHub Check: pr-checks
🧰 Additional context used
📓 Path-based instructions (2)
**/*.{md,mdx}
⚙️ CodeRabbit configuration file
**/*.{md,mdx}: Verify technical accuracy and that docs stay aligned with code changes.
For user-facing docs, check EN/ES parity or explicitly note pending translation gaps.
Files:
clients/web/apps/docs/src/content/docs/en/guides/cli-reference.mdclients/web/apps/docs/src/content/docs/es/guides/cli-reference.md
**/*
⚙️ CodeRabbit configuration file
**/*: Security first, performance second.
Validate input boundaries, auth/authz implications, and secret management.
Look for behavioral regressions, missing tests, and contract breaks across modules.
Files:
clients/web/apps/docs/src/content/docs/en/guides/cli-reference.mdclients/web/apps/docs/src/content/docs/es/guides/cli-reference.md
🧠 Learnings (4)
📚 Learning: 2026-02-17T07:28:38.934Z
Learnt from: CR
Repo: dallay/corvus PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-02-17T07:28:38.934Z
Learning: Applies to .agents/AGENTS.md : Document agent configurations and capabilities in AGENTS.md
Applied to files:
.agents/journal/scribe-journal.md
📚 Learning: 2026-02-17T12:31:17.076Z
Learnt from: CR
Repo: dallay/corvus PR: 0
File: clients/agent-runtime/AGENTS.md:0-0
Timestamp: 2026-02-17T12:31:17.076Z
Learning: Applies to clients/agent-runtime/**/*.rs : Run `cargo fmt --all -- --check`, `cargo clippy --all-targets -- -D warnings`, and `cargo test` for code validation, or document which checks were skipped and why
Applied to files:
.agents/journal/scribe-journal.md
📚 Learning: 2026-02-17T12:31:17.076Z
Learnt from: CR
Repo: dallay/corvus PR: 0
File: clients/agent-runtime/AGENTS.md:0-0
Timestamp: 2026-02-17T12:31:17.076Z
Learning: Applies to clients/agent-runtime/src/main.rs : Preserve CLI contract unless change is intentional and documented; prefer explicit errors over silent fallback for unsupported critical paths
Applied to files:
.agents/journal/scribe-journal.md
📚 Learning: 2026-02-21T09:07:52.298Z
Learnt from: yacosta738
Repo: dallay/corvus PR: 62
File: .agents/journal/sentinnel-journal.md:1-1
Timestamp: 2026-02-21T09:07:52.298Z
Learning: Branding guideline: The intentional brand name for the security-first agent in the dallay/corvus repository is 'Sentinnel' (with double n). Do not treat it as a typo of 'Sentinel'. Ensure all agent-related docs and journals under .agents/journal consistently use 'Sentinnel' with double n.
Applied to files:
.agents/journal/scribe-journal.md
🪛 LanguageTool
clients/web/apps/docs/src/content/docs/es/guides/cli-reference.md
[grammar] ~223-~223: Elimina la puntuación
Context: ... vía USB (probe-rs). - --chip <CHIP>: Nombre del chip (ej., STM32F401RETx)....
(QB_NEW_ES_OTHER_ERROR_IDS_UNNECESSARY_PUNCTUATION)
[grammar] ~237-~237: Elimina la puntuación
Context: ...re de Corvus al Arduino. - setup-uno-q: Configura la aplicación Arduino Uno Q B...
(QB_NEW_ES_OTHER_ERROR_IDS_UNNECESSARY_PUNCTUATION)
[grammar] ~238-~238: Elimina la puntuación
Context: ...espliega bridge GPIO). - --host <IP>: Dirección IP de Uno Q. Ejemplo: ``...
(QB_NEW_ES_OTHER_ERROR_IDS_UNNECESSARY_PUNCTUATION)
[grammar] ~253-~253: Elimina la puntuación
Context: ...abajo de OpenClaw. - --source <PATH>: Ruta opcional al espacio de trabajo de ...
(QB_NEW_ES_OTHER_ERROR_IDS_UNNECESSARY_PUNCTUATION)
🪛 markdownlint-cli2 (0.21.0)
.agents/journal/scribe-journal.md
[warning] 76-76: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 80-80: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
[warning] 92-92: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
[warning] 100-100: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
🔇 Additional comments (7)
.agents/journal/scribe-journal.md (2)
101-101: LGTM!TODO item correctly marked as DONE, consistent with the completed audit documented above.
73-93: Verification complete: CLI flags confirmed as documented.The journal entry is accurate. Both
migrate openclaw --dry-runand--sourceflags exist and are properly implemented inclients/agent-runtime/src/lib.rs(lines 150-161) andclients/agent-runtime/src/main.rs(lines 314-325), with full handler implementation inmigration.rsincluding test coverage for dry-run behavior.clients/web/apps/docs/src/content/docs/en/guides/cli-reference.md (4)
160-160: LGTM! Accurate documentation of --provider flag.The documented behavior matches the source implementation: defaults to configured provider, then falls back to "openrouter". Based on learnings: clients/agent-runtime/**/*.rs code shows ModelCommands::Refresh accepts optional provider parameter.
223-223: LGTM! Accurate documentation of --chip flag.Correctly documents the hardware info --chip option with appropriate example. Based on learnings: clients/agent-runtime/src/lib.rs defines HardwareCommands::Info with chip parameter defaulting to "STM32F401RETx".
237-238: LGTM! Accurate documentation of setup-uno-q command.The setup-uno-q command and --host flag are correctly documented. Based on learnings: clients/agent-runtime/src/lib.rs defines PeripheralCommands::SetupUnoQ with optional host parameter.
253-254: Documentation is accurate; both flags are properly implemented.The
--sourceand--dry-runflags formigrate openclaware defined in the CLI parser (clients/agent-runtime/src/lib.rsandmain.rs, lines 150-160 and 314-324 respectively) with correct types and#[arg(long)]attributes. Migration logic respects both:--sourcedefaults to~/.openclaw/workspace, and--dry-runvalidates without writing data. No action needed.clients/web/apps/docs/src/content/docs/es/guides/cli-reference.md (1)
160-160: LGTM! Excellent EN/ES parity maintained.All new CLI options are accurately translated and maintain 1:1 correspondence with the English version:
- models refresh --provider
- hardware info --chip
- peripheral setup-uno-q --host
- migrate openclaw --source and --dry-run
The Spanish translations are technically accurate and the glossary consistency noted in the journal (e.g., "Simulación" for dry-run) is properly applied. As per coding guidelines: EN/ES parity verification confirms the documentation stays aligned across languages.
Note: Static analysis grammar warnings about "unnecessary punctuation" are false positives - they're flagging markdown code block formatting, not actual Spanish grammar issues.
Also applies to: 223-223, 237-238, 253-254
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
.agents/journal/scribe-journal.md (1)
97-98:⚠️ Potential issue | 🟡 MinorAdd a blank line after the TODO heading (markdownlint MD022).
Line 97 heading should be followed by an empty line before the list starts on Line 98.
Proposed fix
## TODO + - [x] Verify CLI reference against actual code implementation - DONE (gaps found)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.agents/journal/scribe-journal.md around lines 97 - 98, Add a single blank line after the "## TODO" heading so the heading is followed by an empty line before the list (fixing markdownlint MD022); locate the "## TODO" heading in .agents/journal/scribe-journal.md and insert one empty line between that heading and the subsequent "- [x] Verify CLI reference..." list item.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.agents/journal/scribe-journal.md:
- Line 73: Update the journal header "## 2026-05-22 - CLI Reference Audit &
Update - COMPLETE" to the actual execution date of this PR (replace 2026-05-22
with 2026-03-04) so the audit chronology is accurate; locate the header line in
.agents/journal/scribe-journal.md and change only the date portion of that
header string.
---
Duplicate comments:
In @.agents/journal/scribe-journal.md:
- Around line 97-98: Add a single blank line after the "## TODO" heading so the
heading is followed by an empty line before the list (fixing markdownlint
MD022); locate the "## TODO" heading in .agents/journal/scribe-journal.md and
insert one empty line between that heading and the subsequent "- [x] Verify CLI
reference..." list item.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: ebd87226-ce16-424e-bb3a-7e50af793cda
📒 Files selected for processing (1)
.agents/journal/scribe-journal.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: sonar
- GitHub Check: Cloudflare Pages
🧰 Additional context used
🧠 Learnings (5)
📚 Learning: 2026-02-17T07:28:38.934Z
Learnt from: CR
Repo: dallay/corvus PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-02-17T07:28:38.934Z
Learning: Applies to .agents/AGENTS.md : Document agent configurations and capabilities in AGENTS.md
Applied to files:
.agents/journal/scribe-journal.md
📚 Learning: 2026-02-17T12:31:17.076Z
Learnt from: CR
Repo: dallay/corvus PR: 0
File: clients/agent-runtime/AGENTS.md:0-0
Timestamp: 2026-02-17T12:31:17.076Z
Learning: Applies to clients/agent-runtime/**/*.rs : Run `cargo fmt --all -- --check`, `cargo clippy --all-targets -- -D warnings`, and `cargo test` for code validation, or document which checks were skipped and why
Applied to files:
.agents/journal/scribe-journal.md
📚 Learning: 2026-02-17T12:31:17.076Z
Learnt from: CR
Repo: dallay/corvus PR: 0
File: clients/agent-runtime/AGENTS.md:0-0
Timestamp: 2026-02-17T12:31:17.076Z
Learning: Applies to clients/agent-runtime/src/main.rs : Preserve CLI contract unless change is intentional and documented; prefer explicit errors over silent fallback for unsupported critical paths
Applied to files:
.agents/journal/scribe-journal.md
📚 Learning: 2026-02-17T12:31:17.076Z
Learnt from: CR
Repo: dallay/corvus PR: 0
File: clients/agent-runtime/AGENTS.md:0-0
Timestamp: 2026-02-17T12:31:17.076Z
Learning: Applies to clients/agent-runtime/.github/**/*.{yml,yaml} : For workflow/template-only changes, ensure YAML/template syntax validity
Applied to files:
.agents/journal/scribe-journal.md
📚 Learning: 2026-02-21T09:07:52.298Z
Learnt from: yacosta738
Repo: dallay/corvus PR: 62
File: .agents/journal/sentinnel-journal.md:1-1
Timestamp: 2026-02-21T09:07:52.298Z
Learning: Branding guideline: The intentional brand name for the security-first agent in the dallay/corvus repository is 'Sentinnel' (with double n). Do not treat it as a typo of 'Sentinel'. Ensure all agent-related docs and journals under .agents/journal consistently use 'Sentinnel' with double n.
Applied to files:
.agents/journal/scribe-journal.md
🪛 markdownlint-cli2 (0.21.0)
.agents/journal/scribe-journal.md
[warning] 97-97: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
|
|
||
| --- | ||
|
|
||
| ## 2026-05-22 - CLI Reference Audit & Update - COMPLETE |
There was a problem hiding this comment.
Correct the journal date to match this PR timeline.
Line 73 uses 2026-05-22, which is in the future relative to this PR creation date (March 4, 2026). Please update it to the actual execution date to keep audit chronology accurate.
Proposed fix
-## 2026-05-22 - CLI Reference Audit & Update - COMPLETE
+## 2026-03-04 - CLI Reference Audit & Update - COMPLETE📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## 2026-05-22 - CLI Reference Audit & Update - COMPLETE | |
| ## 2026-03-04 - CLI Reference Audit & Update - COMPLETE |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.agents/journal/scribe-journal.md at line 73, Update the journal header "##
2026-05-22 - CLI Reference Audit & Update - COMPLETE" to the actual execution
date of this PR (replace 2026-05-22 with 2026-03-04) so the audit chronology is
accurate; locate the header line in .agents/journal/scribe-journal.md and change
only the date portion of that header string.
|
1 participant
Audited the agent-runtime source code and updated the CLI reference documentation in both English and Spanish to include previously undocumented commands (peripheral setup-uno-q) and flags (migrate openclaw --dry-run/--source, hardware info --chip, models refresh --provider). Verified with build/lint checks and visual screenshots.
PR created automatically by Jules for task 7351758454802832710 started by @yacosta738