CLI Reference
CLI Reference
Section titled “CLI Reference”This section is the reference area for the xrmghost CLI. It documents the information architecture (IA) that governs how CLI command reference pages are organised and produced.
What This Section Contains
Section titled “What This Section Contains”| Page | Purpose |
|---|---|
| Command Groups | Maps each command group to its reader-facing purpose and intended reference-page shape |
Manual IA vs Generated Reference Content
Section titled “Manual IA vs Generated Reference Content”The CLI reference area is split into two distinct layers. Understanding this split is essential before contributing or consuming content here.
Manual IA layer (this section)
Section titled “Manual IA layer (this section)”The pages in this section — including this landing page and the command-group mapping — are manually authored in xrmghost-docs. They define the information architecture: what command groups exist, what each group covers, and how future generated reference pages will be structured.
- These pages are owned by the Documentation and CLI teams.
- Changes go through a pull request to
xrmghost-docs. - Do not treat these pages as per-command reference documentation.
Generated reference layer (docs/cli/reference/<command>.mdx)
Section titled “Generated reference layer (docs/cli/reference/<command>.mdx)”Individual per-command reference pages (flags, arguments, examples) will be generated from the xrmghost-cli source repository once the generation pipeline is active. They will land at paths such as docs/cli/reference/run.mdx and docs/cli/reference/env-list.mdx.
TODO (ADO-1158): Per-command reference pages are not yet generated. The generation pipeline is being established under ADO-1158. Do not hand-author per-command reference pages here.
Once generated pages exist, they must not be manually edited. If a command’s reference output is incorrect, fix the source in xrmghost-cli and re-run the generator. See Generated vs Manual Content for the full generation contract.
Command Groups at a Glance
Section titled “Command Groups at a Glance”The xrmghost CLI surface is organised into the following top-level command groups. See Command Groups for the full mapping.
| Command Group | Short Description |
|---|---|
run | Execute a Dataverse plugin via FrameworkHost |
generate-scenario | Generate a template JSON scenario file for a plugin |
doctor | Diagnose configuration and connectivity |
privacy | Display data-collection and privacy information |
license | Manage license status and activation |
env | Manage Dataverse environment configurations |
setup | Install or update managed infrastructure components |
Ownership
Section titled “Ownership”The CLI reference area has a split ownership model:
- Manual IA pages (this page,
command-groups.mdx): owned by the Documentation team inxrmghost-docs. - Generated command reference pages (
docs/cli/reference/<command>.mdx): owned by the CLI team inxrmghost-cli. Generated files are outputs, not the authoritative source.
For the full ownership table and update process, see Content Ownership.