Skip to content

docs(nvcf-cli): align skill reference docs with the CLI code#300

Open
mesutoezdil wants to merge 1 commit into
NVIDIA:mainfrom
mesutoezdil:mesutoezdil/docs/cli-reference-accuracy
Open

docs(nvcf-cli): align skill reference docs with the CLI code#300
mesutoezdil wants to merge 1 commit into
NVIDIA:mainfrom
mesutoezdil:mesutoezdil/docs/cli-reference-accuracy

Conversation

@mesutoezdil

@mesutoezdil mesutoezdil commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

TL;DR

The nvcf-self-managed-cli reference docs described flags, commands, defaults, and exit codes that do not exist in the CLI: --identity-source, --show-events, cluster get, api-key --id, a required --region, a max-request-concurrency default of 10, exit code 4, and a wrong state file path. All corrected against src/clis/nvcf-cli and skilldata_generated.go regenerated. go build and the agentskill and cmd tests pass.

Issues

Closes #299

Summary by CodeRabbit

  • Documentation
    • Updated nvcf-cli command reference for self-hosted lifecycle draining to use a presence-style --drain-active flag.
    • Simplified cluster management docs by removing the documented cluster lookup command and making --region optional for cluster registration.
    • Updated auth command docs so API key delete/revoke now uses positional KEY-ID arguments.
    • Refreshed exit-code guidance by removing instructions for exit code 4 and adjusting punctuation for exit code 130.
    • Normalized flag default/unset placeholders and clarified server-default behavior for concurrency.
    • Corrected the documented location of generated credentials to the current CLI state file path.

@mesutoezdil
mesutoezdil requested a review from a team as a code owner July 21, 2026 09:23
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

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

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: e695c967-c7c2-496a-97b8-e13e5aa8469f

📥 Commits

Reviewing files that changed from the base of the PR and between 84d68fc and 51f2377.

⛔ Files ignored due to path filters (1)
  • src/clis/nvcf-cli/internal/agentskill/skilldata_generated.go is excluded by !**/*_generated.go
📒 Files selected for processing (4)
  • ai-tooling/user/skills/nvcf-self-managed-cli/reference/commands.md
  • ai-tooling/user/skills/nvcf-self-managed-cli/reference/exit-codes.md
  • ai-tooling/user/skills/nvcf-self-managed-cli/reference/flags.md
  • src/clis/nvcf-cli/.nvcf-cli.yaml.template
🚧 Files skipped from review as they are similar to previous changes (4)
  • src/clis/nvcf-cli/.nvcf-cli.yaml.template
  • ai-tooling/user/skills/nvcf-self-managed-cli/reference/exit-codes.md
  • ai-tooling/user/skills/nvcf-self-managed-cli/reference/commands.md
  • ai-tooling/user/skills/nvcf-self-managed-cli/reference/flags.md

📝 Walkthrough

Walkthrough

The CLI skill references and configuration template are updated to match current command syntax, supported flags, defaults, exit codes, and the .nvcf-cli.state credential storage path.

Changes

CLI reference alignment

Layer / File(s) Summary
Command and exit-code references
ai-tooling/user/skills/nvcf-self-managed-cli/reference/commands.md, ai-tooling/user/skills/nvcf-self-managed-cli/reference/exit-codes.md
Updates self-hosted down and API-key syntax, removes the unsupported cluster get command, and removes exit code 4 guidance.
Flag and default references
ai-tooling/user/skills/nvcf-self-managed-cli/reference/flags.md
Corrects unset placeholders, removes unsupported cluster-register flags, documents the us-west-1 region default, and updates function and task defaults.
CLI state-file comments
src/clis/nvcf-cli/.nvcf-cli.yaml.template
Replaces references to ~/.nvcf-cli-state.json with ~/.nvcf-cli.state for generated credentials and tokens.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 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 follows Conventional Commits and accurately describes the docs-only nvcf-cli alignment changes.
Linked Issues check ✅ Passed The documented mismatches in #299 are all addressed in the reviewed docs and template changes.
Out of Scope Changes check ✅ Passed The changes stay within the documentation and template alignment work described by the linked issue.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@ai-tooling/user/skills/nvcf-self-managed-cli/reference/flags.md`:
- Around line 108-113: Update the --max-request-concurrency row in the CLI flags
reference to document the default as 0 (server default) instead of unset (server
default), matching the implementation and stated CLI behavior.
- Around line 42-56: Update the cluster register command syntax in commands.md
to omit the region argument or mark it optional, matching the documented
us-west-1 default in the flags table; keep --name and --nca-id required.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: bfa078f5-7efb-4aae-afa1-4d10c72af072

📥 Commits

Reviewing files that changed from the base of the PR and between 5ef95ed and 1284150.

⛔ Files ignored due to path filters (1)
  • src/clis/nvcf-cli/internal/agentskill/skilldata_generated.go is excluded by !**/*_generated.go
📒 Files selected for processing (4)
  • ai-tooling/user/skills/nvcf-self-managed-cli/reference/commands.md
  • ai-tooling/user/skills/nvcf-self-managed-cli/reference/exit-codes.md
  • ai-tooling/user/skills/nvcf-self-managed-cli/reference/flags.md
  • src/clis/nvcf-cli/.nvcf-cli.yaml.template

Comment thread ai-tooling/user/skills/nvcf-self-managed-cli/reference/flags.md
Comment thread ai-tooling/user/skills/nvcf-self-managed-cli/reference/flags.md Outdated
@mesutoezdil
mesutoezdil force-pushed the mesutoezdil/docs/cli-reference-accuracy branch from 1284150 to b77dbce Compare July 21, 2026 12:23
@mesutoezdil
mesutoezdil force-pushed the mesutoezdil/docs/cli-reference-accuracy branch from b77dbce to 181640b Compare July 21, 2026 17:51

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@ai-tooling/user/skills/nvcf-self-managed-cli/reference/flags.md`:
- Line 20: Update the --no-apply flag description in flags.md to remove the
repeated “only,” changing “install only - emit YAML only, don't kubectl apply”
to clearer wording equivalent to “install only - emit YAML, do not apply.”
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 5d3290f6-c6e6-42c3-9b74-abdcbd2b122a

📥 Commits

Reviewing files that changed from the base of the PR and between b77dbce and 181640b.

⛔ Files ignored due to path filters (1)
  • src/clis/nvcf-cli/internal/agentskill/skilldata_generated.go is excluded by !**/*_generated.go
📒 Files selected for processing (4)
  • ai-tooling/user/skills/nvcf-self-managed-cli/reference/commands.md
  • ai-tooling/user/skills/nvcf-self-managed-cli/reference/exit-codes.md
  • ai-tooling/user/skills/nvcf-self-managed-cli/reference/flags.md
  • src/clis/nvcf-cli/.nvcf-cli.yaml.template
🚧 Files skipped from review as they are similar to previous changes (2)
  • src/clis/nvcf-cli/.nvcf-cli.yaml.template
  • ai-tooling/user/skills/nvcf-self-managed-cli/reference/commands.md

Comment thread ai-tooling/user/skills/nvcf-self-managed-cli/reference/flags.md Outdated
@mesutoezdil
mesutoezdil force-pushed the mesutoezdil/docs/cli-reference-accuracy branch 2 times, most recently from 84d68fc to c082868 Compare July 21, 2026 18:28
@sbaum1994

Copy link
Copy Markdown
Contributor

Please rebase then good to merge assuming CI passes ty

Remove flags and commands that do not exist (--identity-source,
--show-events, cluster get, api-key --id), fix wrong defaults
(--region is optional with default us-west-1,
--max-request-concurrency is unset by default), drop exit code 4
which no code path returns, mark --drain-active as a plain bool,
and correct the state file path to ~/.nvcf-cli.state. Replace em
dashes with plain dashes per the ASCII-only style rule. Regenerate
skilldata_generated.go.

Closes NVIDIA#299

Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
@mesutoezdil
mesutoezdil force-pushed the mesutoezdil/docs/cli-reference-accuracy branch from c082868 to 51f2377 Compare July 22, 2026 06:44
@mesutoezdil

Copy link
Copy Markdown
Contributor Author

Please rebase then good to merge assuming CI passes ty

done

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.

nvcf-cli skill reference docs describe flags and commands that do not exist

3 participants