Skip to content

docs(reference): document remote-deploy env vars (closes #3059)#4166

Open
latenighthackathon wants to merge 1 commit into
NVIDIA:mainfrom
latenighthackathon:docs/3349-remote-deploy-env-vars-v2
Open

docs(reference): document remote-deploy env vars (closes #3059)#4166
latenighthackathon wants to merge 1 commit into
NVIDIA:mainfrom
latenighthackathon:docs/3349-remote-deploy-env-vars-v2

Conversation

@latenighthackathon
Copy link
Copy Markdown
Contributor

@latenighthackathon latenighthackathon commented May 25, 2026

Summary

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. 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 Deployment subsection just before ## NemoHermes Alias covering:

  • NEMOCLAW_BREV_PROVIDER (default gcp)
  • NEMOCLAW_GPU (default a2-highgpu-1g:nvidia-tesla-a100:1)
  • NEMOCLAW_DEPLOY_NO_CONNECT (unset; 1 skips post-deploy connect)
  • NEMOCLAW_DEPLOY_NO_START_SERVICES (unset; 1 skips service start)

Each entry covers the default, the effect, and notes that flag equivalents on deploy take precedence so non-interactive runs can 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.

Test plan

  • python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --doc-platform fern-mdx --dry-run clean.
  • markdownlint-cli2 clean on both files (the original PR landed a blank-line lint nit after a CodeRabbit pass; the fresh version is clean on first commit).
  • All pre-commit hooks pass except the pre-existing tsc-plugin infra failure in nemoclaw/src/onboard/config.ts that's present on stock upstream/main.

Note on supersession

This is a fresh recreation of the closed #3349. The original branch was opened against the legacy .md docs layout before the Fern MDX migration (#3837) and accumulated 10 commits of upstream churn on commands.mdx. Rather than rebasing across the conflict surface, rebuilt cleanly on top of current upstream/main (8be998680) as a single signed commit.

Signed-off-by: latenighthackathon latenighthackathon@users.noreply.github.com

Summary by CodeRabbit

  • Documentation
    • Clarified Ollama installation-mode env var: accepted values, auto-detection behavior, and rejected values
    • Added Remote Deployment env vars and defaults for non-interactive deploy/onboard flows, including options to skip post-deploy connect and control service start
    • Retained updates for resource, tunnel, and CLI command reference docs as previously listed

Review Change Stack

@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented May 25, 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 25, 2026

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: 0d43b2ae-9f5e-4d06-af52-05f61c91e314

📥 Commits

Reviewing files that changed from the base of the PR and between 47d1208 and 87239c8.

📒 Files selected for processing (2)
  • .agents/skills/nemoclaw-user-reference/references/commands.md
  • docs/reference/commands.mdx
✅ Files skipped from review due to trivial changes (2)
  • docs/reference/commands.mdx
  • .agents/skills/nemoclaw-user-reference/references/commands.md

📝 Walkthrough

Walkthrough

Updates 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.

Changes

NemoClaw CLI Reference Documentation

Layer / File(s) Summary
Refine NEMOCLAW_OLLAMA_INSTALL_MODE
.agents/skills/nemoclaw-user-reference/references/commands.md
Replaces the generic row with explicit system / user / empty behavior, describes auto-detection for root/passwordless-sudo vs interactive shells, and notes unsupported values are rejected.
Remote Deployment env vars (docs + skill sync)
docs/reference/commands.mdx, .agents/skills/nemoclaw-user-reference/references/commands.md
Adds a ### Remote Deployment subsection documenting NEMOCLAW_BREV_PROVIDER, NEMOCLAW_GPU, NEMOCLAW_DEPLOY_NO_CONNECT, and NEMOCLAW_DEPLOY_NO_START_SERVICES, and mirrors it in the auto-generated skill reference.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • ericksoa

Poem

🐰 A doc-update hop, a careful trace,
Clarified flags in their proper place,
Remote deploys now have their say,
Install modes sorted for the right display,
Hooray for clear guides in NemoClaw's space!

🚥 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 title 'docs(reference): document remote-deploy env vars (closes #3059)' clearly describes the main change: adding documentation for remote deployment environment variables to the reference section.
Linked Issues check ✅ Passed The PR successfully addresses both linked issues by documenting the four deploy-related environment variables (NEMOCLAW_BREV_PROVIDER, NEMOCLAW_GPU, NEMOCLAW_DEPLOY_NO_CONNECT, NEMOCLAW_DEPLOY_NO_START_SERVICES) in docs/reference/commands.mdx with defaults verified against source code, and keeping the auto-generated skill mirror in sync.
Out of Scope Changes check ✅ Passed All changes are directly in scope: documentation updates to reference/commands.mdx for remote deployment env vars and the corresponding auto-generated skill file, with no unrelated code modifications or scope creep.
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

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

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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

@wscurran wscurran added CI/CD Use this label to identify issues with NemoClaw CI/CD pipeline or GitHub Actions. documentation Improvements or additions to documentation fix labels May 26, 2026
@wscurran
Copy link
Copy Markdown
Contributor

✨ 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 docs/reference/commands.mdx, which covers the four env vars that seed defaults for nemoclaw deploy and nemoclaw onboard --remote.


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>
@latenighthackathon latenighthackathon force-pushed the docs/3349-remote-deploy-env-vars-v2 branch from 47d1208 to 87239c8 Compare May 27, 2026 03:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI/CD Use this label to identify issues with NemoClaw CI/CD pipeline or GitHub Actions. documentation Improvements or additions to documentation fix

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing proper reference of ALL environment variables

2 participants