Skip to content

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

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

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 wscurran added documentation Improvements or additions to documentation fix labels May 11, 2026
@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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation fix

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants