Skip to content

docs(reference): document remote-deploy env vars#3349

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

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

Conversation

@latenighthackathon
Copy link
Copy Markdown
Contributor

@latenighthackathon latenighthackathon commented May 11, 2026

Summary

Adds a ### Remote Deployment subsection to the ## Environment Variables reference, documenting the four env vars that src/lib/deploy/index.ts reads for the nemoclaw deploy / nemoclaw onboard --remote flow. Follow-up to #3184: the env-var doc gate currently passes because these vars are accessed via a destructured env.NEMOCLAW_* local that the AST extractor does not flag, but the same users who hit the new gate-enforced sections also hit these deploy knobs and had no doc entry to find them.

Related Issue

Follow-up to #3184. Original umbrella issue #3059 was already substantively addressed by #3184; this PR closes the four remaining deploy-vars gaps from that audit.

Changes

  • docs/reference/commands.mdx: new ### Remote Deployment subsection between ### Lifecycle Behavior Flags and ## NemoHermes Alias. One table with four rows: NEMOCLAW_BREV_PROVIDER (default gcp), NEMOCLAW_GPU (default a2-highgpu-1g:nvidia-tesla-a100:1), NEMOCLAW_DEPLOY_NO_CONNECT, NEMOCLAW_DEPLOY_NO_START_SERVICES. Defaults verified against src/lib/deploy/index.ts:295-303.
  • .agents/skills/nemoclaw-user-reference/references/commands.md: same subsection added at the corresponding position to keep the auto-generated skill in sync.

Test plan

  • prek run clean
  • Defaults cross-checked against the current env.NEMOCLAW_* reads in src/lib/deploy/index.ts (the file moved from src/lib/deploy.ts to src/lib/deploy/index.ts upstream)

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

@copy-pr-bot
Copy link
Copy Markdown

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

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This PR adds a "Remote Deployment" subsection to environment variables, documenting four Brev-specific seed variables—NEMOCLAW_BREV_PROVIDER, NEMOCLAW_GPU, NEMOCLAW_DEPLOY_NO_CONNECT, and NEMOCLAW_DEPLOY_NO_START_SERVICES—used by nemoclaw deploy and nemoclaw onboard --remote.

Changes

Remote Deployment Environment Variables

Layer / File(s) Summary
Environment Variables Documentation
.agents/skills/nemoclaw-user-reference/references/commands.md, docs/reference/commands.md
Adds a "Remote Deployment" subsection documenting Brev/remote-deploy seed vars for nemoclaw deploy and nemoclaw onboard --remote, including defaults for NEMOCLAW_BREV_PROVIDER and NEMOCLAW_GPU, plus NEMOCLAW_DEPLOY_NO_CONNECT and NEMOCLAW_DEPLOY_NO_START_SERVICES to skip post-deploy connect and automatic service startup.

🎯 2 (Simple) | ⏱️ ~10 minutes

🐰 I hopped to the docs and left a sign,

Brev provider and GPU in tidy line,
Flags to skip connect or auto-start,
Now remote deploys follow the chart,
Quiet sandboxes boot on cloud-time.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding documentation for remote-deploy environment variables. It is concise, specific, and directly reflects the changeset which adds a 'Remote Deployment' subsection documenting four env vars.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ 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
Copy link
Copy Markdown
Contributor

✨ Thanks for submitting this detailed PR to document remote-deploy env vars. This change aims to improve the accuracy of the documentation by adding a new subsection for remote deployment environment variables.


Related open issues:

Add a `### Remote Deployment` subsection covering the four env vars read in
`src/lib/deploy.ts` for the `nemoclaw deploy` / `nemoclaw onboard --remote`
flow:

- `NEMOCLAW_BREV_PROVIDER` (default `gcp`)
- `NEMOCLAW_GPU` (default `a2-highgpu-1g:nvidia-tesla-a100:1`)
- `NEMOCLAW_DEPLOY_NO_CONNECT`
- `NEMOCLAW_DEPLOY_NO_START_SERVICES`

Each had a flag equivalent on `deploy` but no doc entry, so non-interactive
remote provisioning users could not discover them from the docs portal.
Defaults verified against `src/lib/deploy.ts:296-303`. Mirrored to the
nemoclaw-user-reference skill. Follow-up to NVIDIA#3184; the env-var doc-drift
gate still passes since these vars are read via a destructured
`env.NEMOCLAW_*` local that the AST extractor does not currently flag.

Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
@latenighthackathon
Copy link
Copy Markdown
Contributor Author

Closing in favor of #4166 which is rebuilt cleanly on current upstream/main with the same content. Cheers!

latenighthackathon added a commit to latenighthackathon/NemoClaw that referenced this pull request May 27, 2026
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 added a commit to latenighthackathon/NemoClaw that referenced this pull request May 31, 2026
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 added a commit to latenighthackathon/NemoClaw that referenced this pull request Jun 2, 2026
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 added a commit to latenighthackathon/NemoClaw that referenced this pull request Jun 2, 2026
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>
@wscurran wscurran added bug-fix PR fixes a bug or regression area: docs Documentation, examples, guides, or docs build and removed fix labels Jun 3, 2026
cv added a commit that referenced this pull request Jun 3, 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
- [x] Doc only (prose changes, no code sample modifications)
- [ ] Doc only (includes code sample changes)

## Verification
<!-- Check each item you ran and confirmed. Leave unchecked items you
skipped. -->
- [ ] `npx prek run --all-files` passes
- [ ] `npm test` passes
- [ ] Tests added or updated for new or changed behavior
- [x] No secrets, API keys, or credentials committed
- [x] Docs updated for user-facing behavior changes
- [ ] `npm run docs` builds without warnings (doc changes only)
- [x] 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>


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Added a Remote Deployment environment-variables section describing
Brev/GPU provisioning defaults (NEMOCLAW_BREV_PROVIDER, NEMOCLAW_GPU).
* Documented non-interactive deploy/onboard options and flags to skip
the post-deploy automatic connect and automatic service startup
(NEMOCLAW_DEPLOY_NO_CONNECT, NEMOCLAW_DEPLOY_NO_START_SERVICES).
  * Linked to the Deploy to Remote GPU guide for usage details.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
Co-authored-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
Co-authored-by: Carlos Villela <cvillela@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation, examples, guides, or docs build bug-fix PR fixes a bug or regression

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants