Skip to content

docs: document carbide-admin-cli #2011

@ianderson-nvidia

Description

@ianderson-nvidia

How would you describe the priority of this documentation request

Critical (currently preventing usage)

Describe the future/missing documentation

I am copying this request from Nvidia's internal project management

Background
Zero CLI documentation exists in the current public docs. The forge-admin-cli is the primary operational tool for site administrators but is entirely undocumented externally. This is a P2 item in the IA recommendation and contributes to the readability score gap.

Scope of Work
Command Reference

Document all forge-admin-cli commands with flags and options
One real invocation example per command with expected output — not placeholder syntax
Commands grouped by domain: Hardware, Network, Tenant, Admin

Cross-References
Link each command to the relevant operations or configuration guide page
Add "See also" links between related commands

Common Workflows

3-5 end-to-end CLI workflows covering the most common operator tasks
Example: "Check health of all hosts" end-to-end command sequence
Acceptance Criteria
Every forge-admin-cli command is documented with at least one working example
Verified by SA/TME

Ref: FORGE-8621

Code of Conduct

  • I agree to follow NCX Infra Controller's Code of Conduct
  • I have searched the open documentation issues and have found no duplicates for this documentation issue

Metadata

Metadata

Labels

No labels
No labels
No fields configured for Documentation.

Projects

Status
In Progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions