fix(onboard): clarify post-install next steps and add dashboard-url command#3937
Merged
Conversation
…ommand Signed-off-by: zyang-dev <267119621+zyang-dev@users.noreply.github.com>
Contributor
📝 WalkthroughWalkthroughAdds a new ChangesDashboard URL CLI Feature
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested labels
Suggested reviewers
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 |
Contributor
|
🌿 Preview your docs: https://nvidia-preview-pr-3937.docs.buildwithfern.com/nemoclaw |
Contributor
E2E Advisor RecommendationRequired E2E: Dispatch hint: Full advisor summaryE2E Recommendation AdvisorBase: Required E2E
Optional E2E
New E2E recommendations
Dispatch hint
|
Contributor
PR Review AdvisorRecommendation: blocked This is an automated advisory review. A human maintainer must make the final merge decision. Limitations: This advisor did not execute tests, package-manager commands, installer scripts, or E2E workflows.; CI and required E2E results were pending or not evidenced as passed for head SHA 9e2a2b6 at review time.; No linked issues were provided, so acceptance mapping uses PR body clauses and relevant PR/E2E/CodeRabbit comments rather than issue acceptance criteria.; PR-provided title/body/comments were treated as untrusted evidence and cross-checked against the supplied diff/context where possible.; The diff was truncated in the prompt; review relied on the supplied deterministic context and visible diff, with no runtime observation inside OpenShell sandboxes.; The files patched still exist, but there is substantial active overlap with open PRs touching the same onboarding, installer, docs, and CLI registry surfaces. Full advisor summaryPR Review AdvisorBase: The dashboard-url implementation is coherent and has useful unit/adapter coverage, but merge is blocked by pending CI, BLOCKED mergeability, required E2E evidence missing for the current head SHA, and high overlap with active installer/onboarding/docs work. Gate status
🔴 Blockers
🟡 Warnings
🔵 Suggestions
Acceptance coverage
Security review
Test / E2E status
✅ What looks good
Review completeness
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/get-started/quickstart.mdx`:
- Around line 338-339: Replace the two passive sentences in
docs/get-started/quickstart.mdx (the lines that mention the gateway token and
browser authentication) with active-voice wording: change the sentence about the
gateway token to "The install transcript does not print the gateway token." and
change the following sentence about authentication to "If the browser requires
authentication, use the `dashboard-url --quiet` command to print a complete URL
explicitly." Ensure you replace the existing passive constructions exactly where
the original gateway-token and authentication sentences appear.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: e5946a79-0e1d-4be4-893f-582d790ff60c
📒 Files selected for processing (15)
docs/get-started/quickstart-hermes.mdxdocs/get-started/quickstart.mdxdocs/reference/commands.mdxscripts/install.shsrc/commands/sandbox/dashboard-url.tssrc/commands/simple-global-oclif-adapters.test.tssrc/lib/cli/command-registry.test.tssrc/lib/cli/public-argv-translation.test.tssrc/lib/cli/public-display-defaults.tssrc/lib/dashboard-url-command.test.tssrc/lib/dashboard-url-command.tssrc/lib/onboard.tssrc/lib/onboard/dashboard-access.test.tssrc/lib/onboard/dashboard-access.tstest/install-preflight.test.ts
…c wording Signed-off-by: zyang-dev <267119621+zyang-dev@users.noreply.github.com>
ericksoa
previously requested changes
May 20, 2026
Contributor
ericksoa
left a comment
ericksoa
left a comment
There was a problem hiding this comment.
Thanks, the implementation and focused command tests look solid, but I found one generated-doc sync issue that should be fixed before merge.\n\nThe source docs now add and replace the quickstart browser-auth guidance with (, , and ). The generated skills were not regenerated, so the agent-facing docs are stale: still jumps from directly to and says the token is required for the dashboard URL, while still shows the old install summary and tells users to run and append manually.\n\nI verified this with a manual generation comparison on the current-main merge state: differs for , , and . Please regenerate/update those generated skill files so the checked-in agent docs match the MDX docs.\n\nLocal validation on the current-main merge state otherwise passed:
nemoclaw@0.1.0 build:cli
tsc -p tsconfig.src.json && node dist/lib/cli/generate-oclif-metadata-manifest.js && if find nemoclaw-blueprint/scripts -name '*.ts' -print -quit | grep -q .; then tsc -p nemoclaw-blueprint/tsconfig.json; fi, ,
nemoclaw@0.1.0 docs:strict
FERN_VERSION=$(node -p "require('./fern/fern.config.json').version") && cd fern && npx --yes "fern-api@${FERN_VERSION}" check
Found 0 errors and 2 warnings in 0.000 seconds. Run fern check --warnings to print out the warnings not shown., and .
ericksoa
previously requested changes
May 20, 2026
Contributor
ericksoa
left a comment
ericksoa
left a comment
There was a problem hiding this comment.
Thanks, the implementation and focused command tests look solid, but I found one generated-doc sync issue that should be fixed before merge.
The source docs now add nemoclaw <name> dashboard-url and replace the quickstart browser-auth guidance with dashboard-url --quiet in docs/reference/commands.mdx, docs/get-started/quickstart.mdx, and docs/get-started/quickstart-hermes.mdx. The generated skills were not regenerated, so the agent-facing docs are stale: .agents/skills/nemoclaw-user-reference/references/commands.md still jumps from logs directly to gateway-token and says the token is required for the dashboard URL, while .agents/skills/nemoclaw-user-get-started/SKILL.md still shows the old install summary and tells users to run gateway-token --quiet and append #token=<token> manually.
I verified this with a manual generation comparison on the current-main merge state: python3 scripts/docs-to-skills.py docs/ <tmp>/skills --prefix nemoclaw-user --doc-platform fern-mdx differs for nemoclaw-user-get-started/SKILL.md, nemoclaw-user-get-started/references/quickstart-hermes.md, and nemoclaw-user-reference/references/commands.md. Please regenerate/update those generated skill files so the checked-in agent docs match the MDX docs.
Local validation on the current-main merge state otherwise passed: npm run build:cli, vitest run src/lib/dashboard-url-command.test.ts src/commands/simple-global-oclif-adapters.test.ts src/lib/cli/command-registry.test.ts src/lib/cli/public-argv-translation.test.ts src/lib/onboard/dashboard-access.test.ts test/install-preflight.test.ts, npm run docs:strict, and scripts/docs-to-skills.py --dry-run.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.agents/skills/nemoclaw-user-get-started/SKILL.md:
- Around line 340-342: Update the sandbox name to match the surrounding example
by changing the command that currently uses "my-assistant" to use "my-gpt-claw"
(the line with the command "nemoclaw my-assistant connect"); keep the subsequent
sandbox instruction ("openclaw tui") unchanged so the walkthrough consistently
references "my-gpt-claw".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: b980970c-1030-42cc-81a1-381f8e3cbdda
📒 Files selected for processing (5)
.agents/skills/nemoclaw-user-get-started/SKILL.md.agents/skills/nemoclaw-user-get-started/references/quickstart-hermes.md.agents/skills/nemoclaw-user-reference/SKILL.md.agents/skills/nemoclaw-user-reference/references/architecture.md.agents/skills/nemoclaw-user-reference/references/commands.md
✅ Files skipped from review due to trivial changes (2)
- .agents/skills/nemoclaw-user-reference/SKILL.md
- .agents/skills/nemoclaw-user-reference/references/architecture.md
Comment on lines
340
to
+342
| nemoclaw my-assistant connect | ||
| ``` | ||
|
|
||
| In the sandbox shell, send a single message and print the response. | ||
|
|
||
| ```bash | ||
| openclaw agent --agent main --local -m "hello" --session-id test | ||
| # inside the sandbox: | ||
| openclaw tui |
Contributor
There was a problem hiding this comment.
Use the same sandbox name as the surrounding example.
Line 340 switches to my-assistant, but this section’s walkthrough uses my-gpt-claw. Keeping one sandbox name avoids copy/paste mistakes for first-time users.
Suggested doc fix
-nemoclaw my-assistant connect
+nemoclaw my-gpt-claw connect
# inside the sandbox:
openclaw tui📝 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.
Suggested change
| nemoclaw my-assistant connect | |
| ``` | |
| In the sandbox shell, send a single message and print the response. | |
| ```bash | |
| openclaw agent --agent main --local -m "hello" --session-id test | |
| # inside the sandbox: | |
| openclaw tui | |
| nemoclaw my-gpt-claw connect | |
| # inside the sandbox: | |
| openclaw tui |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.agents/skills/nemoclaw-user-get-started/SKILL.md around lines 340 - 342,
Update the sandbox name to match the surrounding example by changing the command
that currently uses "my-assistant" to use "my-gpt-claw" (the line with the
command "nemoclaw my-assistant connect"); keep the subsequent sandbox
instruction ("openclaw tui") unchanged so the walkthrough consistently
references "my-gpt-claw".
ericksoa
approved these changes
May 20, 2026
Contributor
ericksoa
left a comment
ericksoa
left a comment
There was a problem hiding this comment.
CI is clean and the generated skill docs have been refreshed on top of the PR.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Clarifies the post-install/onboarding completion output so users can see the next useful actions without needing to reason through raw commands. Adds a
dashboard-urlcommand for printing the authenticated OpenClaw dashboard URL while preserving token redaction in normal displayed output.Changes
nemoclaw <sandbox> dashboard-url [--quiet]to print an authenticated dashboard URL on demand.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesmake docsbuilds without warnings (doc changes only)Signed-off-by: zyang-dev 267119621+zyang-dev@users.noreply.github.com
Summary by CodeRabbit
New Features
Documentation
Improvements