Skip to content

Command reference

The complete reference for the Ghaymah CLI (gy).

Available on every command:

Flag Description
--debug Enable debug output
-f, --file Input file (- for stdin)
--json Output in JSON format (for scripts & AI)
--no-auto-update Skip automatic updates
-h, --help Help for the command
-v, --version Show CLI version

Deploy your app. Auto-detects the stack, generates a Dockerfile if needed, and ships.

Aliases: d, push, up

Terminal window
gy deploy [PATH] [flags]
Flag Description
-n, --name App name (defaults to directory name)
-p, --project Project name (auto-creates if new)
--port Port your app listens on (auto-detected)
--tier Resource tier: t1, t2, t3 (default t1)
--domain Custom domain (empty = auto-generated)
--public Make app publicly accessible (default true)
--dockerfile Path to Dockerfile (auto-generated if absent)
-w, --wizard Interactive guided setup
--no-ai Disable AI-assisted detection
--ai-key GenAI API key for AI-assisted detection (or GY_AI_KEY)

View and modify app settings without redeploying.

Aliases: cfg, edit, settings

Terminal window
gy config [show]
gy config set tier <t1|t2|t3>
gy config set public <on|off>
gy config set domain <name>
gy config set port <number>
gy config set env KEY=VALUE
gy config unset env KEY
gy config sync

List your apps, projects, or integrations.

Aliases: ls

Terminal window
gy list [apps|projects|integrations] [flags]

Show detailed information about an app or project by name.

Aliases: inspect, show, get

Terminal window
gy info [NAME] [flags]
Flag Description
--project Look up a project instead of an app
--id Look up by UUID directly

Stream real-time logs.

Aliases: log, o

Terminal window
gy logs [NAME] [flags]
Flag Description
-n, --tail Lines to show from the end (default 100)
--follow Follow output continuously (default true)
--no-follow Print recent logs and exit
--previous Show logs from previous container runs

Expose local services to the internet.

Aliases: t, tun

Terminal window
gy tunnel start <name> --port <port>
gy tunnel list

Delete an app, project, or integration.

Aliases: rm, remove, del

Terminal window
gy delete <app|project|integration> <NAME> [flags]
Flag Description
--force Skip confirmation prompt
--id Delete by resource UUID instead of name

Log in to your account.

Aliases: l

Terminal window
gy login [--email <email>] [--password <password>]

Create a new account.

Aliases: register

Terminal window
gy signup [--email <email>] [--password <password>]

Show current login status.

Aliases: status, me

Terminal window
gy whoami

Clear your authentication credentials.

Aliases: lo

Terminal window
gy logout

Show the CLI version and check for updates.

Aliases: v, ver

Terminal window
gy version [--no-check]

Generate an autocompletion script for your shell.

Terminal window
gy completion bash
gy completion zsh
gy completion fish