Skip to content

docs: remove local OpenClaw examples (Fixes #3277)#3284

Merged
ericksoa merged 4 commits into
NVIDIA:mainfrom
deepujain:docs/3277-quickstart-no-local
May 25, 2026
Merged

docs: remove local OpenClaw examples (Fixes #3277)#3284
ericksoa merged 4 commits into
NVIDIA:mainfrom
deepujain:docs/3277-quickstart-no-local

Conversation

@deepujain
Copy link
Copy Markdown
Contributor

@deepujain deepujain commented May 8, 2026

Summary

The quickstart and related getting-started docs still showed openclaw agent --local in runnable NemoClaw sandbox examples. That flag is blocked inside NemoClaw-managed sandboxes, so the examples now use the supported openclaw agent form.

Fixes #3277.

Changes

  • Updated the README, quickstart, remote GPU deployment guide, monitoring guide, and matching user skills to drop --local from runnable openclaw agent commands.
  • Left the security warning references alone because those describe the unsafe host-local mode, not a command users should run inside NemoClaw.

Testing

  • npm run build:cli passed.
  • rg -n -e '--local' README.md docs .agents now only finds the security/best-practices warning references.
  • HOME=/private/tmp/nemoclaw-test-home-3277 npm test was attempted. The local full suite still fails in existing installer/preinstall and unrelated CLI/onboard tests, including test/install-preflight.test.ts, test/preinstall-node-version.test.ts, test/cli.test.ts, and test/onboard-selection.test.ts.

Evidence it works

The runnable documentation paths no longer include the blocked --local flag, while the build still compiles from this branch.

Summary by CodeRabbit

  • Documentation
    • Updated CLI examples in deployment and monitoring docs to reflect current syntax.
    • Removed the --local flag from agent test inference commands.
    • Clarified sandbox monitoring steps by adding an explicit connection step before running test inferences.

Review Change Stack

Signed-off-by: Aaron Erickson aerickson@nvidia.com

Fixes NVIDIA#3277

Signed-off-by: Deepak Jain <deepujain@gmail.com>
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented May 8, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 8, 2026

📝 Walkthrough

Walkthrough

This PR updates documentation examples across the NemoClaw repository to remove the --local flag from openclaw agent commands, which is blocked inside NemoClaw sandboxes. Changes span README, deployment guides, monitoring instructions, and agent skills to ensure consistent, sandbox-compatible examples.

Changes

CLI Documentation Updates

Layer / File(s) Summary
Core user documentation
README.md
README "Chat with the Agent" section removes --local from the single-message example command.
Deployment and monitoring verification examples
.agents/skills/nemoclaw-user-deploy-remote/SKILL.md, .agents/skills/nemoclaw-user-monitor-sandbox/SKILL.md, docs/deployment/deploy-to-remote-gpu.mdx, docs/monitoring/monitor-sandbox-activity.mdx
Deployment verification, monitoring test inference, and corresponding agent skills all remove --local from openclaw agent examples; monitoring instructions add the prerequisite nemoclaw <name> connect step before running the agent command.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related issues

  • #3277: Quickstart documents --local flag that is blocked inside NemoClaw sandboxes — this PR removes the documented --local usage in quickstart/verification examples.
  • #3692: Retrieved similarity match addressing the same --local removal in agent examples — changes align with that documentation fix.

Poem

🐰 I hopped through docs to clear the view,
A tiny flag I bid adieu.
Sandbox safe, the commands now run,
Simpler prompts beneath the sun.
Happy hops for users, one by one!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and accurately summarizes the main change: removing the --local flag from OpenClaw documentation examples.
Linked Issues check ✅ Passed The PR fully addresses issue #3277 by removing the blocked --local flag from all runnable documentation examples (README, quickstart, deployment, and monitoring guides).
Out of Scope Changes check ✅ Passed All changes are directly scoped to the issue: removing --local from documentation examples. No unrelated modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md`:
- Around line 348-350: Replace the bash fenced CLI snippet with a console fenced
block and add the $ prompt so the command appears as an interactive shell
example; update the block containing the command `openclaw agent --agent main -m
"hello" --session-id test` to use ```console and prefix the line with `$ `
instead of using ```bash.
🪄 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: 46893e92-5204-478d-aa1c-c48caa03d8d8

📥 Commits

Reviewing files that changed from the base of the PR and between f1568f6 and 403ad23.

📒 Files selected for processing (7)
  • .agents/skills/nemoclaw-user-deploy-remote/SKILL.md
  • .agents/skills/nemoclaw-user-get-started/SKILL.md
  • .agents/skills/nemoclaw-user-monitor-sandbox/SKILL.md
  • README.md
  • docs/deployment/deploy-to-remote-gpu.md
  • docs/get-started/quickstart.md
  • docs/monitoring/monitor-sandbox-activity.md

Comment thread docs/get-started/quickstart.md Outdated
Signed-off-by: dejain <deepujain@gmail.com>
@wscurran
Copy link
Copy Markdown
Contributor

✨ Thanks for submitting this detailed PR that removes local OpenClaw examples from the quickstart and getting-started docs. This change aims to improve the documentation and onboarding experience by updating the README, quickstart, and user skills to use the supported openclaw agent form.


Related open issues:

Signed-off-by: Aaron Erickson <aerickson@nvidia.com>

# Conflicts:
#	.agents/skills/nemoclaw-user-get-started/SKILL.md
#	docs/get-started/quickstart.mdx
Copy link
Copy Markdown
Contributor

@ericksoa ericksoa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adversarial review found no blocking issues. The PR removes unsafe/outdated --local usage from user-facing OpenClaw examples, and the branch is mergeable with current main.

Signed-off-by: Aaron Erickson <aerickson@nvidia.com>
@ericksoa ericksoa enabled auto-merge (squash) May 25, 2026 04:53
@ericksoa ericksoa merged commit 0db540e into NVIDIA:main May 25, 2026
20 of 23 checks passed
@wscurran wscurran added area: install Install, setup, prerequisites, or uninstall flow area: onboarding Onboarding FSM, provider setup, sandbox launch, or first-run flow bug-fix PR fixes a bug or regression area: docs Documentation, examples, guides, or docs build and removed Getting Started labels Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation, examples, guides, or docs build area: install Install, setup, prerequisites, or uninstall flow area: onboarding Onboarding FSM, provider setup, sandbox launch, or first-run flow bug-fix PR fixes a bug or regression v0.0.51 Release target

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Quickstart documents --local flag that is blocked inside NemoClaw sandboxes

4 participants