Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.goldsky.com/llms.txt

Use this file to discover all available pages before exploring further.

Once your Compose app is deployed, a small set of CLI commands let you inspect, pause, resume, delete, and tail logs from it. The per-app commands (status, pause, resume, logs, delete) accept either -n, --name <app> to target by name, or -m, --manifest <path> (default compose.yaml) to read the name from your manifest. list is project-wide and accepts neither. Every command also accepts --json so you can pipe output into scripts or agents.

​
Check status

goldsky compose status
Shows the app’s name, current runtime status (e.g. RUNNING, PAUSED, STARTING, ERROR), and timestamps for when it was created and last updated. 
# status for a specific app, as JSON
goldsky compose status -n my-app --json

​
List apps

goldsky compose list
Prints a table of every Compose app in your project. 
# list as JSON for scripting
goldsky compose list --json

​
Pause and resume

goldsky compose pause
goldsky compose resume
While paused, cron triggers stop firing and HTTP triggers return an error. State is preserved — resume picks up where the app left off. This is useful for:
  • Triaging a misbehaving app without deleting it
  • Holding execution while you roll out a dependency change
  • Temporarily stopping a cron while you investigate its effects

​
View logs

goldsky compose logs
By default logs prints the most recent 100 lines. You can tail live, filter by level or text, and bound the output by time or line count. 
# tail live
goldsky compose logs -f

# live, errors and warnings only
goldsky compose logs -f --level error,warn

# last hour
goldsky compose logs --since 1h

# search for a substring across the last 500 lines
goldsky compose logs --tail 500 --search "timeout"

# tail live for 5 minutes, then exit
goldsky compose logs -f --timeout 5m
Options cheat-sheet:
FlagDescription
-f, --followStream logs live
--tail <n>Number of lines to fetch (default: 100)
--level <levels>Comma-separated levels (e.g. error,warn)
--search <text>Filter lines by text
--since <duration>Logs since a relative time (e.g. 1h, 30m, 7d)
--max-lines <n>Exit after N lines
--timeout <duration>Exit after a duration (e.g. 5m)
--jsonEmit newline-delimited JSON

​
Delete an app

goldsky compose delete
By default delete is interactive: it asks you to type the app name to confirm, and separately asks whether you also want to delete the app’s hosted Postgres database. 
# non-interactive (CI-safe) — skip all prompts
goldsky compose delete -f

# non-interactive, also drop the Postgres database
goldsky compose delete -f --delete-database
See Deploying and monitoring for how database deletion interacts with active pipelines.
Deleting an app is permanent. Deleting its database is permanent too, and cannot be undone. Back up anything you care about first.

​
Next Steps

Deploying your App

Learn about deploying your app to the cloud.

Full CLI Reference

View the full CLI command reference.