docs(reference): document remote-deploy env vars (closes #3059)#4166
docs(reference): document remote-deploy env vars (closes #3059)#4166latenighthackathon wants to merge 1 commit into
Conversation
|
Caution Review failedFailed to post review comments 📝 WalkthroughWalkthroughDocs-only changes: clarifies ChangesNemoClaw CLI Reference & Generated Skill Reference
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
✨ Thanks for submitting this detailed PR about documenting remote-deploy environment variables. This proposes a way to improve the documentation by adding a 'Remote Deployment' subsection under Environment Variables in Related open PRs:
Related open issues: |
87239c8 to
35c265e
Compare
Add a "Remote Deployment" subsection under Environment Variables in `docs/reference/commands.mdx` covering the four env vars that seed defaults for `nemoclaw deploy` and `nemoclaw onboard --remote`: - `NEMOCLAW_BREV_PROVIDER` - `NEMOCLAW_GPU` - `NEMOCLAW_DEPLOY_NO_CONNECT` - `NEMOCLAW_DEPLOY_NO_START_SERVICES` Each entry covers the default, the effect, and notes that flag equivalents on `deploy` take precedence when non-interactive runs need to skip prompts. The provider/GPU pair cross-links to the existing `Deploy to Remote GPU` narrative for full how-to coverage. The mirror at `.agents/skills/nemoclaw-user-reference/references/commands.md` is regenerated by `scripts/docs-to-skills.py` so the skill stays in sync with the user-facing docs. This is a fresh recreation of the closed NVIDIA#3349. The original branch was opened against the legacy `.md` docs layout before the Fern MDX migration (NVIDIA#3837) and accumulated 10 commits of upstream churn on `commands.mdx`; rebuilt cleanly on top of current upstream/main as a single signed commit. Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
35c265e to
a64fad7
Compare
Summary
Add a "Remote Deployment" subsection under Environment Variables in
docs/reference/commands.mdxcovering the four env vars that seed defaults fornemoclaw deployandnemoclaw onboard --remote.Related Issue
Closes #3059.
Problem
The env-var reference table lists
NEMOCLAW_*flag defaults for many existing commands but omits the remote-deploy path. Discovering the seed-value env vars for a non-interactive Brev deployment currently requires reading source, since the docs say nothing about them.Changes
### Remote Deploymentsubsection just before## NemoHermes AliasdocumentingNEMOCLAW_BREV_PROVIDER(defaultgcp),NEMOCLAW_GPU(defaulta2-highgpu-1g:nvidia-tesla-a100:1),NEMOCLAW_DEPLOY_NO_CONNECT(unset;1skips post-deploy connect), andNEMOCLAW_DEPLOY_NO_START_SERVICES(unset;1skips service start).deploytake precedence so non-interactive runs can skip prompts.Deploy to Remote GPUnarrative for full how-to coverage..agents/skills/nemoclaw-user-reference/references/commands.mdviascripts/docs-to-skills.pyso the skill stays in sync with the user-facing docs.Type of Change
Verification
npx prek run --all-filespassesnpm testpassesnpm run docsbuilds without warnings (doc changes only)Ran:
python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --doc-platform fern-mdx --dry-runclean;markdownlint-cli2clean on both files. All pre-commit hooks pass except the pre-existingtsc-plugininfra failure innemoclaw/src/onboard/config.tsthat is also present on stockupstream/main.Note: this is a fresh recreation of the closed #3349. The original branch was opened against the legacy
.mddocs layout before the Fern MDX migration (#3837) and accumulated 10 commits of upstream churn oncommands.mdx. Rather than rebasing across that conflict surface, this rebuilds cleanly on top of currentupstream/main(8be998680) as a single signed commit.Signed-off-by: latenighthackathon latenighthackathon@users.noreply.github.com
Summary by CodeRabbit
channels addnow requires a matching network_policies preset, applies policy before rebuild, and documents rollback behavior for failed post-apply stepschannels add --dry-rundescription (validates name and policy preset without prompting, contacting gateway, or rebuilding)