Every command here also takes the global flags, returns the exit codes, and prints the JSON envelope with --json.
ghaym cloud services list
List a project's services.
Usage
ghaym cloud services list <project> [flags]
| Argument | Required |
|---|
<project> | Yes |
| Flag | What it does |
|---|
--limit <n> | maximum rows to return |
--offset <n> | rows to skip |
Show one service, by id, slug or name.
Usage
ghaym cloud services get <service>
| Argument | Required |
|---|
<service> | Yes |
ghaym cloud services create
Launch a service in a project.
Usage
ghaym cloud services create --project <project> --type <type> [flags]
| Flag | What it does |
|---|
--project <project> | Requiredproject, by id or slug |
--type <type> | Requiredgit, database or cache; an engine slug alone, such as mysql, stands for its own type |
--engine <slug> | engine for a database or cache, such as postgres or mysql; ghaym cloud engines list lists them |
--name <name> | service name; derived from the repo or type when omitted |
--repo <owner/name> | GitHub repo for a git service |
--env <env> | environment to launch into, by name or id |
--db-version <version> | engine version for a database or cache |
--size <slug> | instance size slug for a git service; required for git |
--db-size <slug> | size for a database or cache; ghaym cloud regions sizes <region> --database lists them |
--replicas <n> | copies to run for a web service |
--site <slug> | site the service runs in; ghaym cloud regions list lists them |
Add a service to another environment of its project, by id, slug or name.
Usage
ghaym cloud services add <service> --env <env> --from <env> [flags]
| Argument | Required |
|---|
<service> | Yes |
| Flag | What it does |
|---|
--env <env> | Requiredenvironment to add it to, by name or id |
--from <env> | Requiredenvironment it runs in, by name or id; its settings are copied |
--site <slug> | site to run it in; the source environment's site when omitted |
ghaym cloud services delete
Delete a service from one environment, by id, slug or name.
Usage
ghaym cloud services delete <service> --env <env> [flags]
| Argument | Required |
|---|
<service> | Yes |
| Flag | What it does |
|---|
--env <env> | Requiredenvironment to delete it from, by name or id |
--apply | publish now instead of leaving the change staged |
ghaym cloud services redeploy
Deploy a service again, by id, slug or name.
Usage
ghaym cloud services redeploy <service> [flags]
| Argument | Required |
|---|
<service> | Yes |
| Flag | What it does |
|---|
--branch <branch> | git branch to deploy |
--message <text> | commit message to record |
ghaym cloud services scale
Stage a change to replicas, readers or routing.
Usage
ghaym cloud services scale <service> [flags]
| Argument | Required |
|---|
<service> | Yes |
| Flag | What it does |
|---|
--replicas <n> | copies of a web service |
--readers <n> | read replicas of a database |
--routing <mode> | how requests reach the replicas: equal or same_visitor |
--env <env> | environment name or id; production when omitted |
--apply | publish now instead of leaving the change staged |
Stage build and runtime settings as key=value pairs.
Usage
ghaym cloud services set <service> <assignments...> [flags]
| Argument | Required |
|---|
<service> | Yes |
<assignments...> | Yes, one or more |
| Flag | What it does |
|---|
--env <env> | environment name or id; production when omitted |
--apply | publish now instead of leaving the change staged |
ghaym cloud services logs
Tail runtime logs live across every replica.
Usage
ghaym cloud services logs <service> [flags]
| Argument | Required |
|---|
<service> | Yes |
| Flag | What it does |
|---|
--env <env> | environment name or id; production when omitted |
--project <project> | project the service is in, when its name is in several |
-f, --follow | keep the stream open while the service is asleep |
ghaym cloud services metrics
Show CPU, memory and request metrics.
Usage
ghaym cloud services metrics <service> [flags]
| Argument | Required |
|---|
<service> | Yes |
| Flag | What it does |
|---|
--env <env> | environment name or id; production when omitted |
ghaym cloud services connection
Show how services in the project reach a database, and the tunnel command.
Usage
ghaym cloud services connection <service> [flags]
| Argument | Required |
|---|
<service> | Yes |
| Flag | What it does |
|---|
--env <env> | environment name or id; production when omitted |
ghaym cloud services resolved-env
Show the variables a container in this service's site starts with.
Usage
ghaym cloud services resolved-env <service> [flags]
| Argument | Required |
|---|
<service> | Yes |
| Flag | What it does |
|---|
--show | print values instead of masking them |
--env <env> | environment name or id; production when omitted |
ghaym cloud services retry-provisioning
Retry a database whose provisioning failed.
Usage
ghaym cloud services retry-provisioning <service>
| Argument | Required |
|---|
<service> | Yes |