Skip to content
Ghaymah Ghaymah Ghaymah Docs

JSON output (AI mode)

Every gy command supports the global --json flag, which emits structured output that scripts and AI agents can parse reliably — no screen-scraping required.

Usage

Section titled “Usage”
Terminal window
gy deploy --json
gy list apps --json
gy whoami --json
gy info my-app --json

Example outputs

Section titled “Example outputs”
// gy deploy --json
{ "status": "deployed", "app": "my-app", "project": "default", "url": "https://my-app-7f3a9c.hosted.ghaymah.systems" }
// gy list apps --json
[ { "name": "my-app", "id": "…", "type": "app", "status": "synced", "url": "https://…" } ]
// gy whoami --json
{ "status": "authenticated", "email": "dev@example.com", "userId": "…" }

Scripting with jq

Section titled “Scripting with jq”
Terminal window
# Extract the live URL after a deploy
URL=$(gy deploy --json | jq -r '.url')
echo "Deployed to $URL"


# Filter apps by status
gy list apps --json | jq '.[] | select(.status == "synced")'

Reading from stdin

Section titled “Reading from stdin”

Some commands accept input via --file - for pipelining:

Terminal window
echo '{"app":"my-app"}' | gy <command> --file -