-
Notifications
You must be signed in to change notification settings - Fork 3.1k
docs: split starter prompt platform instructions #7061
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
a245a75
docs: split starter prompt platform instructions
miyoungc 15468e1
docs: align express prompts with installer defaults
sandl99 2a7a890
docs: improve starter prompt platform detection
sandl99 c8778b0
docs: use main prompt asset links
sandl99 143b050
Merge branch 'main' into codex/split-starter-prompt-assets
sandl99 e2dffc1
docs: restore station express safeguards
sandl99 91594b9
docs: pin express prompt assets
sandl99 f515f79
docs: address express prompt review
sandl99 c96d984
docs: align Station Express with lkg model
sandl99 7953cac
docs: repin platform prompt assets
sandl99 a068500
docs: correct Station DeepSeek install guidance
apurvvkumaria cf8c378
docs: repin platform prompt assets
apurvvkumaria 3f04330
docs: clarify Station readiness consent
apurvvkumaria 96daed6
docs: repin platform prompt assets
apurvvkumaria f3682a5
docs(station): disclose verify container effects
apurvvkumaria d1ed744
docs(station): repin prompt assets
apurvvkumaria 3a8554f
test(docs): verify pinned prompt asset blobs
apurvvkumaria f2640c5
test(docs): keep prompt asset helpers out of test body
ericksoa d496ee0
Merge branch 'main' into codex/split-starter-prompt-assets
ericksoa File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| --> | ||
|
|
||
| # DGX Spark Express Instructions | ||
|
|
||
| Use these instructions only after hardware detection confirms DGX Spark. | ||
|
|
||
| Explain that Express keeps the selected agent, uses local vLLM with the default Qwen model, leaves optional setup at its defaults, and downloads the vLLM container and model. | ||
| Include the third-party-software notice, then ask: "Run Express install with these settings?" | ||
| Choices: | ||
|
|
||
| 1. Yes, use the DGX Spark Express defaults. | ||
| 2. No, let me choose the runtime and model. | ||
|
|
||
| If Express is selected: | ||
|
|
||
| - Set `NEMOCLAW_PROVIDER=install-vllm`. | ||
| - Leave `NEMOCLAW_VLLM_MODEL` and `NEMOCLAW_MODEL` unset so the installed release selects its DGX Spark default, currently `nvidia/Qwen3.6-35B-A3B-NVFP4`. | ||
| - Set `NEMOCLAW_AGENT` to the agent already selected in the starter prompt. | ||
| - Set `NEMOCLAW_NON_INTERACTIVE=1`, `NEMOCLAW_NON_INTERACTIVE_SUDO_MODE=prompt`, `NEMOCLAW_YES=1`, and `NEMOCLAW_POLICY_MODE=suggested`. | ||
| - Set `NEMOCLAW_ACCEPT_THIRD_PARTY_SOFTWARE=1` when Express is accepted. | ||
| - Leave `NEMOCLAW_SANDBOX_NAME`, `NEMOCLAW_POLICY_TIER`, web-search settings, and messaging settings unset so the installer applies the remaining Express defaults. | ||
| - Treat the Express confirmation as approval for the disclosed notice, downloads, and installation, and skip the later final-permission prompt. | ||
| - Do not ask again for the agent or ask separate questions for model, sandbox name, web search, messaging, policy, download approval, or final installation approval. | ||
| - After installation, report the model selected by the installed release. | ||
|
|
||
| If Express is declined, continue with the normal provider selection. | ||
| Offer existing vLLM when a ready server is detected, managed vLLM, supported local Ollama, and every hosted or compatible provider supported by the selected agent. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| --> | ||
|
|
||
| # DGX Station DeepSeek Instructions | ||
|
|
||
| Use these instructions only after hardware detection confirms DGX Station. | ||
|
|
||
| The provider-preseeded DeepSeek path below is not the installer Express path and is allowed only on an already-prepared DGX Station. | ||
|
|
||
| Before asking for consent, explain all of these boundaries: | ||
|
|
||
| - The official `--station-deepseek` installer flow may install or change NVIDIA open driver `610.43.02`, Docker CE `29.6.1` with Buildx, NVIDIA Container Toolkit `1.19.1`, and the reviewed factory `dkms` transition from `3.0.11-1ubuntu13` to `1:3.4.0-1ubuntu1`. | ||
| - Official Station preparation may add the trusted local account to the `docker` group, which grants root-equivalent control and is suitable only for a trusted single-user development host. | ||
| - Official Station preparation may require an operator-controlled reboot and resumes only with the exact accepted NemoClaw revision. | ||
| - Both Station paths may install Node.js and the NemoClaw CLI, download a pinned vLLM container and DeepSeek V4 Flash model data, require enough space on the model-cache filesystem and Docker storage, and create a sandbox with suggested policy defaults. | ||
| - DGX Station remains an evaluation path with deferred end-to-end validation on physical hardware, so startup may still fail after readiness checks. | ||
|
|
||
| Both `--check` and `--verify` are non-repairing readiness modes, and neither applies host repairs. | ||
| `--verify` requires the pinned acceptance image to already be present locally and fails if the image is missing; it does not pull the image. | ||
| `--verify` is not read-only: it starts short-lived GPU test containers through both CDI (`nvidia.com/gpu=all`) and Docker `--gpus all`, consumes GPU and temporary Docker storage, and may create Docker state and logs. | ||
|
|
||
| Ask permission to run the selected maintained release's `scripts/prepare-dgx-station-host.sh --check` and `scripts/prepare-dgx-station-host.sh --verify` readiness modes. | ||
| Treat the host as prepared only when both modes succeed and confirm the exact Station GB300 platform, generic Ubuntu 24.04 ARM64 image, pinned driver and package versions, packaged CDI lifecycle, `nvidia.com/gpu=all`, and real CDI and `--gpus all` container access. | ||
|
|
||
| If either readiness mode fails, reports a mismatch, is unavailable, or has an inconclusive outcome: | ||
|
|
||
| - Do not set `NEMOCLAW_PROVIDER`, `NEMOCLAW_VLLM_MODEL`, `NEMOCLAW_MODEL`, `NEMOCLAW_NON_INTERACTIVE`, `NEMOCLAW_YES`, or `NEMOCLAW_ACCEPT_THIRD_PARTY_SOFTWARE`. | ||
| - Explain that the only supported next step is the official installer with `--station-deepseek`, which owns pinned Station preparation and exact-revision reboot resume, then ask permission to start it. | ||
| - Let the official installer present its third-party-software notice and complete confirmation summary. | ||
| - Keep the official confirmation visible as the single active question, wait for the user's response, and do not pre-answer or suppress it. | ||
| - If a secure interactive terminal is unavailable, stop instead of falling back to the provider-preseeded path. | ||
|
|
||
| If and only if both readiness modes succeed, explain that the prepared-host path skips Station host preparation, uses DeepSeek V4 Flash in vLLM, and downloads the pinned vLLM container and model data. | ||
| Include the third-party-software notice, then ask: "Run the prepared-host DeepSeek install with these settings?" | ||
| Choices: | ||
|
|
||
| 1. Yes, use the prepared-host DeepSeek defaults. | ||
| 2. No, let me choose the runtime and model. | ||
|
|
||
| If the prepared-host DeepSeek path is selected: | ||
|
|
||
| - Set `NEMOCLAW_PROVIDER=install-vllm`. | ||
| - Set `NEMOCLAW_VLLM_MODEL=deepseek-v4-flash` and `NEMOCLAW_MODEL=deepseek-ai/DeepSeek-V4-Flash`. | ||
| - Set `NEMOCLAW_AGENT` to the agent already selected in the starter prompt. | ||
| - Set `NEMOCLAW_NON_INTERACTIVE=1`, `NEMOCLAW_NON_INTERACTIVE_SUDO_MODE=prompt`, `NEMOCLAW_YES=1`, and `NEMOCLAW_POLICY_MODE=suggested`. | ||
| - Set `NEMOCLAW_ACCEPT_THIRD_PARTY_SOFTWARE=1` when the prepared-host DeepSeek path is accepted. | ||
| - Leave `NEMOCLAW_SANDBOX_NAME`, `NEMOCLAW_POLICY_TIER`, web-search settings, and messaging settings unset so the installer applies the remaining maintained defaults. | ||
| - Treat the prepared-host confirmation as approval for the disclosed downloads, sandbox creation, and installation, and skip the later final-permission prompt. | ||
| - Do not ask again for the agent or ask separate questions for model, sandbox name, web search, messaging, policy, download approval, or final installation approval. | ||
|
|
||
| If the prepared-host DeepSeek path is declined, continue with the normal provider selection. | ||
| Offer existing vLLM when a ready server is detected, managed vLLM, supported local Ollama, and every hosted or compatible provider supported by the selected agent. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <!-- | ||
| SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| --> | ||
|
|
||
| # Windows WSL Express Instructions | ||
|
|
||
| Use these instructions only after official detection identifies Windows WSL. | ||
|
|
||
| Offer the maintained Windows Express path before the normal provider menu. | ||
| Explain that Express keeps the selected agent, uses Windows-host Ollama with its memory-aware default model, leaves optional setup at its defaults, and installs or starts Ollama and downloads the model when needed. | ||
| Include the third-party-software notice, then ask: "Run Express install with these settings?" | ||
| Choices: | ||
|
|
||
| 1. Yes, use the Windows WSL Express defaults. | ||
| 2. No, let me choose the runtime and model. | ||
|
|
||
| If Express is selected: | ||
|
|
||
| - Set `NEMOCLAW_PROVIDER=install-windows-ollama`. | ||
| - Leave `NEMOCLAW_MODEL` unset so the installed release chooses its memory-aware Ollama model. | ||
| - Set `NEMOCLAW_AGENT` to the agent already selected in the starter prompt. | ||
| - Set `NEMOCLAW_NON_INTERACTIVE=1`, `NEMOCLAW_NON_INTERACTIVE_SUDO_MODE=prompt`, `NEMOCLAW_YES=1`, and `NEMOCLAW_POLICY_MODE=suggested`. | ||
| - Set `NEMOCLAW_ACCEPT_THIRD_PARTY_SOFTWARE=1` when Express is accepted. | ||
| - Leave `NEMOCLAW_SANDBOX_NAME`, `NEMOCLAW_POLICY_TIER`, web-search settings, and messaging settings unset so the installer applies the remaining Express defaults. | ||
| - Treat the Express confirmation as approval for the disclosed notice, downloads, and installation, and skip the later final-permission prompt. | ||
| - Do not ask again for the agent or ask separate questions for model, sandbox name, web search, messaging, policy, download approval, or final installation approval. | ||
| - Do not start a second Ollama service on the same port. | ||
|
|
||
| If Express is declined, continue with the normal provider selection and offer every provider supported by the selected agent on Windows WSL. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.