use
Point the CLI at a deployment (switch targets or add one by domain)| Argument / option | Description |
|---|---|
<TARGET> | Configured target name, deployment domain, or API URL |
config
Inspect user runtime config| Subcommand | Description |
|---|---|
path | Print the user runtime config path |
list | List runtime config summary |
get | Read one runtime config value |
path
Print the user runtime config pathlist
List runtime config summary| Argument / option | Description |
|---|---|
--json | Print the JSON response. |
get
Read one runtime config value| Argument / option | Description |
|---|---|
<KEY> | Config key. |
target
Manage user runtime targets| Subcommand | Description |
|---|---|
list | List configured runtime targets |
use | Select the default runtime target |
add | Add or replace a runtime target |
remove | Remove a runtime target |
list
List configured runtime targets| Argument / option | Description |
|---|---|
--json | Print the JSON response. |
use
Select the default runtime target| Argument / option | Description |
|---|---|
<NAME> | Configured target name |
add
Add or replace a runtime target| Argument / option | Description |
|---|---|
<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 |
--current | Make this target current after saving |
remove
Remove a runtime target| Argument / option | Description |
|---|---|
<NAME> | Configured target name |
telemetry
Inspect or change pseudonymous CLI telemetry| 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 |
status
Show the effective telemetry mode| Argument / option | Description |
|---|---|
--json | Print the JSON response. |
on
Enable telemetry after the first-run noticeoff
Disable telemetrylog
Print future telemetry payloads instead of sending themexplain
Print the telemetry policyhealth
Report API and cluster health| Argument / option | Description |
|---|---|
-j, --json | Print the JSON response. |
upgrade
Upgrade the zomg CLI to the version served by the API| Argument / option | Description |
|---|---|
--version <VERSION> | CLI version to install; defaults to latest served by the API |
--dry-run | Print selected release artifact without installing |
project
Inspect project resolution| Subcommand | Description |
|---|---|
current | Show the current resolved project name |