service
Run and manage long-lived services in a box| Subcommand | Description |
|---|---|
list | List services for a box |
start | Start a managed service |
status | Get service status |
inspect | Get service inspect details (spec + reproducible commands) |
logs | View service logs |
restart | Restart a managed service |
deploy | Deploy a preview instance |
promote | Promote preview to active |
publish | Publish an existing managed service |
unpublish | Unpublish a managed service |
stop | Stop a managed service |
list
List services for a box| Argument / option | Description |
|---|---|
<FORK> | Box ref. |
-p, --project <PROJECT> | Target project. |
-j, --json | Print the JSON response. |
start
Start a managed service| Argument / option | Description |
|---|---|
<FORK> | Box ref. |
<NAME> | Name. |
--port <PORT> | Service port to publish |
--publish <PUBLISH> | Publish subdomain (uses default domain) |
--domain <DOMAIN> | Override publish domain |
-t, --tag <TAGS> | Tag as key=value (repeatable); use box.ui=main for the primary web UI |
-p, --project <PROJECT> | Target project. |
<CMD> | Command and arguments (use -- separator) (repeatable) |
status
Get service status| Argument / option | Description |
|---|---|
<FORK> | Box ref. |
<NAME> | Name. |
-p, --project <PROJECT> | Target project. |
-j, --json | Print the JSON response. |
inspect
Get service inspect details (spec + reproducible commands)| Argument / option | Description |
|---|---|
<FORK> | Box ref. |
<NAME> | Name. |
-p, --project <PROJECT> | Target project. |
-j, --json | Print the JSON response. |
logs
View service logs| Argument / option | Description |
|---|---|
<FORK> | Box ref. |
<NAME> | Name. |
-l, --lines <LINES> | Number of lines to show (most recent) Defaults to 100. |
-p, --project <PROJECT> | Target project. |
restart
Restart a managed service| Argument / option | Description |
|---|---|
<FORK> | Box ref. |
<NAME> | Name. |
-p, --project <PROJECT> | Target project. |
deploy
Deploy a preview instance| Argument / option | Description |
|---|---|
<FORK> | Box ref. |
<NAME> | Name. |
--preview <PREVIEW> | Deploy as preview (required). Optional subdomain override |
--port <PORT> | Service port to publish |
-p, --project <PROJECT> | Target project. |
<CMD> | Command and arguments (use -- separator) (repeatable) |
promote
Promote preview to active| Argument / option | Description |
|---|---|
<FORK> | Box ref. |
<NAME> | Name. |
-p, --project <PROJECT> | Target project. |
publish
Publish an existing managed service| Argument / option | Description |
|---|---|
<FORK> | Box ref. |
<NAME> | Name. |
--subdomain <SUBDOMAIN> | Publish subdomain (uses default domain); use @ for apex domain |
--domain <DOMAIN> | Override publish domain |
--port <PORT> | Override published port (default: service active port) |
-p, --project <PROJECT> | Target project. |
-j, --json | Print the JSON response. |
unpublish
Unpublish a managed service| Argument / option | Description |
|---|---|
<FORK> | Box ref. |
<NAME> | Name. |
-p, --project <PROJECT> | Target project. |
-j, --json | Print the JSON response. |
stop
Stop a managed service| Argument / option | Description |
|---|---|
<FORK> | Box ref. |
<NAME> | Name. |
-p, --project <PROJECT> | Target project. |
compose
Apply and manage a compose stack| Subcommand | Description |
|---|---|
up | Apply a compose file (create/addons/start services) |
down | Stop services/addons from a compose file |
ps | Show service state for a compose file |
logs | Show logs for compose services |
up
Apply a compose file (create/addons/start services)| Argument / option | Description |
|---|---|
-f, --file <FILE> | Compose YAML file. Defaults to fork.compose.yaml. |
-p, --project <PROJECT> | Target project. |
--force-recreate | Re-run addon create/start commands even if resources appear to exist |
down
Stop services/addons from a compose file| Argument / option | Description |
|---|---|
-f, --file <FILE> | Compose YAML file (optional when using —stack) |
--stack <STACK> | Stack name (reads authoritative state from in-box metadata) |
-p, --project <PROJECT> | Target project. |
ps
Show service state for a compose file| Argument / option | Description |
|---|---|
-f, --file <FILE> | Compose YAML file (optional when using —stack) |
--stack <STACK> | Stack name (reads authoritative state from in-box metadata) |
-p, --project <PROJECT> | Target project. |
-j, --json | Print the JSON response. |
logs
Show logs for compose services| Argument / option | Description |
|---|---|
-f, --file <FILE> | Compose YAML file (optional when using —stack) |
--stack <STACK> | Stack name (reads authoritative state from in-box metadata) |
<SERVICE> | Optional service name filter |
-l, --lines <LINES> | Number of lines to show (most recent) Defaults to 100. |
-p, --project <PROJECT> | Target project. |