Setup and config

Commands for standing up and operating a deployment, plus local configuration. To deploy your own environment end to end, follow the quickstart.

setup

Configure, deploy, and tear down a Zomg environment

zomg setup <command>

Subcommand	Description
`status`	Print setup progress from .zomg/setup-state.json
`check`	Check local commands and required setup config
`ui`	Open a local setup status UI
`install`	Check/install host dependencies for a deployment host
`bundle`	Prepare a deploy bundle under .zomg/repo
`secrets`	Create infra/secrets/<profile>.sops.yaml from configured input files and setup secrets
`deploy`	Run deployment from the configured setup state
`destroy`	Destroy deployment infrastructure for the configured setup state
`github-app`	Create a deployment-scoped GitHub App via GitHub’s manifest flow
`agent`	Print concise setup context for coding agents
`guide`	Print agent-facing setup guidance

# Show setup progress and missing requirements
zomg setup status
zomg setup check

# Open the local setup UI
zomg setup ui

# Install/check host dependencies before deploy
zomg setup install

# Prepare repo-free deploy bundle
zomg setup bundle

# Create encrypted deploy secrets from configured input files
zomg setup secrets

# Deploy the selected profile
zomg setup deploy

# Print concise setup context for coding agents
zomg setup agent

# Destroy the selected profile VM
zomg setup destroy --yes

# Print the agent-facing setup guide
zomg setup guide

status

Print setup progress from .zomg/setup-state.json

zomg setup status [options]

Argument / option	Description
`--json`	Print the JSON response.

check

Check local commands and required setup config

zomg setup check [options]

Argument / option	Description
`--json`	Print the JSON response.

ui

Open a local setup status UI

zomg setup ui [options]

Argument / option	Description
`--port <PORT>`	Defaults to `4874`.
`--host <HOST>`	Defaults to `127.0.0.1`.
`--no-open`	Print the URL instead of opening a browser.

install

Check/install host dependencies for a deployment host

zomg setup install [options]

Argument / option	Description
`--dry-run`	Print what would happen without running installers
`-y, --yes`	Run supported installers without prompting

bundle

Prepare a deploy bundle under .zomg/repo

zomg setup bundle [options]

Argument / option	Description
`-f, --force`	Replace an existing deploy bundle
`--download`	Download source bundle instead of copying the current repo
`--url <URL>`	Source tarball URL. Defaults to ZOMG_SETUP_BUNDLE_URL or the repository main tarball

secrets

Create infra/secrets/<profile>.sops.yaml from configured input files and setup secrets

zomg setup secrets [options]

Argument / option	Description
`--dry-run`	Print the target secrets path without writing
`-f, --force`	Replace an existing secrets file

deploy

Run deployment from the configured setup state

zomg setup deploy [options]

Argument / option	Description
`--dry-run`	Print the deploy command without running it
`--skip-verify`	Skip post-deploy verification

destroy

Destroy deployment infrastructure for the configured setup state

zomg setup destroy [options]

Argument / option	Description
`--dry-run`	Print the destroy command without running it
`-y, --yes`	Destroy without prompting

github-app

Create a deployment-scoped GitHub App via GitHub’s manifest flow

zomg setup github-app [options]

Argument / option	Description
`--name <NAME>`	GitHub App name. Defaults to “Zomg <profile>“
`--owner <OWNER>`	GitHub organization login. Omit to choose personal or organization in the browser
`--port <PORT>`	Local callback port for GitHub’s manifest redirect. Defaults to `4875`.
`--no-open`	Do not open the browser automatically; print the local HTML path instead
`--code <CODE>`	Convert an already received GitHub App manifest code instead of starting a callback server
`--print-manifest`	Print the manifest JSON without contacting GitHub
`--deploy`	After storing GitHub App credentials, redeploy only zomg-api for this profile

# Choose personal or organization in the browser, then redeploy only zomg-api
zomg setup github-app --deploy

# Skip the browser choice and create the GitHub App under an organization
zomg setup github-app --owner example-org --deploy

# Print the manifest without contacting GitHub
zomg setup github-app --print-manifest

agent

Print concise setup context for coding agents

zomg setup agent

guide

Print agent-facing setup guidance

zomg setup guide

config

Read and write local setup config

zomg config <command>

Subcommand	Description
`path`	Print the local setup config path
`profiles`	List known setup profiles and the selected default
`list`	List all stored setup config
`get`	Read one setup config value
`set`	Set one setup config value
`unset`	Remove one setup config value

# Set setup values used by setup UI/install/deploy
zomg config set profile example
zomg config set zomg_domain zomg.ai

# Read setup config
zomg config list
zomg config get profile
zomg config path

path

Print the local setup config path

zomg config path

profiles

List known setup profiles and the selected default

zomg config profiles [options]

Argument / option	Description
`--json`	Print the JSON response.

list

List all stored setup config

zomg config list [options]

Argument / option	Description
`--json`	Print the JSON response.

get

Read one setup config value

zomg config get <KEY>

Argument / option	Description
`<KEY>`	Config key.

set

Set one setup config value

zomg config set <KEY> <VALUE>

Argument / option	Description
`<KEY>`	Config key.
`<VALUE>`	Config value.

unset

Remove one setup config value

zomg config unset <KEY>

Argument / option	Description
`<KEY>`	Config key.

telemetry

Inspect or change pseudonymous CLI telemetry

zomg telemetry <command>

Subcommand	Description
`status`	Show the effective telemetry mode
`on`	Enable telemetry after the first-run notice
`off`	Disable telemetry
`log`	Print future telemetry payloads instead of sending them
`explain`	Print the telemetry policy

# Show the effective telemetry mode and local config path
zomg telemetry status

# Disable telemetry
zomg telemetry off

# Print future telemetry payloads instead of sending them
zomg telemetry log

# Re-enable telemetry
zomg telemetry on

# Print the telemetry policy
zomg telemetry explain

status

Show the effective telemetry mode

zomg telemetry status [options]

Argument / option	Description
`--json`	Print the JSON response.

on

Enable telemetry after the first-run notice

zomg telemetry on

off

Disable telemetry

zomg telemetry off

log

Print future telemetry payloads instead of sending them

zomg telemetry log

explain

Print the telemetry policy

zomg telemetry explain

health

Report API and cluster health

zomg health [options]

Argument / option	Description
`-j, --json`	Print the JSON response.

zomg health
zomg health --json

upgrade

Upgrade the zomg CLI to the version served by the API

zomg upgrade [options]

Argument / option	Description
`--version <VERSION>`	CLI version to install; defaults to latest served by the API
`--dry-run`	Print selected release artifact without installing

# Upgrade zomg from the configured API endpoint
zomg upgrade

# Upgrade to a specific CLI version served by the API
zomg upgrade --version 0.2.0

# Preview the selected artifact
zomg upgrade --dry-run

project

Inspect project resolution

zomg project <command>

Subcommand	Description
`current`	Show the current resolved project name

zomg project current

current

Show the current resolved project name

zomg project current

docs

Print the “Using zomg” guide

zomg docs

​setup

​status

​check

​ui

​install

​bundle

​secrets

​deploy

​destroy

​github-app

​agent

​guide

​config

​path

​profiles

​list

​get

​set

​unset

​telemetry

​status

​on

​off

​log

​explain

​health

​upgrade

​project

​current

​docs

setup

status

check

ui

install

bundle

secrets

deploy

destroy

github-app

agent

guide

config

path

profiles

list

get

set

unset

telemetry

status

on

off

log

explain

health

upgrade

project

current

docs