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 CLI
-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
koyeb deployments - Deployments
koyeb domains - Domains
koyeb instances - Instances
koyeb login - Login to your Koyeb account
koyeb secrets - Secrets
koyeb services - Services
koyeb version - Get version
Login to your Koyeb account
koyeb login [flags]
-h, --help help for login
-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")
Apps
-h, --help help for apps
-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")
Create app
koyeb apps create NAME [flags]
-h, --help help for create
-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")
Delete app
koyeb apps delete NAME [flags]
-h, --help help for delete
-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")
Describe app
koyeb apps describe NAME [flags]
-h, --help help for describe
-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")
Get app
koyeb apps get NAME [flags]
-h, --help help for get
-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")
Create app and service
koyeb apps init NAME [flags]
--checks strings HTTP healthcheck (<port>:http:<path>) and TCP healthcheck (<port>:tcp) - Available for "WEB" service only --docker string Docker image --docker-args strings Docker args --docker-command string Docker command --docker-entrypoint strings Docker entrypoint --docker-private-registry-secret string Docker private registry secret --env strings Env --git string Git repository --git-branch string Git branch --git-build-command string Buid command (legacy, prefer git-buildpack-build-command) --git-builder string Builder to use, either "buildpack" (default) or "docker" (default "buildpack") --git-buildpack-build-command string Buid command --git-buildpack-run-command string Run command --git-docker-args strings Arguments for the Docker CMD --git-docker-command string Docker CMD --git-docker-dockerfile string Dockerfile path --git-docker-entrypoint strings Docker entrypoint --git-docker-target string Docker target --git-no-deploy-on-push Disable new deployments creation when code changes are pushed on the configured branch --git-run-command string Run command (legacy, prefer git-buildpack-run-command) --git-workdir string Path to the sub-directory containing the code to build and deploy -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 - Available for "WEB" service only (default [80:http]) --regions strings Regions (default [fra]) --routes strings Routes - Available for "WEB" service only (default [/:80]) --type string Service type, either "WEB" or "WORKER" (default "WEB")
-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")
List apps
koyeb apps list [flags]
-h, --help help for list
-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")
Pause app
koyeb apps pause NAME [flags]
-h, --help help for pause
-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")
Resume app
koyeb apps resume NAME [flags]
-h, --help help for resume
-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")
Update app
koyeb apps update NAME [flags]
-h, --help help for update -n, --name string Name of the app
-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")
Domains
-h, --help help for domains
-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")
Attach a custom domain to an existing app
koyeb domains attach NAME APP [flags]
-h, --help help for attach
-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")
Create domain
koyeb domains create NAME [flags]
--attach-to string Upon creation, assign to given app -h, --help help for create
-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")
Delete domain
koyeb domains delete [flags]
-h, --help help for delete
-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")
Describe domain
koyeb domains describe [flags]
-h, --help help for describe
-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")
Detach a custom domain from the app it is currently attached to
koyeb domains detach NAME [flags]
-h, --help help for detach
-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")
Get domain
koyeb domains get NAME [flags]
-h, --help help for get
-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")
List domains
koyeb domains list [flags]
-h, --help help for list
-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")
Refresh a custom domain verification status
koyeb domains refresh NAME [flags]
-h, --help help for refresh
-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")
Secrets
-h, --help help for secrets
-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")
Create secret
koyeb secrets create NAME [flags]
-h, --help help for create -v, --value string Secret Value --value-from-stdin Secret Value from stdin
-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")
Delete secret
koyeb secrets delete NAME [flags]
-h, --help help for delete
-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")
Describe secret
koyeb secrets describe NAME [flags]
-h, --help help for describe
-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")
Get secret
koyeb secrets get NAME [flags]
-h, --help help for get
-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")
List secrets
koyeb secrets list [flags]
-h, --help help for list
-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")
Update secret
koyeb secrets update NAME [flags]
-h, --help help for update -v, --value string Secret Value --value-from-stdin Secret Value from stdin
-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")
Services
-h, --help help for services
-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")
Create service
koyeb services create NAME [flags]
-a, --app string App --checks strings HTTP healthcheck (<port>:http:<path>) and TCP healthcheck (<port>:tcp) - Available for "WEB" service only --docker string Docker image --docker-args strings Docker args --docker-command string Docker command --docker-entrypoint strings Docker entrypoint --docker-private-registry-secret string Docker private registry secret --env strings Env --git string Git repository --git-branch string Git branch --git-build-command string Buid command (legacy, prefer git-buildpack-build-command) --git-builder string Builder to use, either "buildpack" (default) or "docker" (default "buildpack") --git-buildpack-build-command string Buid command --git-buildpack-run-command string Run command --git-docker-args strings Arguments for the Docker CMD --git-docker-command string Docker CMD --git-docker-dockerfile string Dockerfile path --git-docker-entrypoint strings Docker entrypoint --git-docker-target string Docker target --git-no-deploy-on-push Disable new deployments creation when code changes are pushed on the configured branch --git-run-command string Run command (legacy, prefer git-buildpack-run-command) --git-workdir string Path to the sub-directory containing the code to build and deploy -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 - Available for "WEB" service only (default [80:http]) --regions strings Regions (default [fra]) --routes strings Routes - Available for "WEB" service only (default [/:80]) --type string Service type, either "WEB" or "WORKER" (default "WEB")
-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")
Delete service
koyeb services delete NAME [flags]
-h, --help help for delete
-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")
Describe service
koyeb services describe NAME [flags]
-h, --help help for describe
-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")
Get service
koyeb services get NAME [flags]
-h, --help help for get
-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")
List services
koyeb services list [flags]
-a, --app string App -h, --help help for list -n, --name string Service name
-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")
Get the service logs
koyeb services logs NAME [flags]
-h, --help help for logs --instance string Instance -t, --type string Type (runtime,build)
-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")
Pause service
koyeb services pause NAME [flags]
-h, --help help for pause
-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")
Redeploy service
koyeb services redeploy NAME [flags]
-h, --help help for redeploy --use-cache Use cache to redeploy
-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")
Resume service
koyeb services resume NAME [flags]
-h, --help help for resume
-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")
Update service
koyeb services update NAME [flags]
--checks strings HTTP healthcheck (<port>:http:<path>) and TCP healthcheck (<port>:tcp) - Available for "WEB" service only --docker string Docker image --docker-args strings Docker args --docker-command string Docker command --docker-entrypoint strings Docker entrypoint --docker-private-registry-secret string Docker private registry secret --env strings Env --git string Git repository --git-branch string Git branch --git-build-command string Buid command (legacy, prefer git-buildpack-build-command) --git-builder string Builder to use, either "buildpack" (default) or "docker" (default "buildpack") --git-buildpack-build-command string Buid command --git-buildpack-run-command string Run command --git-docker-args strings Arguments for the Docker CMD --git-docker-command string Docker CMD --git-docker-dockerfile string Dockerfile path --git-docker-entrypoint strings Docker entrypoint --git-docker-target string Docker target --git-no-deploy-on-push Disable new deployments creation when code changes are pushed on the configured branch --git-run-command string Run command (legacy, prefer git-buildpack-run-command) --git-workdir string Path to the sub-directory containing the code to build and deploy -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 - Available for "WEB" service only (default [80:http]) --regions strings Regions (default [fra]) --routes strings Routes - Available for "WEB" service only (default [/:80]) --type string Service type, either "WEB" or "WORKER" (default "WEB")
-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")
Deployments
-h, --help help for deployments
-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")
Cancel deployment
koyeb deployments cancel NAME [flags]
-h, --help help for cancel
-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")
Describe deployment
koyeb deployments describe NAME [flags]
-h, --help help for describe
-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")
Get deployment
koyeb deployments get NAME [flags]
-h, --help help for get
-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")
List deployments
koyeb deployments list [flags]
-h, --help help for list
-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")
Get deployment logs
koyeb deployments logs NAME [flags]
-h, --help help for logs -t, --type string Type of log (runtime,build)
-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")
Instances
-h, --help help for instances
-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")
Describe instance
koyeb instances describe NAME [flags]
-h, --help help for describe
-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")
Run a command in the context of an instance
koyeb instances exec NAME CMD -- [args...] [flags]
-h, --help help for exec
-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")
Get instance
koyeb instances get NAME [flags]
-h, --help help for get
-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")
List instances
koyeb instances list [flags]
--app string Filter on App id or name -h, --help help for list --service string Filter on Service id or name
-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")
Get instance logs
koyeb instances logs NAME [flags]
-h, --help help for logs
-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")
Get version
koyeb version [flags]
-h, --help help for version
-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")