Skip to content

docs: fix incorrect -f flag in logs examples, should be --follow#1023

Open
latenighthackathon wants to merge 1 commit intoNVIDIA:mainfrom
latenighthackathon:docs/fix-logs-follow-flag
Open

docs: fix incorrect -f flag in logs examples, should be --follow#1023
latenighthackathon wants to merge 1 commit intoNVIDIA:mainfrom
latenighthackathon:docs/fix-logs-follow-flag

Conversation

@latenighthackathon
Copy link

@latenighthackathon latenighthackathon commented Mar 27, 2026

Summary

Fix incorrect -f shorthand in docs/monitoring/monitor-sandbox-activity.md. The CLI only accepts --follow — the -f flag is silently ignored, causing users to miss real-time log output.

Related Issue

Fixes #1021

Changes

  • Line 57: nemoclaw <name> logs -fnemoclaw <name> logs --follow
  • Line 90: nemoclaw <name> logs -fnemoclaw <name> logs --follow

Type of Change

  • Code change for a new feature, bug fix, or refactor.
  • Code change with doc updates.
  • Doc only. Prose changes without code sample modifications.
  • Doc only. Includes code sample changes.

Testing

  • npx prek run --all-files passes (or equivalently make check).
  • npm test passes.
  • make docs builds without warnings. (for doc-only changes)

Checklist

General

Doc Changes

  • Follows the style guide.
  • New pages include SPDX license header and frontmatter, if creating a new page.
  • Cross-references and links verified.

Summary by CodeRabbit

  • Documentation
    • Standardized NemoClaw log-following examples to use the long-form --follow flag across monitoring instructions.
    • Aligned troubleshooting steps and real-time streaming examples for consistent command usage, improving clarity and reducing confusion.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 27, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 8272135a-0217-4d78-af68-6d84b7f0d124

📥 Commits

Reviewing files that changed from the base of the PR and between cccebbd and 959e6d2.

📒 Files selected for processing (1)
  • docs/monitoring/monitor-sandbox-activity.md
✅ Files skipped from review due to trivial changes (1)
  • docs/monitoring/monitor-sandbox-activity.md

📝 Walkthrough

Walkthrough

Updated documentation examples in monitor-sandbox-activity.md to replace the unsupported short -f log flag with the correct long --follow option in two places so examples match the CLI behavior.

Changes

Cohort / File(s) Summary
Documentation Fix
docs/monitoring/monitor-sandbox-activity.md
Replaced -f with --follow in two code examples (lines ~57 and ~90) so the documented nemoclaw ... logs command matches the CLI's accepted --follow flag.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 I hopped through docs to find the flaw,
A -f that broke the logging law.
Swapped in --follow, neat and slow,
Now logs stream on—hip hop, let's go! 🎉

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: correcting the -f flag to --follow in documentation examples.
Linked Issues check ✅ Passed The changes fully address issue #1021 by updating both occurrences (lines 57 and 90) from -f to --follow to match CLI implementation.
Out of Scope Changes check ✅ Passed All changes are directly related to fixing the documented flag issue in #1021; no out-of-scope modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
docs/monitoring/monitor-sandbox-activity.md (1)

44-44: Consider splitting into one sentence per line.

Line 44 contains two sentences. Per the style guide, one sentence per line makes diffs more readable.

📝 Suggested formatting
-Run `nemoclaw <name> status` on the host to check sandbox state. Use `openshell sandbox list` for the underlying sandbox details.
+Run `nemoclaw <name> status` on the host to check sandbox state.
+Use `openshell sandbox list` for the underlying sandbox details.

As per coding guidelines: "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/monitoring/monitor-sandbox-activity.md` at line 44, Split the two
sentences on line 44 into separate lines so each sentence is one line: change
"Run `nemoclaw <name> status` on the host to check sandbox state. Use `openshell
sandbox list` for the underlying sandbox details." into two lines — one
containing "Run `nemoclaw <name> status` on the host to check sandbox state."
and the next containing "Use `openshell sandbox list` for the underlying sandbox
details." — ensuring the exact sentence strings remain unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/monitoring/monitor-sandbox-activity.md`:
- Line 44: Split the two sentences on line 44 into separate lines so each
sentence is one line: change "Run `nemoclaw <name> status` on the host to check
sandbox state. Use `openshell sandbox list` for the underlying sandbox details."
into two lines — one containing "Run `nemoclaw <name> status` on the host to
check sandbox state." and the next containing "Use `openshell sandbox list` for
the underlying sandbox details." — ensuring the exact sentence strings remain
unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 835c297e-03bc-45a6-a3ca-3197619f5eab

📥 Commits

Reviewing files that changed from the base of the PR and between 5c269c1 and cccebbd.

📒 Files selected for processing (1)
  • docs/monitoring/monitor-sandbox-activity.md

The CLI only accepts --follow (bin/nemoclaw.js line 805), not -f.
The commands reference (docs/reference/commands.md) correctly
documents --follow but monitor-sandbox-activity.md used -f.
@latenighthackathon latenighthackathon force-pushed the docs/fix-logs-follow-flag branch from cccebbd to 959e6d2 Compare March 27, 2026 05:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[NemoClaw][Doc] monitor-sandbox-activity.md uses -f flag but CLI only accepts --follow

1 participant