fix(cli): add reconfiguration guidance to help and post-onboard output#1725
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdded post-onboard reconfiguration guidance to two CLI outputs (dashboard and help): copy-paste commands for changing model routing, adding sandbox policies, and resetting credentials then re-onboarding. No functional, API, or control-flow changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
src/nemoclaw.ts (1)
1384-1384: Verb choice: "Change" would be more accurate than "Add".The documented workflow (
nemoclaw credentials reset <KEY> then nemoclaw onboard) is for changing existing credentials (reset removes them, re-onboard re-prompts), not adding new ones. The verb "Add" is misleading here.Suggested wording fix
- ${D}Add credentials, messaging channels, or sandbox image settings:${R} + ${D}Change credentials, messaging channels, or sandbox image settings:${R} nemoclaw credentials reset <KEY> ${D}then${R} nemoclaw onboard🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/nemoclaw.ts` at line 1384, The message text currently uses the verb "Add" but should say "Change" to accurately describe the workflow; locate the template/string in src/nemoclaw.ts that contains "${D}Change credentials, messaging channels, or sandbox image settings:${R}" (or the version currently using "Add") and replace "Add" with "Change" so the CLI help/readme reflects the correct action for the "nemoclaw credentials reset <KEY> then nemoclaw onboard" flow.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@src/nemoclaw.ts`:
- Line 1384: The message text currently uses the verb "Add" but should say
"Change" to accurately describe the workflow; locate the template/string in
src/nemoclaw.ts that contains "${D}Change credentials, messaging channels, or
sandbox image settings:${R}" (or the version currently using "Add") and replace
"Add" with "Change" so the CLI help/readme reflects the correct action for the
"nemoclaw credentials reset <KEY> then nemoclaw onboard" flow.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: c3d220d6-c05f-4fe5-861e-9f8a5ac35969
📒 Files selected for processing (2)
src/lib/onboard.tssrc/nemoclaw.ts
|
✨ Thanks for submitting this PR, which proposes a fix for a documentation issue and may improve the overall user experience — the added guidance and explanations are clear and easy to follow. Possibly related open issues: |
|
Thanks for contributing — adding reconfiguration guidance to the help output and post-onboard messaging fills a real discoverability gap for users who need to change their setup after initial onboard. The codebase has changed significantly since this was opened, including a TypeScript migration (#1673). Could you rebase onto the current main? |
6aeb362 to
5046888
Compare
|
@wscurran Thanks for picking this up — you're right, the branch had gotten stale. Rebased onto latest |
prekshivyas
left a comment
There was a problem hiding this comment.
Good UX improvement — fills a real gap for users hitting read-only sandbox config. @latenighthackathon can you rebase onto main?
5046888 to
ea584ee
Compare
|
@prekshivyas Rebased onto latest Cheers! |
|
@latenighthackathon please give access to update branch and this should be good to go |
New users hit 'openclaw configure' inside the sandbox and get a read-only error with no guidance on what to do instead. Add a Reconfiguration section to 'nemoclaw --help' and a 'To change settings later' block to the post-onboard dashboard output, covering the three main reconfiguration paths: runtime model switch via openshell inference set, policy presets via nemoclaw policy-add, and credential reset + re-onboard for image-level changes. Closes NVIDIA#1699 Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
ea584ee to
b3fcdcd
Compare
|
@prekshivyas — |
Summary
New users hit
openclaw configureinside the sandbox and get a read-only error with no guidance on what to do instead. This adds clear reconfiguration instructions in two places.Problem
openclaw.jsonis read-only inside the sandbox (Landlock enforced) by design. When users tryopenclaw configure, they see:No NemoClaw documentation or CLI output explains the three available reconfiguration paths. Users are left guessing.
Changes
nemoclaw --help: Added a "Reconfiguration (after onboard)" section listing the three paths:openshell inference setnemoclaw <name> policy-addnemoclaw credentials reset <KEY>thennemoclaw onboardPost-onboard dashboard: Added a "To change settings later" block at the end of the completion output so users see the reconfiguration paths immediately after their first onboard.
Test plan
npm run build:clipassesnpm run typecheck:clipassesnpm run lintpassesCloses #1699
Signed-off-by: latenighthackathon latenighthackathon@users.noreply.github.com
Summary by CodeRabbit