docs: correct nico-admin-cli API URL flag from -c to -a#3114
Open
dbl-nv wants to merge 2 commits into
Open
Conversation
The admin-cli field was renamed carbide_api -> api_url in 2.0. With clap's derived short flag, the short option follows the long name's first letter, so -c/--carbide-api became -a/--api-url (--carbide-url kept as a visible alias). All docs still showed the stale -c flag, which no longer exists. Sweep replaces `nico-admin-cli -c` -> `nico-admin-cli -a` across the docs (79 occurrences, 12 files). No functional/code changes. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Daryl Blanc <dblanc@nvidia.com>
Contributor
WalkthroughThis PR updates ChangesCLI Flag Rename Documentation Updates
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related issues
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
🔍 Container Scan SummaryNo Grype artifacts were found to aggregate. |
|
🌿 Preview your docs: https://nvidia-preview-pull-request-3114.docs.buildwithfern.com/infra-controller |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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 `@docs/playbooks/debugging_machine/debug_bundle.md`:
- Line 76: The API URL option is inconsistent in the debug-bundle documentation:
the examples now use -a while the parameter table still shows -c <API_URL>.
Update the parameter table entry in the debug-bundle page to match the new -a
flag, and make sure every mention of the API URL option is consistent across the
page so the `nico-admin-cli mh debug-bundle` usage stays aligned.
In `@docs/playbooks/machine_reboot.md`:
- Around line 37-45: The fenced command examples in machine_reboot.md are
missing a language tag, which triggers MD040 and removes syntax highlighting.
Update both Markdown code fences in the reboot examples to use bash, keeping the
existing commands unchanged. Use the fenced blocks around the nico-admin-cli
examples as the reference points.
In `@docs/playbooks/stuck_objects/diagnostic_tools.md`:
- Line 44: The example command for nico-admin-cli now uses the API address flag,
but the connection-options table still documents the old flag, so update the
table to match the new usage. Keep the example and the documented options
consistent by changing the table entry for the CLI’s connection option in
diagnostic_tools.md to reference the same symbol/flag used by the machine show
example.
🪄 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: f3ac08d5-8ef7-43a2-b34a-f2440fdcf200
📒 Files selected for processing (12)
docs/configuration/tenant_management.mddocs/dpu-management/dpu-lifecycle-management.mddocs/getting-started/quick-start.mddocs/operations/firmware-updates.mddocs/operations/tenant-lifecycle-cleanup.mddocs/playbooks/debugging_machine/debug_bundle.mddocs/playbooks/force_delete.mddocs/playbooks/machine_reboot.mddocs/playbooks/stuck_objects/diagnostic_tools.mddocs/provisioning/attestation_and_security.mddocs/provisioning/boot-interfaces-and-dpu-modes.mddocs/provisioning/ingesting-hosts.md
Address CodeRabbit review on NVIDIA#3114 plus related stale references: - debug_bundle.md / diagnostic_tools.md: parameter/connection-option tables still documented the removed `-c` flag while examples used `-a`. - machine_reboot.md: add `bash` language tag to the two example fences (MD040). - diagnostic_tools.md: correct stale `cargo build -p carbide-admin-cli` package name to `nico-admin-cli`. - dpu_extension_service.md: rename `carbide-admin-cli` invocations to `nico-admin-cli` (the crate/binary was renamed; old name no longer exists). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Daryl Blanc <dblanc@nvidia.com>
polarweasel
approved these changes
Jul 3, 2026
polarweasel
left a comment
polarweasel
left a comment
Contributor
There was a problem hiding this comment.
LGTM. Thanks for the linter fixes, too!
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Corrects
nico-admin-clidocumentation inconsistencies.Primary fix — removed
-cAPI-URL flag. In 2.0 the admin-cli field was renamedcarbide_api→api_url; with clap's derivedshort, the option changed from--carbide-api/-cto--api-url/-a(--carbide-urlretained as a visible alias — seecrates/admin-cli/src/cfg/cli_options.rs). Every documented-cexample fails against a current build. Sweep replacesnico-admin-cli -c→nico-admin-cli -a(79 occurrences across 12 files), including real-URL examples and parameter/option tables.Related cleanups (from review):
bashlanguage tag to two code fences inmachine_reboot.md(MD040).cargo build -p carbide-admin-cli→nico-admin-cli(package renamed).carbide-admin-clibinary invocations tonico-admin-cliindpu_extension_service.md(the intentionalcarbide-admin-cli/forge-admin-clicompletion aliases ingenerate-shell-complete.mdare left as-is).Related issues
Related to #3112
Type of Change
Breaking Changes
Testing
Additional Notes
Docs-only change; no code affected. Verified
-amatches the currentcli_options.rsflag definition, thatnico-admin-cliis the actual crate/binary name, and that no stalenico-admin-cli -cor unintendedcarbide-admin-clireferences remain indocs/.🤖 Generated with Claude Code