Commands for the CLI’s own configuration and upkeep: runtime targets, local config, telemetry, health checks, and upgrades.

use

Point the CLI at a deployment (switch targets or add one by domain)
zomg use <TARGET>
Argument / optionDescription
<TARGET>Configured target name, deployment domain, or API URL
# Point the CLI at a deployment by domain
# (probes https://api.zomg.ai, then https://zomg.ai)
zomg use loop.work

# Switch to an already-configured target by name
zomg use dev

# Point at an explicit API URL
zomg use https://api.staging.example.com

config

Inspect user runtime config
zomg config <command>
SubcommandDescription
pathPrint the user runtime config path
listList runtime config summary
getRead one runtime config value
# Show the selected runtime target
zomg config get current

# Show runtime config path
zomg config path

# Show runtime config summary
zomg config list

path

Print the user runtime config path
zomg config path

list

List runtime config summary
zomg config list [options]
Argument / optionDescription
--jsonPrint the JSON response.

get

Read one runtime config value
zomg config get <KEY>
Argument / optionDescription
<KEY>Config key.

target

Manage user runtime targets
zomg target <command>
SubcommandDescription
listList configured runtime targets
useSelect the default runtime target
addAdd or replace a runtime target
removeRemove a runtime target
# Point the CLI at a deployment by domain (saves and selects a target)
zomg use loop.work

# List configured runtime targets
zomg target list

# Switch the default runtime target
zomg target use <name>

# Add a target by hand (ssh_host derives from the API URL; sign in after)
zomg target add <name> --api-url https://api.zomg.ai --current

# Remove a target
zomg target remove <name>

list

List configured runtime targets
zomg target list [options]
Argument / optionDescription
--jsonPrint the JSON response.

use

Select the default runtime target
zomg target use <NAME>
Argument / optionDescription
<NAME>Configured target name

add

Add or replace a runtime target
zomg target add <NAME> [options]
Argument / optionDescription
<NAME>Name.
--api-url <API_URL>API base URL for the target
--ssh-host <SSH_HOST>SSH gateway host; defaults from api_url when omitted
--token-env <TOKEN_ENV>Environment variable that contains the API token
--connect-ip <CONNECT_IP>Override connection IP while keeping Host/SNI from api_url
--currentMake this target current after saving

remove

Remove a runtime target
zomg target remove <NAME>
Argument / optionDescription
<NAME>Configured target name

telemetry

Inspect or change pseudonymous CLI telemetry
zomg telemetry <command>
SubcommandDescription
statusShow the effective telemetry mode
onEnable telemetry after the first-run notice
offDisable telemetry
logPrint future telemetry payloads instead of sending them
explainPrint 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 / optionDescription
--jsonPrint 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 / optionDescription
-j, --jsonPrint the JSON response.
zomg health
zomg health --json

upgrade

Upgrade the zomg CLI to the version served by the API
zomg upgrade [options]
Argument / optionDescription
--version <VERSION>CLI version to install; defaults to latest served by the API
--dry-runPrint 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>
SubcommandDescription
currentShow the current resolved project name
zomg project current

current

Show the current resolved project name
zomg project current