Command reference
The complete reference for the Ghaymah CLI (gy).
Global flags
Section titled “Global flags”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 |
gy deploy
Section titled “gy deploy”Deploy your app. Auto-detects the stack, generates a Dockerfile if needed, and ships.
Aliases: d, push, up
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) |
gy config
Section titled “gy config”View and modify app settings without redeploying.
Aliases: cfg, edit, settings
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=VALUEgy config unset env KEYgy config syncgy list
Section titled “gy list”List your apps, projects, or integrations.
Aliases: ls
gy list [apps|projects|integrations] [flags]gy info
Section titled “gy info”Show detailed information about an app or project by name.
Aliases: inspect, show, get
gy info [NAME] [flags]| Flag | Description |
|---|---|
--project |
Look up a project instead of an app |
--id |
Look up by UUID directly |
gy logs
Section titled “gy logs”Stream real-time logs.
Aliases: log, o
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 |
gy tunnel
Section titled “gy tunnel”Expose local services to the internet.
Aliases: t, tun
gy tunnel start <name> --port <port>gy tunnel listgy delete
Section titled “gy delete”Delete an app, project, or integration.
Aliases: rm, remove, del
gy delete <app|project|integration> <NAME> [flags]| Flag | Description |
|---|---|
--force |
Skip confirmation prompt |
--id |
Delete by resource UUID instead of name |
gy login
Section titled “gy login”Log in to your account.
Aliases: l
gy login [--email <email>] [--password <password>]gy signup
Section titled “gy signup”Create a new account.
Aliases: register
gy signup [--email <email>] [--password <password>]gy whoami
Section titled “gy whoami”Show current login status.
Aliases: status, me
gy whoamigy logout
Section titled “gy logout”Clear your authentication credentials.
Aliases: lo
gy logoutgy version
Section titled “gy version”Show the CLI version and check for updates.
Aliases: v, ver
gy version [--no-check]gy completion
Section titled “gy completion”Generate an autocompletion script for your shell.
gy completion bashgy completion zshgy completion fish