Koyeb CLI Reference

Discover all the commands available via the Koyeb CLI and how to use them to interact with the Koyeb serverless platform directly from the terminal.

The Koyeb CLI allows you to interact with Koyeb directly from the terminal. This documentation references all commands and options available in the CLI.

If you have not installed the Koyeb CLI yet, please read the installation guide.

koyeb

Koyeb CLI

Options

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -h, --help help for koyeb -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb apps

Apps

Options

-h, --help help for apps

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb apps create

Create app

koyeb apps create NAME [flags]

Options

-h, --help help for create

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb apps delete

Delete app

koyeb apps delete NAME [flags]

Options

-f, --force Force delete app and services -h, --help help for delete

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb apps describe

Describe app

koyeb apps describe NAME [flags]

Options

-h, --help help for describe

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb apps get

Get app

koyeb apps get NAME [flags]

Options

-h, --help help for get

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb apps init

Create app and service

koyeb apps init NAME [flags]

Options

--docker string Docker image --docker-args strings Docker args --docker-command string Docker command --docker-private-registry-secret string Docker private registry secret --env strings Env --git string Git repository --git-branch string Git branch -h, --help help for init --instance-type string Instance type (default "nano") --max-scale int Max scale (default 1) --min-scale int Min scale (default 1) --ports strings Ports (default [80:http]) --regions strings Regions (default [par]) --routes strings Ports (default [/:80])

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb apps list

List apps

koyeb apps list [flags]

Options

-h, --help help for list

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb apps update

Update app

koyeb apps update NAME [flags]

Options

-h, --help help for update -n, --name string Name of the app

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb deployments

Deployments

Options

-h, --help help for deployments

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb deployments describe

Describe deployment

koyeb deployments describe NAME [flags]

Options

-h, --help help for describe

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb deployments get

Get deployment

koyeb deployments get NAME [flags]

Options

-h, --help help for get

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb deployments list

List deployments

koyeb deployments list [flags]

Options

-h, --help help for list

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb deployments logs

Get deployment logs

koyeb deployments logs NAME [flags]

Options

-h, --help help for logs -t, --type string Type of log (runtime,build)

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb domains

Domains

Options

-h, --help help for domains

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb domains attach

Attach a custom domain to an existing app

koyeb domains attach NAME APP [flags]

Options

-h, --help help for attach

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb domains create

Create domain

koyeb domains create NAME [flags]

Options

--attach-to string Upon creation, assign to given app -h, --help help for create

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb domains delete

Delete domain

koyeb domains delete [flags]

Options

-h, --help help for delete

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb domains describe

Describe domain

koyeb domains describe [flags]

Options

-h, --help help for describe

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb domains detach

Detach a custom domain from the app it is currently attached to

koyeb domains detach NAME [flags]

Options

-h, --help help for detach

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb domains get

Get domain

koyeb domains get NAME [flags]

Options

-h, --help help for get

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb domains list

List domains

koyeb domains list [flags]

Options

-h, --help help for list

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb domains refresh

Refresh a custom domain verification status

koyeb domains refresh NAME [flags]

Options

-h, --help help for refresh

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb instances

Instances

Options

-h, --help help for instances

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb instances describe

Describe instance

koyeb instances describe NAME [flags]

Options

-h, --help help for describe

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb instances exec

Run a command in the context of an instance

koyeb instances exec NAME CMD -- [args...] [flags]

Options

-h, --help help for exec

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb instances get

Get instance

koyeb instances get NAME [flags]

Options

-h, --help help for get

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb instances list

List instances

koyeb instances list [flags]

Options

--app string Filter on App id or name -h, --help help for list --service string Filter on Service id or name

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb instances logs

Get instance logs

koyeb instances logs NAME [flags]

Options

-h, --help help for logs

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb login

Login to your Koyeb account

koyeb login [flags]

Options

-h, --help help for login

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb secrets

Secrets

Options

-h, --help help for secrets

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb secrets create

Create secret

koyeb secrets create NAME [flags]

Options

-h, --help help for create -v, --value string Secret Value --value-from-stdin Secret Value from stdin

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb secrets delete

Delete secret

koyeb secrets delete NAME [flags]

Options

-h, --help help for delete

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb secrets describe

Describe secret

koyeb secrets describe NAME [flags]

Options

-h, --help help for describe

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb secrets get

Get secret

koyeb secrets get NAME [flags]

Options

-h, --help help for get

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb secrets list

List secrets

koyeb secrets list [flags]

Options

-h, --help help for list

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb secrets update

Update secret

koyeb secrets update NAME [flags]

Options

-h, --help help for update -v, --value string Secret Value --value-from-stdin Secret Value from stdin

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb services

Services

Options

-h, --help help for services

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb services create

Create service

koyeb services create NAME [flags]

Options

-a, --app string App --docker string Docker image --docker-args strings Docker args --docker-command string Docker command --docker-private-registry-secret string Docker private registry secret --env strings Env --git string Git repository --git-branch string Git branch -h, --help help for create --instance-type string Instance type (default "nano") --max-scale int Max scale (default 1) --min-scale int Min scale (default 1) --ports strings Ports (default [80:http]) --regions strings Regions (default [par]) --routes strings Ports (default [/:80])

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb services delete

Delete service

koyeb services delete NAME [flags]

Options

-h, --help help for delete

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb services describe

Describe service

koyeb services describe NAME [flags]

Options

-h, --help help for describe

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb services get

Get service

koyeb services get NAME [flags]

Options

-h, --help help for get

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb services list

List services

koyeb services list [flags]

Options

-a, --app string App -h, --help help for list -n, --name string Service name

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb services logs

Get the service logs

koyeb services logs NAME [flags]

Options

-h, --help help for logs --instance string Instance -t, --type string Type (runtime,build)

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb services redeploy

Redeploy service

koyeb services redeploy NAME [flags]

Options

-h, --help help for redeploy

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb services update

Update service

koyeb services update NAME [flags]

Options

--docker string Docker image --docker-args strings Docker args --docker-command string Docker command --docker-private-registry-secret string Docker private registry secret --env strings Env --git string Git repository --git-branch string Git branch -h, --help help for update --instance-type string Instance type (default "nano") --max-scale int Max scale (default 1) --min-scale int Min scale (default 1) --ports strings Ports (default [80:http]) --regions strings Regions (default [par]) --routes strings Ports (default [/:80])

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")

koyeb version

Get version

koyeb version [flags]

Options

-h, --help help for version

Options inherited from parent commands

-c, --config string config file (default is $HOME/.koyeb.yaml) -d, --debug debug --full show full id -o, --output string output format (yaml,json,table) --token string API token --url string url of the api (default "https://app.koyeb.com")