Skip to content

docs: add OpenClaw plugin install guide (Fixes #2538) - #2587

Merged
cv merged 2 commits into
NVIDIA:mainfrom
deepujain:docs/2538-openclaw-plugins
Apr 28, 2026
Merged

docs: add OpenClaw plugin install guide (Fixes #2538)#2587
cv merged 2 commits into
NVIDIA:mainfrom
deepujain:docs/2538-openclaw-plugins

Conversation

@deepujain

@deepujain deepujain commented Apr 28, 2026

Copy link
Copy Markdown
Contributor

Summary

NemoClaw docs did not explain how OpenClaw plugins should be installed under NemoClaw. This adds a deployment guide that points plugin users to the supported custom-sandbox-image path.

Changes

  • Add an OpenClaw plugin install guide with a build-directory layout and Dockerfile example.
  • Link the guide from the docs deployment index.
  • Add a note under skill install that OpenClaw plugins are different from SKILL.md agent skills.
  • Regenerate the generated nemoclaw-user skills content.

Testing

  • python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user passed.
  • npm test -- test/skills-frontmatter.test.ts passed: 38 tests.
  • npm run build:cli passed.
  • npx prettier --check docs/deployment/install-openclaw-plugins.md docs/index.md docs/reference/commands.md .agents/skills/nemoclaw-user-deploy-remote/SKILL.md .agents/skills/nemoclaw-user-reference/references/commands.md passed.
  • Full npm test -- --reporter=dot was attempted. In this local checkout it still fails in unrelated installer/uninstall/onboard tests and generated-dist lookup paths.

Evidence it works

The docs generator picked up the new plugin install page and updated the generated deployment skill content.

Fixes #2538

Signed-off-by: Deepak Jain deepujain@gmail.com

Summary by CodeRabbit

  • Documentation
    • Added comprehensive OpenClaw plugins deployment guide with Dockerfile-based preparation, build and onboarding workflow, configuration notes, and troubleshooting.
    • Clarified that OpenClaw plugins are distinct from agent skills and require a separate installation process; updated command reference links accordingly.
    • Updated documentation navigation and renumbered onboarding steps to account for the new plugin content.

@copy-pr-bot

copy-pr-bot Bot commented Apr 28, 2026

Copy link
Copy Markdown

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

coderabbitai Bot commented Apr 28, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: c459045b-d532-40ce-86f6-d35a83cb2009

📥 Commits

Reviewing files that changed from the base of the PR and between 1221d01 and 7f7d4e2.

📒 Files selected for processing (5)
  • .agents/skills/nemoclaw-user-deploy-remote/SKILL.md
  • .agents/skills/nemoclaw-user-reference/references/commands.md
  • docs/deployment/install-openclaw-plugins.md
  • docs/index.md
  • docs/reference/commands.md
✅ Files skipped from review due to trivial changes (4)
  • docs/index.md
  • docs/reference/commands.md
  • .agents/skills/nemoclaw-user-reference/references/commands.md
  • docs/deployment/install-openclaw-plugins.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • .agents/skills/nemoclaw-user-deploy-remote/SKILL.md

📝 Walkthrough

Walkthrough

This PR adds user-facing documentation for installing OpenClaw plugins via NemoClaw: a new how-to guide, an expanded remote-deploy skill SKILL.md section with plugin onboarding steps, and clarifications in command reference and site navigation distinguishing plugins from agent skills.

Changes

Cohort / File(s) Summary
Plugin How‑to
docs/deployment/install-openclaw-plugins.md
New step-by-step guide describing plugin vs. skill/preset differences, a Dockerfile-based bake/install recipe, plugin placement under /sandbox/.openclaw-data/extensions/, openclaw doctor --fix/config guidance, network-egress notes, and common pitfalls.
Remote Deploy Skill docs
.agents/skills/nemoclaw-user-deploy-remote/SKILL.md
Inserted an "OpenClaw plugins" section with onboarding flow (prepare Docker build context, example Dockerfile, run openclaw doctor --fix, use nemoclaw onboard --from <Dockerfile>), egress/policy guidance, and renumbered subsequent Telegram onboarding steps.
Command references
.agents/skills/nemoclaw-user-reference/references/commands.md, docs/reference/commands.md
Clarifies that nemoclaw <name> skill install <path> is for skills, not OpenClaw plugins; adds links pointing to the new plugin installation guide.
Docs navigation
docs/index.md
Added the "Install OpenClaw Plugins" page to the Deployment toctree in the correct sequence between Telegram setup and sandbox hardening pages.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 I found a Dockerfile to share,

I stitched a plugin with careful care,
No more source-dives or midnight fright,
Docs now guide me through the night,
Hoppity hops—deployments delight! 🎉

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately describes the primary change: adding an OpenClaw plugin installation guide. It is concise, specific, and directly related to the main objective of the changeset.
Linked Issues check ✅ Passed The PR comprehensively addresses issue #2538 objectives: defines OpenClaw plugins vs skills/presets, provides Dockerfile-bake recipe with examples, documents the sandbox creation workflow, covers egress/network policy setup, and includes clarifications in CLI command docs.
Out of Scope Changes check ✅ Passed All changes are directly scoped to issue #2538: new plugin installation guide documentation, updates to command references clarifying plugins vs skills, and generated skill content updates. No unrelated modifications detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/deployment/install-openclaw-plugins.md (1)

89-97: ⚠️ Potential issue | 🟡 Minor

Add a Next Steps section at the end of the page.

New docs pages in docs/ require a bottom Next Steps section linking related pages.

Suggested edit
 ## Common Mistakes
 
 - Do not use `nemoclaw <sandbox> skill install` for OpenClaw plugins. That
   command only installs `SKILL.md` agent skills.
 - Do not put a Dockerfile in a broad directory such as `/tmp` unless you intend
   to send that whole directory as the Docker build context.
 - Keep plugin dependencies in the build stage or plugin directory; avoid copying
   unrelated host files into the sandbox image.
+
+## Next Steps
+
+- Review [Network Policies](../reference/network-policies.md) to plan plugin egress safely.
+- Follow [Customize Network Policy](../network-policy/customize-network-policy.md) to tailor presets.
+- Return to [Deploy to a Remote GPU Instance](deploy-to-remote-gpu.md) for remote-host workflows.
As per coding guidelines: "A 'Next Steps' section at the bottom links to related pages."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/deployment/install-openclaw-plugins.md` around lines 89 - 97, Add a
"Next Steps" section at the end of the "Install OpenClaw plugins" doc (right
after the existing "Common Mistakes" section) titled "Next Steps" and include
bulleted links to related documentation pages such as "Deployment overview",
"Plugin development", and "Sandbox guidelines" so readers can continue to
relevant topics; ensure the links use the same relative link format as other
docs pages and include one-sentence context for each link.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/deployment/install-openclaw-plugins.md`:
- Around line 49-50: Add a one-sentence intro under each H2/H3 header before its
code block or list: specifically insert a brief explanatory sentence immediately
under the "Example Dockerfile", "Create the Sandbox", and "Common Mistakes"
headings so the reader gets context before the Dockerfile, sandbox onboarding
commands, and the list of pitfalls; apply the same pattern to the other H2/H3
sections called out in the review so every section begins with a short
introductory sentence before any code or list content.

---

Outside diff comments:
In `@docs/deployment/install-openclaw-plugins.md`:
- Around line 89-97: Add a "Next Steps" section at the end of the "Install
OpenClaw plugins" doc (right after the existing "Common Mistakes" section)
titled "Next Steps" and include bulleted links to related documentation pages
such as "Deployment overview", "Plugin development", and "Sandbox guidelines" so
readers can continue to relevant topics; ensure the links use the same relative
link format as other docs pages and include one-sentence context for each link.
🪄 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: f6eac7a9-fe4f-44d1-b310-13852b2dc0b5

📥 Commits

Reviewing files that changed from the base of the PR and between 0b49851 and 1221d01.

📒 Files selected for processing (5)
  • .agents/skills/nemoclaw-user-deploy-remote/SKILL.md
  • .agents/skills/nemoclaw-user-reference/references/commands.md
  • docs/deployment/install-openclaw-plugins.md
  • docs/index.md
  • docs/reference/commands.md

Comment thread docs/deployment/install-openclaw-plugins.md
@wscurran wscurran added documentation integration: openclaw OpenClaw integration behavior labels Apr 28, 2026
Fixes NVIDIA#2538

Signed-off-by: Deepak Jain <deepujain@gmail.com>
@deepujain
deepujain force-pushed the docs/2538-openclaw-plugins branch from 1221d01 to 7f7d4e2 Compare April 28, 2026 16:34
@deepujain

Copy link
Copy Markdown
Contributor Author

Rebased on latest main. Added the requested section intros and Next Steps footer, then regenerated the user skill docs. npm run build:cli and npm test -- test/skills-frontmatter.test.ts pass.

@cv
cv merged commit 5dc324f into NVIDIA:main Apr 28, 2026
13 checks passed
cv added a commit that referenced this pull request Apr 28, 2026
## Summary
NemoClaw docs did not explain how OpenClaw plugins should be installed
under NemoClaw. This adds a deployment guide that points plugin users to
the supported custom-sandbox-image path.

## Changes
- Add an OpenClaw plugin install guide with a build-directory layout and
Dockerfile example.
- Link the guide from the docs deployment index.
- Add a note under `skill install` that OpenClaw plugins are different
from SKILL.md agent skills.
- Regenerate the generated `nemoclaw-user` skills content.

## Testing
- `python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix
nemoclaw-user` passed.
- `npm test -- test/skills-frontmatter.test.ts` passed: 38 tests.
- `npm run build:cli` passed.
- `npx prettier --check docs/deployment/install-openclaw-plugins.md
docs/index.md docs/reference/commands.md
.agents/skills/nemoclaw-user-deploy-remote/SKILL.md
.agents/skills/nemoclaw-user-reference/references/commands.md` passed.
- Full `npm test -- --reporter=dot` was attempted. In this local
checkout it still fails in unrelated installer/uninstall/onboard tests
and generated-dist lookup paths.

## Evidence it works
The docs generator picked up the new plugin install page and updated the
generated deployment skill content.

Fixes #2538

Signed-off-by: Deepak Jain <deepujain@gmail.com>


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Added comprehensive OpenClaw plugins deployment guide with
Dockerfile-based preparation, build and onboarding workflow,
configuration notes, and troubleshooting.
* Clarified that OpenClaw plugins are distinct from agent skills and
require a separate installation process; updated command reference links
accordingly.
* Updated documentation navigation and renumbered onboarding steps to
account for the new plugin content.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Deepak Jain <deepujain@gmail.com>
Co-authored-by: Carlos Villela <cvillela@nvidia.com>
DemianHeyGen pushed a commit to DemianHeyGen/NemoClaw that referenced this pull request Apr 30, 2026
)

## Summary
NemoClaw docs did not explain how OpenClaw plugins should be installed
under NemoClaw. This adds a deployment guide that points plugin users to
the supported custom-sandbox-image path.

## Changes
- Add an OpenClaw plugin install guide with a build-directory layout and
Dockerfile example.
- Link the guide from the docs deployment index.
- Add a note under `skill install` that OpenClaw plugins are different
from SKILL.md agent skills.
- Regenerate the generated `nemoclaw-user` skills content.

## Testing
- `python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix
nemoclaw-user` passed.
- `npm test -- test/skills-frontmatter.test.ts` passed: 38 tests.
- `npm run build:cli` passed.
- `npx prettier --check docs/deployment/install-openclaw-plugins.md
docs/index.md docs/reference/commands.md
.agents/skills/nemoclaw-user-deploy-remote/SKILL.md
.agents/skills/nemoclaw-user-reference/references/commands.md` passed.
- Full `npm test -- --reporter=dot` was attempted. In this local
checkout it still fails in unrelated installer/uninstall/onboard tests
and generated-dist lookup paths.

## Evidence it works
The docs generator picked up the new plugin install page and updated the
generated deployment skill content.

Fixes NVIDIA#2538

Signed-off-by: Deepak Jain <deepujain@gmail.com>


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Added comprehensive OpenClaw plugins deployment guide with
Dockerfile-based preparation, build and onboarding workflow,
configuration notes, and troubleshooting.
* Clarified that OpenClaw plugins are distinct from agent skills and
require a separate installation process; updated command reference links
accordingly.
* Updated documentation navigation and renumbered onboarding steps to
account for the new plugin content.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Deepak Jain <deepujain@gmail.com>
Co-authored-by: Carlos Villela <cvillela@nvidia.com>
@wscurran wscurran added area: cli Command line interface, flags, terminal UX, or output area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance and removed NemoClaw CLI labels Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: cli Command line interface, flags, terminal UX, or output area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance integration: openclaw OpenClaw integration behavior

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add docs for installing OpenClaw plugins under NemoClaw — currently zero mention of 'plugin' in CLI help or CLAUDE.md

3 participants