CLI
XrmGhost CLI
Section titled “XrmGhost CLI”The XrmGhost CLI (xg) is the primary developer interface for the XrmGhost ecosystem. It runs on Windows, macOS, and Linux and gives you terminal access to the main workflows: 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 an AI-agent-first workflow or 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 license, 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”| Page | What you will find |
|---|---|
| This page | Overview, orientation, and navigation |
| Getting Started | Installation, verification, and your first command |
| Reference section | CLI explanation and flags details |
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.
- Found a bug or missing capability? Use Community to report it or discuss it.
- Want to contribute? See Contributing for guidelines on updating narrative docs or the generation pipeline.