CLI Overview

The dome CLI is the primary command-line interface for the Dome Platform.

Installation

macOS (Homebrew)

brew trust dome-systems/tap
brew install dome-systems/tap/dome

Homebrew 6 requires the brew trust line before it loads a third-party tap’s formulae. Refer to Install for the full walkthrough, including a direct-download alternative.

Global Flags

All commands support these flags:

Flag	Type	Description
`--context`	string	Use a specific context (overrides active context)
`--server`	string	Dome Platform server URL
`--activity`	string	Stable activity ID this run asserts. Every Connect RPC carries `X-Dome-Activity-Id` so audit events from the run share one activity chain. Overrides `DOME_ACTIVITY_ID`.
`--json`	bool	Output as JSON
`--quiet`	bool	Minimal output (IDs only)
`--no-color`	bool	Disable colored output

Environment Variables

Variable	Description
`DOME_API_KEY`	Sets the active context’s token. Useful for CI and scripts.
`DOME_ACTIVITY_ID`	Default activity ID for the process. `--activity` overrides it.

Command Groups

Connect

Command	Description
`agents`	Manage agent registrations, lifecycle, and API keys
`gateway`	Manage Gateways, membership, agent access, and quotas
`tool`	Manage MCP server connections the gateway proxies
`model`	Manage LLM model connections and routing pools

Secure

Command	Description
`rules`	Deploy, validate, simulate, and rollback authorization rules

Operate

Command	Description
`audit`	Query, stream, and export audit events
`webhooks`	Manage webhook subscriptions, delivery history, and the provider catalog
`usage`	Show LLM token usage and estimated cost for the active workspace

Settings

Command	Description
`tenants`	Create tenants under your active organization
`workspace`	Manage workspaces, members, act-as, and verification providers
`platform-keys`	Manage platform API keys
`config`	Platform configuration

Developer

Command	Description
`quickstart`	Scaffold a new Dome-enabled project
`sandbox`	Provision sandbox environments

Session

Command	Description
`auth`	Authentication management
`context`	Manage CLI contexts (org/tenant/workspace sessions)

Standalone

Command	Description
`mcp`	MCP server for AI agents
`version`	Show CLI version

Next steps

Authenticate first, then scaffold — or drive the same jobs from MCP:

Install to authenticate and select a workspace
Quickstart to scaffold and verify governed traffic
MCP when you prefer tool-based access from an assistant
API for the management and data-plane HTTP surfaces

​Installation

​Global Flags

​Environment Variables

​Command Groups

​Connect

​Secure

​Operate

​Settings

​Developer

​Session

​Standalone

​Next steps