Skip to content

docs(commands): document nemoclaw internal:* command family #3968

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
laitingsheng wants to merge 2 commits into from
+19 −0
Closed

docs(commands): document nemoclaw internal:* command family #3968

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4efdf9f
docs(commands): document nemoclaw internal:* command family (#3782)
laitingsheng May 21, 2026
f20f89e
docs(commands): correct internal:* caller mapping per Codex review
laitingsheng May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/reference/commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1123,6 +1123,25 @@ Use the hosted `curl … | bash` form only when the CLI is broken or already par
| **Robustness** | Requires the npm package to be discoverable so the CLI can find the local script. | Works even if the `nemoclaw` CLI is missing, broken, or partially uninstalled. |
| **Recommended for** | Routine uninstalls. | Recovery when the CLI is unavailable. |

## Internal Commands

NemoClaw registers a small family of `nemoclaw internal <topic> <action>` commands that wrapper scripts (`uninstall.sh`, `scripts/npm-link-or-shim.sh`, `scripts/fix-coredns.sh`, `scripts/setup-dns-proxy.sh`) invoke under the hood, plus a few internal planning and inspection helpers that mirror logic used elsewhere in the CLI.
They are intentionally omitted from `nemoclaw --help` via `static hidden = true` and are not part of the supported public CLI surface.
Their flags, output, and exit codes may change without notice between releases.
You should not invoke these directly; use the user-facing commands or wrapper scripts above instead.

| Command | Caller | Purpose |
|---|---|---|
| `nemoclaw internal dev npm-link-or-shim` | `scripts/npm-link-or-shim.sh` | Run `npm link`, falling back to a user-local NemoClaw development shim. |
| `nemoclaw internal dns fix-coredns` | `scripts/fix-coredns.sh` | Patch CoreDNS to use a non-loopback upstream resolver. |
| `nemoclaw internal dns setup-proxy` | `scripts/setup-dns-proxy.sh` | Configure the DNS forwarder bridge inside a sandbox pod. |
| `nemoclaw internal installer plan` | Internal planning helper | Build a deterministic installer plan from environment and probe inputs without applying it. Not currently invoked by `install.sh` (which has its own Bash equivalents); exposed for external tooling and inspection. |
| `nemoclaw internal installer resolve-release-tag` | Internal planning helper | Resolve the installer ref using the same precedence as `install.sh`. Not currently invoked by `install.sh`; exposed for external tooling and inspection. |
| `nemoclaw internal installer normalize-env` | Internal planning helper | Normalize installer ref and provider environment values without applying any installation changes. Not currently invoked by `install.sh`; exposed for external tooling and inspection. |
| `nemoclaw internal uninstall plan` | Internal inspection helper | Build a deterministic uninstall plan without applying it. The runtime path (`uninstall.sh` → `internal uninstall run-plan`) calls the underlying plan logic directly, not via this command. |
| `nemoclaw internal uninstall classify-shim` | Internal inspection helper | Classify whether a NemoClaw shim path is safe to remove. Called as a library function by `internal uninstall run-plan`, not via this command. |
| `nemoclaw internal uninstall run-plan` | `uninstall.sh` | Execute the host-side uninstall plan. |

## Environment Variables

NemoClaw reads the following environment variables to configure service ports, onboarding behavior, and lifecycle defaults.
Expand Down
Loading