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.

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

  • Add a ### Remote Deployment subsection just before ## NemoHermes Alias documenting 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), and 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.
  • Cross-link the provider/GPU pair to the existing Deploy to Remote GPU narrative for full how-to coverage.
  • Regenerate the mirror at .agents/skills/nemoclaw-user-reference/references/commands.md via scripts/docs-to-skills.py so the skill stays in sync with the user-facing docs.

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with doc updates
  • Doc only (prose changes, no code sample modifications)
  • Doc only (includes code sample changes)

Verification

  • npx prek run --all-files passes
  • npm test passes
  • Tests added or updated for new or changed behavior
  • No secrets, API keys, or credentials committed
  • Docs updated for user-facing behavior changes
  • npm run docs builds without warnings (doc changes only)
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

Ran: 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. All pre-commit hooks pass except the pre-existing tsc-plugin infra failure in nemoclaw/src/onboard/config.ts that is also present on stock upstream/main.

Note: 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 that conflict surface, this rebuilds 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
    • Added Remote Deployment env vars and non-interactive deploy/onboard defaults (skip connect, control service start)
    • Documented new Remote Deployment section and Brev/GPU provisioning defaults
    • channels add now requires a matching network_policies preset, applies policy before rebuild, and documents rollback behavior for failed post-apply steps
    • Tightened channels add --dry-run description (validates name and policy preset without prompting, contacting gateway, or rebuilding)
    • Updated env var docs: NEMOCLAW_ENDPOINT_URL (custom/Anthropic usage) and expanded NEMOCLAW_VLLM_MODEL list

@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

Review Change Stack

Caution

Review failed

Failed to post review comments

📝 Walkthrough

Walkthrough

Docs-only changes: clarifies nemoclaw <name> channels add behavior and --dry-run, generalizes endpoint and vLLM model docs, and adds a Remote Deployment env-var subsection mirrored into the generated CLI skill reference.

Changes

NemoClaw CLI Reference & Generated Skill Reference

Layer / File(s) Summary
channels add behavior & dry-run
.agents/skills/nemoclaw-user-reference/references/commands.md
Requires a built-in network_policies: preset YAML before prompts or registry writes, applies it prior to rebuild to enable upstream egress, documents rollback behavior for post-registry apply failures (fresh add vs re-add), and tightens --dry-run to validate name + preset without prompting, gateway contact, or rebuild.
Endpoint and vLLM model docs
.agents/skills/nemoclaw-user-reference/references/commands.md
Generalizes NEMOCLAW_ENDPOINT_URL for NEMOCLAW_PROVIDER=custom/Anthropic-compatible usage and expands NEMOCLAW_VLLM_MODEL allowlist by adding qwen3.6-35b-a3b-nvfp4.
Remote Deployment environment variables
docs/reference/commands.mdx, .agents/skills/nemoclaw-user-reference/references/commands.md
Adds a Remote Deployment subsection documenting NEMOCLAW_BREV_PROVIDER, NEMOCLAW_GPU as provisioning defaults, and NEMOCLAW_DEPLOY_NO_CONNECT / NEMOCLAW_DEPLOY_NO_START_SERVICES to control post-deploy connect and service startup; mirrored between primary and generated references.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • NVIDIA/NemoClaw#4625: Overlapping edits to docs/reference/commands.mdx affecting the NEMOCLAW_ENDPOINT_URL wording.
  • NVIDIA/NemoClaw#4618: Related generated CLI reference edits, including env var documentation overlaps.

Poem

🐰 I hopped through lines of docs tonight,
Clarified flags and set defaults right.
Channels, endpoints, models in view —
Remote deploys and GPU notes too.
🥕 Small changes, tidy and bright.

🚥 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 summarizes the main change—adding environment variable documentation for remote deployment.
Linked Issues check ✅ Passed The PR comprehensively addresses both linked issues #3059 and #3349 by documenting the four remote-deploy environment variables in the reference docs and keeping the auto-generated skill mirror in sync.
Out of Scope Changes check ✅ Passed All changes are scoped to documentation updates related to remote-deploy environment variables; no unrelated code modifications or out-of-scope changes are present.
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.

@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:

@latenighthackathon latenighthackathon force-pushed the docs/3349-remote-deploy-env-vars-v2 branch 2 times, most recently from 87239c8 to 35c265e Compare May 31, 2026 16:22
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 35c265e to a64fad7 Compare June 2, 2026 03:15
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