Skip to content

docs(network-policy): start remote TUI without a source-checkout env step - #8481

Merged
apurvvkumaria merged 2 commits into
NVIDIA:mainfrom
JulienAu:docs/remote-tui-env-step
Aug 7, 2026
Merged

docs(network-policy): start remote TUI without a source-checkout env step#8481
apurvvkumaria merged 2 commits into
NVIDIA:mainfrom
JulienAu:docs/remote-tui-env-step

Conversation

@JulienAu

@JulienAu JulienAu commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Summary

The Remote Sandbox tab of the network request approval page told users to run cd ~/nemoclaw and . .env before openshell term. A standard public-installer setup has no source checkout and no .env file, so the chained procedure stopped at bash: .env: No such file or directory and never launched the TUI. The remote instructions now start the TUI directly with openshell term, matching the Local Sandbox tab.

Related Issue

Fixes #8464

Changes

  • docs/network-policy/approve-network-requests.mdx: remove the cd ~/nemoclaw and . .env steps from the Remote Sandbox tab and adjust the lead-in sentence. The later walkthrough section already covers the source-checkout case separately.

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)

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior — justification:
  • Tests not applicable — justification: prose and command sample change in one documentation page, no code behavior involved.
  • Docs updated for user-facing behavior changes
  • Docs not applicable — justification:
  • Sensitive paths changed (security, policy, credentials, preflight, onboarding, inference, runner, sandbox, or messaging)
  • Sensitive-path review completed or maintainer-approved waiver recorded — reviewer/approval link/justification: Maintainer nine-category review PASS; documentation-only correction with no runtime policy, permission, or trust-boundary change.
  • Non-success, skipped, or missing CI check accepted by maintainer — check name, approval link, and follow-up issue:

Documentation Writer Review

  • Documentation writer subagent reviewed the completed changes
  • Result: docs-updated
  • Evidence: docs/network-policy/approve-network-requests.mdx; full-page review against installer behavior, CLI reference, monitoring guide, service startup output, agent variants, and documentation conventions passed with no findings.
  • Agent: Codex independent documentation reviewer

Signed-off-by: JulienAu 16043912+JulienAu@users.noreply.github.com

Summary by CodeRabbit

  • Documentation
    • Updated remote sandbox instructions to launch the terminal interface directly on the remote host.
    • Removed unnecessary steps for changing directories and sourcing environment variables.

…step

The Remote Sandbox tab told users to run `cd ~/nemoclaw` and `. .env` before
`openshell term`, but a public-installer setup has no source checkout and no
`.env` file, so the chained command stopped before the TUI launched. Start the
TUI directly with `openshell term`, matching the Local Sandbox tab.

Signed-off-by: JulienAu <16043912+JulienAu@users.noreply.github.com>
@copy-pr-bot

copy-pr-bot Bot commented Aug 6, 2026

Copy link
Copy Markdown

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

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The remote sandbox instructions now start the OpenShell TUI directly. They no longer require changing to ~/nemoclaw or sourcing .env.

Changes

Remote network approval documentation

Layer / File(s) Summary
Direct remote TUI startup
docs/network-policy/approve-network-requests.mdx
The remote-host walkthrough removes the cd ~/nemoclaw and . .env commands before openshell term.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested labels: area: docs, v0.0.103

Suggested reviewers: cv, aasthajh

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The change removes the failing checkout and .env steps and starts the remote TUI with openshell term, meeting issue #8464.
Out of Scope Changes check ✅ Passed The changes are limited to the documented remote TUI command flow and align with issue #8464.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main documentation change: starting the remote TUI without the source-checkout environment step.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Signed-off-by: Apurv Kumaria <akumaria@nvidia.com>
@apurvvkumaria

Copy link
Copy Markdown
Collaborator

Maintainer update for the current branch revision:

  • Audited the remote instructions against the public installer, CLI reference, monitoring guide, and service startup output. After connecting to the sandbox host, running openshell term directly is the supported flow; a NemoClaw source checkout and .env are not required for the TUI.
  • Integrated current main without changing the contributor's effective documentation fix.
  • All review threads are clear, and CodeRabbit reported no actionable findings.
  • Strict documentation validation passed with 0 errors and 2 existing warnings. The network-policy published-route contract passed 9/9, and all applicable repository hooks passed.
  • Independent documentation review passed with no findings. The prerequisites, remote-host scope, all agent variants, and the separate source-checkout walkthrough remain accurate.
  • Security review: secrets/credentials PASS (the incorrect .env sourcing is removed); input validation N/A; authentication/authorization N/A; dependencies N/A; error handling/logging N/A; cryptography N/A; runtime configuration PASS (no policy or runtime configuration changes); tests/validation PASS; holistic review PASS (no permissions or trust boundaries are broadened).
  • Both commits retain DCO signoffs and are reported as Verified by GitHub.

The failed advisor jobs are infrastructure failures: GitHub Actions returned service-unavailable errors while resolving actions, and the publisher consequently had no artifact to download. I did not rerun those failures. Fresh checks are queued during the ongoing Actions outage.

No product or architecture decision is required. This PR remains unmerged until repository checks recover and pass and an independent approval is present.

@apurvvkumaria

Copy link
Copy Markdown
Collaborator

Independent current-branch readiness review: PASS, no required fixes.

  • The remote instruction matches the canonical CLI contract: SSH to the sandbox host and run openshell term there. A source checkout and .env file are not required.
  • The public installer installs OpenShell on the host path or configures the user-local binary path for later shells.
  • Removing . .env improves security by avoiding execution of checkout-provided shell content and loading of unrelated environment values.
  • Documentation validation passes with 0 errors, the 2 existing repository warnings, synchronized agent variants, and all 67 guarded routes.
  • Repository markdown lint and diff checks pass. The previously observed lint locations near the later walkthrough are unchanged base content whose line numbers shifted after this two-line deletion.
  • Both commits are GitHub Verified, DCO is present, and there are zero review threads.

The remaining blockers are independent approval and hosted workflows queued during the GitHub Actions outage. I am not creating duplicate reruns while the incident remains active.

@apurvvkumaria apurvvkumaria left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approve — the current branch revision correctly removes source-checkout-only setup from the ordinary remote TUI path while preserving that setup in the separate walkthrough section. The full page remains internally consistent, the command now matches the local-host path and public-installer environment, the documentation and security reviews are current, both commits are Verified with DCO declarations, and there are no unresolved review threads. The isolated worktree lacks installed documentation tooling, so the protected hosted documentation result remains required before merge; the recorded current-revision documentation build passed with zero errors.

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

PR Review Advisor — No blocking findings reported

Advisor assessment: No blocking advisor findings reported
Next action: No advisor follow-up needed.
Findings: 0 blockers · 0 warnings · 0 suggestions

Model lanes

  • GPT-5.6 Terra (primary): Completed · high confidence · 0 blockers · 0 warnings · 0 suggestions
  • Nemotron 3 Ultra (second opinion): Failed

Second-opinion terminology and E2E selections are advisory. Live E2E does not run automatically for pull requests.

1 semantic terminology decision

Terminology decisions are advisory. They affect the assessment only when a separate finding identifies concrete semantic impact.

  • established — TUI at docs/network-policy/approve-network-requests.mdx:47: Keep `TUI`; it is the repository-controlled term for a terminal user interface.

E2E guidance

Advisory only. A maintainer can dispatch the default E2E suite against this exact revision.

Recommended E2E: None

Workflow run details

This automated review informs maintainers. Warnings and suggestions do not require a response. A maintainer decides whether to merge.

@apurvvkumaria
apurvvkumaria merged commit 14cf9a4 into NVIDIA:main Aug 7, 2026
25 of 27 checks passed
@cjagwani cjagwani mentioned this pull request Aug 7, 2026
23 tasks
cjagwani added a commit that referenced this pull request Aug 7, 2026
<!-- markdownlint-disable MD041 -->
## Summary

Adds the canonical dated changelog entry required before cutting
`v0.0.104`.
The entry reconciles user-facing changes merged from `v0.0.103` through
`8d2b86aaf44968b4f7bc3b714222a73bd28e0403` while excluding hidden and
experimental product surfaces.

## Changes

- Added `docs/changelog/2026-08-06.mdx` with the exact `## v0.0.104`
heading and release themes for local inference, private endpoints,
network policy, state authority, lifecycle recovery, uninstall, Hermes,
MCP diagnostics, credential safety, and installation guidance.
- Source summary links:
- [#8399](#8399) ->
`docs/changelog/2026-08-06.mdx`: fixed DGX Spark local serving profiles.
- [#8418](#8418) ->
`docs/changelog/2026-08-06.mdx`: durable llama.cpp lifecycle management.
- [#8422](#8422) ->
`docs/changelog/2026-08-06.mdx`: recoverable llama.cpp receipt
publication.
- [#8402](#8402) ->
`docs/changelog/2026-08-06.mdx`: remediable DGX Spark storage admission.
- [#8391](#8391) ->
`docs/changelog/2026-08-06.mdx`: host-local serving recipe contracts.
- [#8401](#8401) ->
`docs/changelog/2026-08-06.mdx`: serving profile lifecycle provenance.
- [#8322](#8322) ->
`docs/changelog/2026-08-06.mdx`: guarded llama.cpp route compatibility.
- [#8272](#8272) ->
`docs/changelog/2026-08-06.mdx`: explicitly trusted private endpoints
with stable policy pins and CA trust.
- [#8431](#8431) ->
`docs/changelog/2026-08-06.mdx`: Personal onboarding policy tier and its
trust boundary.
- [#8143](#8143) ->
`docs/changelog/2026-08-06.mdx`: manifest-derived state authority.
- [#7859](#7859) ->
`docs/changelog/2026-08-06.mdx`: side-effect-free lifecycle lock
timeouts.
- [#8262](#8262) ->
`docs/changelog/2026-08-06.mdx`: managed gateway lease waiting.
- [#8339](#8339) ->
`docs/changelog/2026-08-06.mdx`: continued journaled rebuild recreation.
- [#8373](#8373) ->
`docs/changelog/2026-08-06.mdx`: restore readiness after compatibility
decisions.
- [#8443](#8443) ->
`docs/changelog/2026-08-06.mdx`: fail-closed malformed registry
handling.
- [#8419](#8419) ->
`docs/changelog/2026-08-06.mdx`: bounded recovery for a gateway that
never served.
- [#8486](#8486) ->
`docs/changelog/2026-08-06.mdx`: target-scoped registry recovery.
- [#8259](#8259) ->
`docs/changelog/2026-08-06.mdx`: scoped uninstall ordering and retry
safety.
- [#8457](#8457) ->
`docs/changelog/2026-08-06.mdx`: desktop metadata exclusion during
uninstall.
- [#8026](#8026) ->
`docs/changelog/2026-08-06.mdx`: typed Hermes configuration policy.
- [#8242](#8242) ->
`docs/changelog/2026-08-06.mdx`: Hermes WhatsApp session diagnostics.
- [#8344](#8344) ->
`docs/changelog/2026-08-06.mdx`: patched Hermes image and dependency
checks.
- [#8491](#8491) ->
`docs/changelog/2026-08-06.mdx`: bounded MCP discovery timeout.
- [#8490](#8490) ->
`docs/changelog/2026-08-06.mdx`: MCP shadow diagnostics.
- [#7619](#7619) ->
`docs/changelog/2026-08-06.mdx`: web-search credential isolation.
- [#8476](#8476) ->
`docs/changelog/2026-08-06.mdx`: stable preflight advisory identifiers.
- [#8452](#8452) ->
`docs/changelog/2026-08-06.mdx`: user-local CLI resolution.
- [#8481](#8481) ->
`docs/changelog/2026-08-06.mdx`: remote network-policy terminal
guidance.
- Product-scope exclusions:
[#8429](#8429) remains
experimental; [#8261](#8261)
remains feature-gated; and portable-profile changes
[#8408](#8408),
[#8415](#8415),
[#8446](#8446),
[#8458](#8458),
[#8462](#8462), and
[#8506](#8506) are not promoted
as supported product surfaces.

## 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)

## Quality Gates

- [ ] Tests added or updated for changed behavior
- [x] Existing tests cover changed behavior — justification: `npx vitest
run test/changelog-docs.test.ts` passed 6/6 and validates dated
changelog structure and published links.
- [ ] Tests not applicable — justification:
- [x] Docs updated for user-facing behavior changes
- [ ] Docs not applicable — justification:
- [ ] Sensitive paths changed (security, policy, credentials, preflight,
onboarding, inference, runner, sandbox, or messaging)
- [ ] Sensitive-path review completed or maintainer-approved waiver
recorded — reviewer/approval link/justification:
- [ ] Non-success, skipped, or missing CI check accepted by maintainer —
check name, approval link, and follow-up issue:

## Documentation Writer Review

- [x] Documentation writer subagent reviewed the completed changes
- Result: `docs-updated`
- Evidence: `docs/changelog/2026-08-06.mdx`; release-range scope,
writing rules, documentation style, skip terms, exact names,
threat-boundary wording, and published routes reviewed; changelog tests
and docs build passed.
- Agent: Codex Desktop
<!-- docs-review-head-sha: 02b51ae -->
<!-- docs-review-agents-blob-sha: c69aad4 -->

## DGX Station Hardware Evidence

- [ ] Tested on DGX Station
- Tested commit: Not applicable; no DGX Station host preparation script
changed.
- Station profile/scenario: Not applicable.
- Result: Not applicable.
- Supporting evidence: Not applicable.

## Verification

- [x] PR description includes a `Signed-off-by:` line and every commit
appears as `Verified` in GitHub
- [x] Normal `pre-commit`, `commit-msg`, and `pre-push` hooks passed, or
`npm run validate:pr` passed after refreshing `origin/main` when hooks
were skipped or unavailable
- [x] Targeted behavior tests pass for the current change set, or tests
are marked not applicable above — command/result or justification: `npx
vitest run test/changelog-docs.test.ts` passed 6/6.
- [ ] Applicable broad gate passed — `npm test` for broad
runtime/test-harness changes; `npm run check` for repo-wide
validation/coverage changes — command/result: Not applicable to a single
changelog entry.
- [x] Quality Gates section completed with required justifications or
waivers
- [x] No secrets, API keys, or credentials committed
- [x] `npm run docs` builds without warnings (doc changes only)
- [x] Doc pages follow the [style
guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md)
(doc changes only)
- [ ] New doc pages include SPDX header and frontmatter (new pages only)

The new dated changelog file includes the required parser-safe SPDX
header and intentionally has no frontmatter, matching the changelog
contract and existing entries.

---
Signed-off-by: Charan Jagwani <cjagwani@nvidia.com>


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

## Summary by CodeRabbit

* **Documentation**
  * Added release notes for v0.0.104.
* Documented fixes for local model runtimes, private endpoints, network
policies, state recovery, uninstall behavior, safety updates, MCP
diagnostics, credential isolation, and installation guidance.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Ubuntu 24.04][Docs] Remote network approval instructions stop before OpenShell TUI starts

2 participants