Skip to content

fix: align docs with current CLI commands#38

Closed
TalhaSumra wants to merge 2 commits intoNVIDIA:mainfrom
TalhaSumra:docs/update-cli-docs
Closed

fix: align docs with current CLI commands#38
TalhaSumra wants to merge 2 commits intoNVIDIA:mainfrom
TalhaSumra:docs/update-cli-docs

Conversation

@TalhaSumra
Copy link
Copy Markdown

@TalhaSumra TalhaSumra commented Mar 16, 2026 •
edited
Loading

Summary

  • align the docs with the current CLI
  • replace removed nemoclaw term references with openshell term
  • document nemoclaw onboard as the recommended setup flow and nemoclaw setup as legacy

Testing

  • npm test

@TalhaSumra
Update docs for current CLI commands
fcb7b62 
Signed-off-by: TalhaSumra <talha.sumra11@gmail.com>
@TalhaSumra
Clarify OpenShell install in README
5ad0b6d 
Signed-off-by: TalhaSumra <talha.sumra11@gmail.com>
@TalhaSumra TalhaSumra changed the title Update docs for current CLI commands fix: align docs with current CLI commands Mar 16, 2026
deepujain added a commit to deepujain/NemoClaw that referenced this pull request Mar 17, 2026
@deepujain
docs: align with current CLI, onboard recommended and setup legacy (F…
f00a331 
…ixes NVIDIA#38)

Signed-off-by: Deepak Jain <deepujain@gmail.com>
@deepujain deepujain mentioned this pull request Mar 17, 2026
Merged
deepujain added a commit to deepujain/NemoClaw that referenced this pull request Mar 20, 2026
@deepujain
docs: align with current CLI, onboard recommended and setup legacy (F…
a88e990 
…ixes NVIDIA#38)

Signed-off-by: Deepak Jain <deepujain@gmail.com>
deepujain added a commit to deepujain/NemoClaw that referenced this pull request Mar 20, 2026
@deepujain
docs: align with current CLI, onboard recommended and setup legacy (F…
36c9b72 
…ixes NVIDIA#38)

Fixes NVIDIA#38

Signed-off-by: Deepak Jain <deepujain@gmail.com>
@wscurran wscurran added the documentation Improvements or additions to documentation label Mar 20, 2026
@wscurran
Copy link
Copy Markdown
Contributor

wscurran commented Mar 20, 2026

Thanks for updating the docs to reflect the current state of the CLI, including replacing outdated references and documenting the recommended setup flow with nemoclaw onboard.

@wscurran wscurran added Getting Started Use this label to identify setup, installation, or onboarding issues. priority: high Important issue that should be resolved in the next release labels Mar 20, 2026
@wscurran wscurran requested a review from miyoungc March 20, 2026 21:51
@miyoungc
Copy link
Copy Markdown
Contributor

miyoungc commented Mar 20, 2026

Would you try resolving conflicts? It might be faster to open a new PR if that'd work better.

@miyoungc
Copy link
Copy Markdown
Contributor

miyoungc commented Mar 20, 2026

For your information, there's also a big PR currently open by @ericksoa: #492.

@miyoungc
Copy link
Copy Markdown
Contributor

miyoungc commented Mar 24, 2026 •
edited
Loading

We appreciate your contribution effort. The NemoClaw team has made significant updates to the CLI and the documentation, and this PR has gone stale. Closing the PR.

@miyoungc miyoungc closed this Mar 24, 2026
deepujain added a commit to deepujain/NemoClaw that referenced this pull request Mar 25, 2026
@deepujain
docs: align with current CLI, onboard recommended and setup legacy (F…
5f3822e 
…ixes NVIDIA#38)

Fixes NVIDIA#38

Signed-off-by: Deepak Jain <deepujain@gmail.com>
deepujain added a commit to deepujain/NemoClaw that referenced this pull request Mar 31, 2026
@deepujain
docs: align with current CLI, onboard recommended and setup legacy (F…
fe4310e 
…ixes NVIDIA#38)

Fixes NVIDIA#38

Signed-off-by: Deepak Jain <deepujain@gmail.com>
deepujain added a commit to deepujain/NemoClaw that referenced this pull request Mar 31, 2026
@deepujain
docs: align with current CLI, onboard recommended and setup legacy (F…
3e3edd8 
…ixes NVIDIA#38)

Fixes NVIDIA#38

Signed-off-by: Deepak Jain <deepujain@gmail.com>
cv added a commit that referenced this pull request Mar 31, 2026
@deepujain @cv
docs: align with current CLI, onboard recommended and setup legacy (F…
75b8bb9 
…ixes #38) (#103)

## Summary

Aligns documentation with the current CLI: documents `nemoclaw onboard`
as the recommended setup flow and `nemoclaw setup` as legacy, and
updates deploy docs to refer to onboard.

Fixes #38.

## Changes

- **docs/reference/commands.md**
- `nemoclaw onboard`: marked as “recommended for new installs” and added
a note that the legacy `nemoclaw setup` command is deprecated.
- Deploy description: “runs the nemoclaw setup” → “runs \`nemoclaw
onboard\`”.
  - Added **Legacy: `nemoclaw setup`** subsection with deprecation note.
- **docs/deployment/deploy-to-remote-gpu.md**
- Step 3: “Runs the nemoclaw setup” → “Runs \`nemoclaw onboard\` (the
setup wizard)”.

(No remaining “nemoclaw term” references were found in the repo; docs
already use `openshell term`.)

## Testing

- `npm test` — all tests pass. No new unit tests (docs-only change).


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

* **Documentation**
* Deployment guide updated to instruct using the recommended "nemoclaw
onboard" setup wizard for remote VM provisioning.
* Added a deprecation notice: the legacy "nemoclaw setup" is deprecated;
new installs should use "nemoclaw onboard".
* Command reference revised to reflect the onboard workflow and clarify
that the legacy setup remains only for backward-compatibility.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Deepak Jain <deepujain@gmail.com>
Co-authored-by: Carlos Villela <cvillela@nvidia.com>
laitingsheng pushed a commit that referenced this pull request Apr 2, 2026
@deepujain @cv @laitingsheng
docs: align with current CLI, onboard recommended and setup legacy (F…
0c5b505 
…ixes #38) (#103)

## Summary

Aligns documentation with the current CLI: documents `nemoclaw onboard`
as the recommended setup flow and `nemoclaw setup` as legacy, and
updates deploy docs to refer to onboard.

Fixes #38.

## Changes

- **docs/reference/commands.md**
- `nemoclaw onboard`: marked as “recommended for new installs” and added
a note that the legacy `nemoclaw setup` command is deprecated.
- Deploy description: “runs the nemoclaw setup” → “runs \`nemoclaw
onboard\`”.
  - Added **Legacy: `nemoclaw setup`** subsection with deprecation note.
- **docs/deployment/deploy-to-remote-gpu.md**
- Step 3: “Runs the nemoclaw setup” → “Runs \`nemoclaw onboard\` (the
setup wizard)”.

(No remaining “nemoclaw term” references were found in the repo; docs
already use `openshell term`.)

## Testing

- `npm test` — all tests pass. No new unit tests (docs-only change).


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

* **Documentation**
* Deployment guide updated to instruct using the recommended "nemoclaw
onboard" setup wizard for remote VM provisioning.
* Added a deprecation notice: the legacy "nemoclaw setup" is deprecated;
new installs should use "nemoclaw onboard".
* Command reference revised to reflect the onboard workflow and clarify
that the legacy setup remains only for backward-compatibility.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Deepak Jain <deepujain@gmail.com>
Co-authored-by: Carlos Villela <cvillela@nvidia.com>
lakamsani pushed a commit to lakamsani/NemoClaw that referenced this pull request Apr 4, 2026
@deepujain @cv
docs: align with current CLI, onboard recommended and setup legacy (F…
70955f7 
…ixes NVIDIA#38) (NVIDIA#103)

## Summary

Aligns documentation with the current CLI: documents `nemoclaw onboard`
as the recommended setup flow and `nemoclaw setup` as legacy, and
updates deploy docs to refer to onboard.

Fixes NVIDIA#38.

## Changes

- **docs/reference/commands.md**
- `nemoclaw onboard`: marked as “recommended for new installs” and added
a note that the legacy `nemoclaw setup` command is deprecated.
- Deploy description: “runs the nemoclaw setup” → “runs \`nemoclaw
onboard\`”.
  - Added **Legacy: `nemoclaw setup`** subsection with deprecation note.
- **docs/deployment/deploy-to-remote-gpu.md**
- Step 3: “Runs the nemoclaw setup” → “Runs \`nemoclaw onboard\` (the
setup wizard)”.

(No remaining “nemoclaw term” references were found in the repo; docs
already use `openshell term`.)

## Testing

- `npm test` — all tests pass. No new unit tests (docs-only change).


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

* **Documentation**
* Deployment guide updated to instruct using the recommended "nemoclaw
onboard" setup wizard for remote VM provisioning.
* Added a deprecation notice: the legacy "nemoclaw setup" is deprecated;
new installs should use "nemoclaw onboard".
* Command reference revised to reflect the onboard workflow and clarify
that the legacy setup remains only for backward-compatibility.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Deepak Jain <deepujain@gmail.com>
Co-authored-by: Carlos Villela <cvillela@nvidia.com>
gemini2026 pushed a commit to gemini2026/NemoClaw that referenced this pull request Apr 14, 2026
@deepujain @cv @gemini2026
docs: align with current CLI, onboard recommended and setup legacy (F…
6d2dd81 
…ixes NVIDIA#38) (NVIDIA#103)

## Summary

Aligns documentation with the current CLI: documents `nemoclaw onboard`
as the recommended setup flow and `nemoclaw setup` as legacy, and
updates deploy docs to refer to onboard.

Fixes NVIDIA#38.

## Changes

- **docs/reference/commands.md**
- `nemoclaw onboard`: marked as “recommended for new installs” and added
a note that the legacy `nemoclaw setup` command is deprecated.
- Deploy description: “runs the nemoclaw setup” → “runs \`nemoclaw
onboard\`”.
  - Added **Legacy: `nemoclaw setup`** subsection with deprecation note.
- **docs/deployment/deploy-to-remote-gpu.md**
- Step 3: “Runs the nemoclaw setup” → “Runs \`nemoclaw onboard\` (the
setup wizard)”.

(No remaining “nemoclaw term” references were found in the repo; docs
already use `openshell term`.)

## Testing

- `npm test` — all tests pass. No new unit tests (docs-only change).


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

* **Documentation**
* Deployment guide updated to instruct using the recommended "nemoclaw
onboard" setup wizard for remote VM provisioning.
* Added a deprecation notice: the legacy "nemoclaw setup" is deprecated;
new installs should use "nemoclaw onboard".
* Command reference revised to reflect the onboard workflow and clarify
that the legacy setup remains only for backward-compatibility.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Deepak Jain <deepujain@gmail.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

Reviewers

@miyoungc miyoungc Awaiting requested review from miyoungc

Assignees

@kjw3 kjw3

Labels

documentation Improvements or additions to documentation Getting Started Use this label to identify setup, installation, or onboarding issues. priority: high Important issue that should be resolved in the next release

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@TalhaSumra @wscurran @miyoungc @kjw3