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
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughUpdates CLI reference docs: clarifies NEMOCLAW_OLLAMA_INSTALL_MODE behavior and adds a new "Remote Deployment" environment-variable section (NEMOCLAW_BREV_PROVIDER, NEMOCLAW_GPU, NEMOCLAW_DEPLOY_NO_CONNECT, NEMOCLAW_DEPLOY_NO_START_SERVICES) synchronized between the primary doc and the auto-generated skill reference. ChangesNemoClaw CLI Reference Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
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)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add 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: |
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>
47d1208 to
87239c8
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. Closes #3059.Problem
The env-var reference table currently lists
NEMOCLAW_*flag defaults for many existing commands but not the remote-deploy path. A user piecing together a non-interactive Brev deployment has to read source to discover the seed-value env vars; the docs say nothing.Fix
New
### Remote Deploymentsubsection just before## NemoHermes Aliascovering:NEMOCLAW_BREV_PROVIDER(defaultgcp)NEMOCLAW_GPU(defaulta2-highgpu-1g:nvidia-tesla-a100:1)NEMOCLAW_DEPLOY_NO_CONNECT(unset;1skips post-deploy connect)NEMOCLAW_DEPLOY_NO_START_SERVICES(unset;1skips service start)Each entry covers the default, the effect, and notes that flag equivalents on
deploytake precedence so non-interactive runs can skip prompts. The provider/GPU pair cross-links to the existingDeploy to Remote GPUnarrative for full how-to coverage.The mirror at
.agents/skills/nemoclaw-user-reference/references/commands.mdis regenerated byscripts/docs-to-skills.pyso the skill stays in sync with the user-facing docs.Test plan
python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --doc-platform fern-mdx --dry-runclean.markdownlint-cli2clean on both files (the original PR landed a blank-line lint nit after a CodeRabbit pass; the fresh version is clean on first commit).tsc-plugininfra failure innemoclaw/src/onboard/config.tsthat's present on stockupstream/main.Note on supersession
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 the conflict surface, rebuilt cleanly on top of currentupstream/main(8be998680) as a single signed commit.Signed-off-by: latenighthackathon latenighthackathon@users.noreply.github.com
Summary by CodeRabbit