CLI
XrmGhost CLI
Section titled “XrmGhost CLI”The xrmghost CLI (ghost-plugin-cli) is the primary developer interface for the XrmGhost ecosystem. It runs on Windows, macOS, and Linux and gives you terminal access to every major workflow: executing Dataverse plugins out-of-process, managing environment configurations, handling licensing, and diagnosing problems.
Who the CLI Is For
Section titled “Who the CLI Is For”The CLI is aimed at developers who:
- write and test Dataverse plugins locally before deploying to a Power Platform environment
- need scriptable, repeatable runs as part of a CI workflow
- prefer a terminal-first experience over a GUI
What the CLI Does
Section titled “What the CLI Does”| Command group | Purpose |
|---|---|
run | Execute a Dataverse plugin using a scenario file, with the Framework Host running in the background |
generate-scenario | Create a template scenario JSON for a given plugin, ready to pass to run |
env | Add, edit, delete, list, activate, and switch Dataverse environment configurations |
license | Activate your licence, view its status and tier, and retrieve your machine’s platform ID |
doctor | Run environment and configuration health checks to diagnose connectivity or setup issues |
privacy | Display information about telemetry data collection and local storage |
setup host | Install or update the Framework Host component used by run |
For the full flag-level detail of every command and sub-command, see the CLI Reference section — generated automatically from the CLI’s --help output.
How This Documentation Slice Is Organised
Section titled “How This Documentation Slice Is Organised”The CLI documentation is split into two complementary layers, following the project-wide generated vs manual content model:
Narrative guidance (manual, this slice) Pages authored by humans that explain concepts, walk through workflows, and provide context you cannot get from a help string alone.
| Page | What you will find |
|---|---|
| Getting Started | Installation, verification, and your first command |
| This page | Overview, orientation, and navigation |
Generated reference (auto-produced from the CLI source)
Per-command reference pages built from the CLI’s --help output and placed under docs/cli/reference/. These pages are owned by the generation pipeline in xrmghost-cli and must not be hand-edited once generation is active.
The generated reference pipeline is tracked separately. Until it is live, run
ghost-plugin-cli <command> --helpdirectly for flag-level detail.
Where to Go Next
Section titled “Where to Go Next”- New to XrmGhost? Start with Getting Started to install the CLI and run your first plugin scenario.
- Looking for a specific flag or option? Go to CLI Reference for the generated per-command reference.
- Wondering how docs are structured? Read Generated vs Manual Content for a full explanation of the two-layer model.
- Want to contribute? See Contributing for guidelines on updating narrative docs or the generation pipeline.