Build & Deploy
CLI
Reference

Koyeb CLI Reference

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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
  -h, --help                  help for koyeb
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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

  -h, --help   help for delete

Options inherited from parent commands

  -c, --config string         config file (default is $HOME/.koyeb.yaml)
  -d, --debug                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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

      --checks strings                          Update service healthchecks (available for services of type "web" only)
                                                For HTTP healthchecks, use the format <PORT>:http:<PATH>, for example --checks 8080:http:/health
                                                For TCP healthchecks, use the format <PORT>:tcp, for example --checks 8080:tcp
                                                To delete a healthcheck, use !PORT, for example --checks '!8080'
                                                
      --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                             Update service environment variables using the format KEY=VALUE, for example --env FOO=bar
                                                To use the value of a secret as an environment variable, specify the secret name preceded by @, for example --env FOO=@bar
                                                To delete an environment variable, prefix its name with '!', for example --env '!FOO'
                                                
      --git string                              Git repository
      --git-branch string                       Git branch (default "main")
      --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                           Update service ports (available for services of type "web" only) using the format PORT[:PROTOCOL], for example --port 8080:http
                                                PROTOCOL defaults to "http". Supported protocols are "http" and "http2"
                                                To delete an exposed port, prefix its number with '!', for example --port '!80'
                                                
      --privileged                              Whether the service container should run in privileged mode
      --regions strings                         Add a region where the service is deployed. You can specify this flag multiple times to deploy the service in multiple regions.
                                                To update a service and remove a region, prefix the region name with '!', for example --region '!par'
                                                If the region is not specified on service creation, the service is deployed in fra
                                                
      --routes strings                          Update service routes (available for services of type "web" only) using the format PATH[:PORT], for example '/foo:8080'
                                                PORT defaults to 8000
                                                To delete a route, use '!PATH', for example --route '!/foo'
                                                
      --scale int                               Set both min-scale and max-scale (default 1)
      --type string                             Service type, either "web" or "worker" (default "web")

Options inherited from parent commands

  -c, --config string         config file (default is $HOME/.koyeb.yaml)
  -d, --debug                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         output format (yaml,json,table)
      --token string          API token
      --url string            url of the api (default "https://app.koyeb.com")

koyeb apps pause

Pause app

koyeb apps pause NAME [flags]

Options

  -h, --help   help for pause

Options inherited from parent commands

  -c, --config string         config file (default is $HOME/.koyeb.yaml)
  -d, --debug                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         output format (yaml,json,table)
      --token string          API token
      --url string            url of the api (default "https://app.koyeb.com")

koyeb apps resume

Resume app

koyeb apps resume NAME [flags]

Options

  -h, --help   help for resume

Options inherited from parent commands

  -c, --config string         config file (default is $HOME/.koyeb.yaml)
  -d, --debug                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         output format (yaml,json,table)
      --token string          API token
      --url string            url of the api (default "https://app.koyeb.com")

koyeb organizations

Organization

Options

  -h, --help   help for organizations

Options inherited from parent commands

  -c, --config string         config file (default is $HOME/.koyeb.yaml)
  -d, --debug                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         output format (yaml,json,table)
      --token string          API token
      --url string            url of the api (default "https://app.koyeb.com")

koyeb organizations list

List organizations

koyeb organizations 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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         output format (yaml,json,table)
      --token string          API token
      --url string            url of the api (default "https://app.koyeb.com")

koyeb organizations switch

Switch the CLI context to another organization

koyeb organizations switch [flags]

Options

  -h, --help   help for switch

Options inherited from parent commands

  -c, --config string         config file (default is $HOME/.koyeb.yaml)
  -d, --debug                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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
      --registry-keyfile string    Registry URL. Only valid with --type=registry-gcp, otherwise ignored
      --registry-name string       Registry name. Only valid with --type=registry-azure, otherwise ignored
      --registry-url string        Registry URL. Only valid with --type=registry-private and --type=registry-gcp, otherwise ignored
      --registry-username string   Registry username. Only valid with --type=registry-*
      --type type                  Secret type (simple, registry-dockerhub, registry-private, registry-digital-ocean, registry-gitlab, registry-gcp, registry-azure) (default simple)
  -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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         output format (yaml,json,table)
      --token string          API token
      --url string            url of the api (default "https://app.koyeb.com")

koyeb secrets reveal

Show secret value

koyeb secrets reveal NAME [flags]

Options

  -h, --help   help for reveal

Options inherited from parent commands

  -c, --config string         config file (default is $HOME/.koyeb.yaml)
  -d, --debug                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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
      --registry-keyfile string    Registry URL. Only valid with --type=registry-gcp, otherwise ignored
      --registry-name string       Registry name. Only valid with --type=registry-azure, otherwise ignored
      --registry-url string        Registry URL. Only valid with --type=registry-private and --type=registry-gcp, otherwise ignored
      --registry-username string   Registry username. Only valid with --type=registry-*
  -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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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]

Examples


# Deploy a nginx docker image, listening on port 80
$> koyeb service create myservice --app myapp --docker nginx --port 80

# Build and deploy a GitHub repository using buildpack (default), set the environment variable PORT, and expose the port 9000 to the root route
$> koyeb service create myservice --app myapp --git github.com/koyeb/example-flask --git-branch main --env PORT=9000 --port 9000:http --route /:9000

# Build and deploy a GitHub repository using docker
$> koyeb service create myservice --app myapp --git github.com/org/name --git-branch main --git-builder docker

Options

  -a, --app string                              Service application
      --checks strings                          Update service healthchecks (available for services of type "web" only)
                                                For HTTP healthchecks, use the format <PORT>:http:<PATH>, for example --checks 8080:http:/health
                                                For TCP healthchecks, use the format <PORT>:tcp, for example --checks 8080:tcp
                                                To delete a healthcheck, use !PORT, for example --checks '!8080'
                                                
      --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                             Update service environment variables using the format KEY=VALUE, for example --env FOO=bar
                                                To use the value of a secret as an environment variable, specify the secret name preceded by @, for example --env FOO=@bar
                                                To delete an environment variable, prefix its name with '!', for example --env '!FOO'
                                                
      --git string                              Git repository
      --git-branch string                       Git branch (default "main")
      --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                           Update service ports (available for services of type "web" only) using the format PORT[:PROTOCOL], for example --port 8080:http
                                                PROTOCOL defaults to "http". Supported protocols are "http" and "http2"
                                                To delete an exposed port, prefix its number with '!', for example --port '!80'
                                                
      --privileged                              Whether the service container should run in privileged mode
      --regions strings                         Add a region where the service is deployed. You can specify this flag multiple times to deploy the service in multiple regions.
                                                To update a service and remove a region, prefix the region name with '!', for example --region '!par'
                                                If the region is not specified on service creation, the service is deployed in fra
                                                
      --routes strings                          Update service routes (available for services of type "web" only) using the format PATH[:PORT], for example '/foo:8080'
                                                PORT defaults to 8000
                                                To delete a route, use '!PATH', for example --route '!/foo'
                                                
      --scale int                               Set both min-scale and max-scale (default 1)
      --type string                             Service type, either "web" or "worker" (default "web")

Options inherited from parent commands

  -c, --config string         config file (default is $HOME/.koyeb.yaml)
  -d, --debug                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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

  -a, --app string   Service application
  -h, --help         help for delete

Options inherited from parent commands

  -c, --config string         config file (default is $HOME/.koyeb.yaml)
  -d, --debug                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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

  -a, --app string   Service application
  -h, --help         help for describe

Options inherited from parent commands

  -c, --config string         config file (default is $HOME/.koyeb.yaml)
  -d, --debug                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         output format (yaml,json,table)
      --token string          API token
      --url string            url of the api (default "https://app.koyeb.com")

koyeb services exec

Run a command in the context of an instance selected among the service instances

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

Options

  -a, --app string   Service application
  -h, --help         help for exec

Options inherited from parent commands

  -c, --config string         config file (default is $HOME/.koyeb.yaml)
  -d, --debug                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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

  -a, --app string   Service application
  -h, --help         help for get

Options inherited from parent commands

  -c, --config string         config file (default is $HOME/.koyeb.yaml)
  -d, --debug                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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

  -a, --app string        Service application
  -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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         output format (yaml,json,table)
      --token string          API token
      --url string            url of the api (default "https://app.koyeb.com")

koyeb services pause

Pause service

koyeb services pause NAME [flags]

Options

  -a, --app string   Service application
  -h, --help         help for pause

Options inherited from parent commands

  -c, --config string         config file (default is $HOME/.koyeb.yaml)
  -d, --debug                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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

  -a, --app string   Service application
  -h, --help         help for redeploy
      --use-cache    Use cache to redeploy

Options inherited from parent commands

  -c, --config string         config file (default is $HOME/.koyeb.yaml)
  -d, --debug                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         output format (yaml,json,table)
      --token string          API token
      --url string            url of the api (default "https://app.koyeb.com")

koyeb services resume

Resume service

koyeb services resume NAME [flags]

Options

  -a, --app string   Service application
  -h, --help         help for resume

Options inherited from parent commands

  -c, --config string         config file (default is $HOME/.koyeb.yaml)
  -d, --debug                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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]

Examples


# Update the service "myservice" in the app "myapp", upsert the environment variable PORT and delete the environment variable DEBUG
$> koyeb service update myapp/myservice --env PORT=8001 --env '!DEBUG'

Options

  -a, --app string                              Service application
      --checks strings                          Update service healthchecks (available for services of type "web" only)
                                                For HTTP healthchecks, use the format <PORT>:http:<PATH>, for example --checks 8080:http:/health
                                                For TCP healthchecks, use the format <PORT>:tcp, for example --checks 8080:tcp
                                                To delete a healthcheck, use !PORT, for example --checks '!8080'
                                                
      --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                             Update service environment variables using the format KEY=VALUE, for example --env FOO=bar
                                                To use the value of a secret as an environment variable, specify the secret name preceded by @, for example --env FOO=@bar
                                                To delete an environment variable, prefix its name with '!', for example --env '!FOO'
                                                
      --git string                              Git repository
      --git-branch string                       Git branch (default "main")
      --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)
      --override                                Override the service configuration with the new configuration instead of merging them
      --ports strings                           Update service ports (available for services of type "web" only) using the format PORT[:PROTOCOL], for example --port 8080:http
                                                PROTOCOL defaults to "http". Supported protocols are "http" and "http2"
                                                To delete an exposed port, prefix its number with '!', for example --port '!80'
                                                
      --privileged                              Whether the service container should run in privileged mode
      --regions strings                         Add a region where the service is deployed. You can specify this flag multiple times to deploy the service in multiple regions.
                                                To update a service and remove a region, prefix the region name with '!', for example --region '!par'
                                                If the region is not specified on service creation, the service is deployed in fra
                                                
      --routes strings                          Update service routes (available for services of type "web" only) using the format PATH[:PORT], for example '/foo:8080'
                                                PORT defaults to 8000
                                                To delete a route, use '!PATH', for example --route '!/foo'
                                                
      --scale int                               Set both min-scale and max-scale (default 1)
      --type string                             Service type, either "web" or "worker" (default "web")

Options inherited from parent commands

  -c, --config string         config file (default is $HOME/.koyeb.yaml)
  -d, --debug                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         output format (yaml,json,table)
      --token string          API token
      --url string            url of the api (default "https://app.koyeb.com")

koyeb deployments cancel

Cancel deployment

koyeb deployments cancel NAME [flags]

Options

  -h, --help   help for cancel

Options inherited from parent commands

  -c, --config string         config file (default is $HOME/.koyeb.yaml)
  -d, --debug                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         output format (yaml,json,table)
      --token string          API token
      --url string            url of the api (default "https://app.koyeb.com")

koyeb databases create

Create database

koyeb databases create NAME [flags]

Options

      --db-name string    Database name (default "koyebdb")
      --db-owner string   Database owner (default "koyeb-adm")
  -h, --help              help for create
      --pg-version int    PostgreSQL version (default 16)
      --region string     Region where the database is deployed (default "fra")

Options inherited from parent commands

  -c, --config string         config file (default is $HOME/.koyeb.yaml)
  -d, --debug                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         output format (yaml,json,table)
      --token string          API token
      --url string            url of the api (default "https://app.koyeb.com")

koyeb databases delete

Delete database

koyeb databases 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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         output format (yaml,json,table)
      --token string          API token
      --url string            url of the api (default "https://app.koyeb.com")

koyeb databases get

Get database

koyeb databases 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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         output format (yaml,json,table)
      --token string          API token
      --url string            url of the api (default "https://app.koyeb.com")

koyeb databases list

List databases

koyeb databases 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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         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                 enable the debug output
      --debug-full            do not hide sensitive information (tokens) in the debug output
      --force-ascii           only output ascii characters (no unicode emojis)
      --full                  do not truncate output
      --organization string   organization ID
  -o, --output output         output format (yaml,json,table)
      --token string          API token
      --url string            url of the api (default "https://app.koyeb.com")
InstallationPrivate Container Registry Secrets