Get started

CLI reference

This page is generated from the keel command tree (make site-gen), so it matches the CLI of this release. Run keel <command> --help for the same text in your terminal.

keel

keel is the command line interface of keel.run, the EU developer cloud.

Every command supports --json for machine-readable output. Exit codes: 0 ok, 1 error, 2 usage/not linked, 3 not logged in, 4 forbidden, 5 not found, 6 invalid/conflict, 7 temporary (retry), 8 deployment failed, 9 waiting for approval; keel run exits with the command's exit code.

Usage:
  keel [command]

Available Commands:
  approvals   List requests of agents that wait for (or got) a person's approval
  billing     Plan and costs of the workspace (needs billing:read; changes need admin)
  completion  Generate the autocompletion script for the specified shell
  config      Show the service's source, build and runtime settings
  db          Manage databases of the environment
  deploy      Upload and deploy the linked directory (or a git commit with --git)
  diagnose    Explain why a deployment failed or is unhealthy, with concrete fixes
  dns         Manage keel DNS zones, records, DNSSEC and TSIG keys
  domains     Manage the service's domains
  env         Manage environment variables
  help        Help about any command
  kv          Manage serverless Valkey (Redis-compatible) databases of the environment
  link        Link this directory to a project, environment and service
  login       Log in (opens the browser; --token for CI)
  logout      Revoke and forget the stored token
  logs        Show runtime logs of the service, or a deployment's build log
  mail        Manage mail domains, mailboxes, aliases and app sending
  open        Open the linked service (or a deployment) in the dashboard
  previews    Preview environments of pull requests
  projects    List the projects of the workspace
  rollback    Roll back to an earlier deployment (default: the previous one)
  run         Run a command once in the service's image (like heroku run)
  runs        List one-off and scheduled runs of the service
  services    List the services of the environment
  status      Show the linked service: deployments, runtime and domains
  tokens      Manage API tokens of the workspace (needs admin)
  version     Show the CLI version and whether a newer release is available
  whoami      Show the logged-in user, token scopes and linked service

Flags:
      --api-url string       API URL (env KEEL_API_URL, default https://api.keel.run)
  -e, --environment string   environment ID or name (default: linked)
  -h, --help                 help for keel
      --json                 print machine-readable JSON
      --project string       project ID or name (default: linked)
  -s, --service string       service ID or name (default: linked)
  -v, --version              version for keel
      --workspace string     workspace ID (env KEEL_WORKSPACE; default: linked or only workspace)
  -y, --yes                  do not ask for confirmation (non-interactive)

Use "keel [command] --help" for more information about a command.

keel approvals

List requests of agents that wait for (or got) a person's approval

Usage:
  keel approvals [flags]
  keel approvals [command]

Available Commands:
  get         Show an approval; --wait polls until a person decided

Flags:
  -h, --help            help for approvals
      --status string   only this status: pending, executed, failed, denied, expired

Use "keel approvals [command] --help" for more information about a command.

keel approvals get

Approvals are decided by people in the dashboard. With --wait the command polls until the request was executed, failed, denied or expired. Exit codes: 0 executed, 4 denied, 6 failed, 9 still pending (or expired).

Usage:
  keel approvals get <approval> [flags]

Flags:
  -h, --help            help for get
      --wait duration   poll until decided, at most this long (e.g. 10m)

keel billing

Plan and costs of the workspace (needs billing:read; changes need admin)

Usage:
  keel billing [command]

Available Commands:
  plan        Change the plan (upgrades are charged prorated now, downgrades credited on the next invoice)
  plans       List the plans, their limits and what blocks a downgrade
  status      Show the plan, subscription and the cost of this period

Flags:
  -h, --help   help for billing

Use "keel billing [command] --help" for more information about a command.

keel billing plan

Change the workspace's plan in place. An upgrade charges the prorated difference at once; a downgrade credits it on the next invoice and is refused while the workspace uses more than the smaller plan allows (the error lists what to reduce). The plan changes once the payment provider confirms it; --wait waits for that.

Usage:
  keel billing plan hobby|pro [flags]

Flags:
  -h, --help   help for plan
      --wait   wait until the new plan is active

keel billing plans

List the plans, their limits and what blocks a downgrade

Usage:
  keel billing plans [flags]

Flags:
  -h, --help   help for plans

keel billing status

Show the plan, subscription and the cost of this period

Usage:
  keel billing status [flags]

Flags:
  -h, --help   help for status

keel config

Show the service's source, build and runtime settings

Usage:
  keel config [flags]
  keel config [command]

Available Commands:
  set         Change settings (redeploys the service)

Flags:
  -h, --help   help for config

Use "keel config [command] --help" for more information about a command.

keel config set

Changes source, build or runtime settings of the service; only the flags you pass change. Changing source or build starts a new build, runtime changes roll out the running image again.

Examples:
  keel config set --port 3000
  keel config set --healthcheck /healthz --size m
  keel config set --builder railpack
  keel config set --start ""   # use the image's own command

Usage:
  keel config set [flags]

Flags:
      --branch string            branch to deploy
      --builder string           auto, dockerfile or railpack
      --dockerfile string        path of the Dockerfile, relative to the build root
      --healthcheck string       HTTP path for readiness checks; "" checks the TCP port only
  -h, --help                     help for set
      --image string             container image (image sources only)
      --instances int            number of instances
      --port int                 port the app listens on (also passed as PORT)
      --release-command string   command run before each rollout, e.g. migrations
      --root string              directory in the repository to build; "" for the repository root
      --size string              instance size: xs, s, m, l, xl
      --start string             start command; "" uses the image's own

keel db

Manage databases of the environment

Usage:
  keel db [command]

Available Commands:
  connect     Open psql connected to the database
  create      Create a database (default: postgres)
  list        List databases
  url         Print the connection URL (contains the password)

Flags:
  -h, --help   help for db

Use "keel db [command] --help" for more information about a command.

keel db connect

Open psql connected to the database

Usage:
  keel db connect NAME|ID [-- psql args] [flags]

Flags:
  -h, --help   help for connect

keel db create

Create a database (default: postgres)

Usage:
  keel db create NAME [flags]

Flags:
      --engine string    database engine (default "postgres")
  -h, --help             help for create
      --plan string      plan: pg-xs, pg-s (default), pg-m, pg-m-ha
      --storage int      storage in GB (default: the plan's)
      --version string   Postgres major version, 17 or 18 (default: latest)

keel db list

List databases

Usage:
  keel db list [flags]

Flags:
  -h, --help   help for list

keel db url

Print the connection URL (contains the password)

Usage:
  keel db url NAME|ID [flags]

Flags:
  -h, --help   help for url

keel deploy

In a linked directory, uploads the working tree and deploys it: files ignored by .gitignore are left out, as are .git, .env* files, node_modules and .keel (re-include them with negations such as !.env.production in a .keelignore). --dry-run lists what would be uploaded. Limits: 200 MiB compressed, 1 GiB, 50,000 files.

--git (or --commit) deploys the service's branch head (or a commit) instead; services from a container image deploy their image again. Outside a linked directory, git services deploy from git and upload services upload the current directory (or --dir).

With --watch (default on a terminal), streams the build and release log and waits until the deployment is active (exit 0) or failed (exit 8). With --json, the log goes to stderr and the final deployment to stdout.

Usage:
  keel deploy [flags]

Flags:
      --commit string      deploy this commit from git (implies --git)
      --dir string         upload this directory (default: the linked directory)
      --dry-run            list the files that would be uploaded, upload nothing
      --git                deploy the head of the service's branch from git instead of uploading
  -h, --help               help for deploy
      --timeout duration   how long --watch waits (default 30m0s)
  -w, --watch              stream the build log and wait for the result (default on a terminal)

keel diagnose

Prints the phase (build, release, rollout, runtime), a machine-readable cause (e.g. port_mismatch, missing_env_var, oom_killed), the most relevant log lines (secrets masked) and suggestions with the exact command to run. Without an argument it diagnoses the newest deployment of the linked service. Needs the logs:read scope.

Usage:
  keel diagnose [deployment] [flags]

Flags:
  -h, --help   help for diagnose

keel dns

keel DNS hosts the zones of your domains on keel's nameservers. Create a zone, set the four nameservers it shows at your registrar, and the zone becomes active once the delegation matches. Zones are given by name (example.com) or ID (zone_…); record names are relative to the zone (www, @ for the apex).

Usage:
  keel dns [command]

Available Commands:
  analytics   Queries of a zone by type and response code
  dnssec      Show the DNSSEC state and the DS record for your registrar
  export      Print the zone as a BIND zone file (without DNSSEC records)
  import      Import a BIND zone file (- reads stdin)
  query       Ask keel's answer engine about the current zone (also before delegation)
  record      Add, replace or remove an RRset (all records of one name and type)
  records     List the records (RRsets) of a zone
  tsig        TSIG keys for ACME DNS-01 and dynamic updates (RFC 2136)
  zone        Create, show, verify, change and delete a zone
  zones       List the DNS zones of the workspace

Flags:
  -h, --help   help for dns

Use "keel dns [command] --help" for more information about a command.

keel dns analytics

Queries of a zone by type and response code

Usage:
  keel dns analytics ZONE [flags]

Flags:
  -h, --help            help for analytics
      --window string   24h, 7d or 30d (default "24h")

keel dns dnssec

Show the DNSSEC state and the DS record for your registrar

Usage:
  keel dns dnssec ZONE [flags]
  keel dns dnssec [command]

Available Commands:
  disable     Turn DNSSEC off in order: remove the DS at the registrar first, then the zone goes unsigned
  enable      Sign the zone (then add the DS record at your registrar)
  rollover    Start a key rollover (KSK: you must update the DS at your registrar)

Flags:
  -h, --help   help for dnssec

Use "keel dns dnssec [command] --help" for more information about a command.

keel dns dnssec disable

Publishes the delete signal (CDS 0 3 0 AA==) and waits until the parent no longer has a DS record before serving the zone unsigned. --force (admin) switches off at once: the domain does not resolve for validating resolvers until the DS is removed.

Usage:
  keel dns dnssec disable ZONE [flags]

Flags:
      --force   switch off at once (needs admin)
  -h, --help    help for disable

keel dns dnssec enable

Sign the zone (then add the DS record at your registrar)

Usage:
  keel dns dnssec enable ZONE [flags]

Flags:
  -h, --help   help for enable

keel dns dnssec rollover

Start a key rollover (KSK: you must update the DS at your registrar)

Usage:
  keel dns dnssec rollover ZONE --zsk|--ksk [flags]

Flags:
  -h, --help   help for rollover
      --ksk    roll the key-signing key (needs a new DS at the registrar)
      --zsk    roll the zone-signing key (automatic, no registrar change)

keel dns export

Print the zone as a BIND zone file (without DNSSEC records)

Usage:
  keel dns export ZONE [flags]

Flags:
  -h, --help   help for export

keel dns import

Adds the RRsets of the file that do not exist yet and reports conflicts. --replace instead replaces all records not managed by keel (destructive; asks first). SOA, apex NS, DNSSEC records and unsupported types are skipped and listed; $INCLUDE and $GENERATE are rejected.

Usage:
  keel dns import ZONE FILE [flags]

Flags:
  -h, --help      help for import
      --replace   replace all unmanaged records (destructive)

keel dns query

Ask keel's answer engine about the current zone (also before delegation)

Usage:
  keel dns query ZONE NAME [TYPE] [flags]

Flags:
      --dnssec   set the DO bit (include signatures)
  -h, --help     help for query

keel dns record

CONTENT is the record data in zone-file presentation format, one argument per record: `192.0.2.1`, `"10 mx1.example.com."` for MX, `"v=spf1 -all"` for TXT (quotes are added for TXT if missing). ALIAS takes a keel service (svc_…) or its generated hostname.

Usage:
  keel dns record [command]

Available Commands:
  add         Create an RRset (fails if name and type already exist)
  rm          Remove an RRset
  set         Replace an RRset with these records (or create it)

Flags:
  -h, --help   help for record

Use "keel dns record [command] --help" for more information about a command.

keel dns record add

Create an RRset (fails if name and type already exist)

Usage:
  keel dns record add ZONE NAME TYPE CONTENT... [flags]

Flags:
      --comment string   a note shown in the dashboard
  -h, --help             help for add
      --ttl int          TTL in seconds (default: the zone's default TTL)

keel dns record rm

Remove an RRset

Usage:
  keel dns record rm ZONE NAME TYPE [flags]

Flags:
  -h, --help   help for rm

keel dns record set

Replaces all records of NAME and TYPE. With an agent token and approvals for destructive actions, this waits for a person's approval (exit code 9).

Usage:
  keel dns record set ZONE NAME TYPE CONTENT... [flags]

Flags:
  -h, --help                            help for set
      --if-version keel dns zone show   only apply if the zone is still at this version (from keel dns zone show)
      --ttl int                         TTL in seconds (default: the zone's default TTL)

keel dns records

List the records (RRsets) of a zone

Usage:
  keel dns records ZONE [flags]

Flags:
  -h, --help          help for records
      --name string   only this name (relative, @ for the apex)
      --type string   only this type (A, AAAA, CNAME, MX, TXT, …)

keel dns tsig

TSIG keys for ACME DNS-01 and dynamic updates (RFC 2136)

Usage:
  keel dns tsig [command]

Available Commands:
  create      Create a TSIG key; prints the secret once
  list        List a zone's TSIG keys (without secrets)
  rm          Delete a TSIG key (clients using it stop working)

Flags:
  -h, --help   help for tsig

Use "keel dns tsig [command] --help" for more information about a command.

keel dns tsig create

--acme allows only TXT records under _acme-challenge (cert-manager, certbot, lego, acme.sh); --name limits it to these hostnames. The secret is shown once and cannot be retrieved again.

Usage:
  keel dns tsig create ZONE --acme|--purpose update [flags]

Flags:
      --acme             key for ACME DNS-01 challenges only
  -h, --help             help for create
      --name strings     limit the key to these names (repeatable)
      --purpose string   acme or update

keel dns tsig list

List a zone's TSIG keys (without secrets)

Usage:
  keel dns tsig list ZONE [flags]

Flags:
  -h, --help   help for list

keel dns tsig rm

Delete a TSIG key (clients using it stop working)

Usage:
  keel dns tsig rm TSIG_ID [flags]

Flags:
  -h, --help   help for rm

keel dns zone

Create, show, verify, change and delete a zone

Usage:
  keel dns zone [command]

Available Commands:
  create      Create a zone; prints the nameservers to set at your registrar
  delete      Delete a zone (needs a token with admin; its nameservers stop answering for it at once)
  show        Show status, nameservers, DNSSEC and issues of a zone
  update      Change the default TTL, the negative TTL or the project of a zone
  verify      Check the delegation at the parent zone now

Flags:
  -h, --help   help for zone

Use "keel dns zone [command] --help" for more information about a command.

keel dns zone create

Creates the zone in status pending_delegation and assigns it four nameservers. Records can be edited right away (and checked with `keel dns query`); the zone is served once your registrar delegates to exactly these nameservers. --import reads a BIND zone file (- for stdin); SOA, apex NS and DNSSEC records of the old provider are skipped. --project binds the zone to a project (project-restricted tokens only see zones of their projects).

Usage:
  keel dns zone create NAME [flags]

Flags:
  -h, --help            help for create
      --import string   BIND zone file to import (- reads stdin)
      --no-dnssec       create the zone unsigned (DNSSEC is on by default)

keel dns zone delete

Delete a zone (needs a token with admin; its nameservers stop answering for it at once)

Usage:
  keel dns zone delete ZONE [flags]

Flags:
  -h, --help   help for delete

keel dns zone show

Show status, nameservers, DNSSEC and issues of a zone

Usage:
  keel dns zone show ZONE [flags]

Flags:
  -h, --help   help for show

keel dns zone update

Change the default TTL, the negative TTL or the project of a zone

Usage:
  keel dns zone update ZONE [flags]

Flags:
      --default-ttl int       TTL for records without one, 60–604800 seconds
  -h, --help                  help for update
      --negative-ttl int      how long resolvers cache "does not exist", 60–3600 seconds
      --zone-project string   bind the zone to a project (ID or name, - to unbind)

keel dns zone verify

Asks the parent zone's nameservers which nameservers (and DS records) it delegates to, compares them with the zone's nameservers and prints the result. A matching delegation activates the zone.

Usage:
  keel dns zone verify ZONE [flags]

Flags:
  -h, --help   help for verify

keel dns zones

List the DNS zones of the workspace

Usage:
  keel dns zones [flags]

Flags:
  -h, --help   help for zones

keel domains

Manage the service's domains

Usage:
  keel domains [command]

Available Commands:
  add         Add a custom domain
  list        List domains
  remove      Remove a domain

Flags:
  -h, --help   help for domains

Use "keel domains [command] --help" for more information about a command.

keel domains add

Add a custom domain

Usage:
  keel domains add HOSTNAME [flags]

Flags:
  -h, --help   help for add

keel domains list

List domains

Usage:
  keel domains list [flags]

Flags:
  -h, --help   help for list

keel domains remove

Remove a domain

Usage:
  keel domains remove HOSTNAME|ID [flags]

Flags:
  -h, --help   help for remove

keel env

Manage environment variables

Usage:
  keel env [command]

Available Commands:
  list        List variables (environment-wide and the service's own)
  pull        Write all variables, with secret values, to a .env file
  set         Set variables (on the linked service, or environment-wide with --shared)
  unset       Delete variables

Flags:
  -h, --help   help for env

Use "keel env [command] --help" for more information about a command.

keel env list

Secret values are hidden unless --reveal is given (needs the config:write scope; the reveal is audited).

Usage:
  keel env list [flags]

Flags:
  -h, --help     help for list
      --reveal   show secret values
      --shared   only environment-wide variables

keel env pull

Merges environment-wide and service variables (service wins) and writes them with values revealed (needs config:write; audited). Use -o - for stdout.

Usage:
  keel env pull [flags]

Flags:
  -h, --help            help for pull
  -o, --output string   file to write, or - for stdout (default ".env")

keel env set

Values are stored encrypted as secrets unless --plain. Running services are redeployed with the new values unless --no-redeploy. Use KEY=- to read a value from stdin.

Usage:
  keel env set KEY=value... [flags]

Flags:
  -h, --help          help for set
      --no-redeploy   do not roll out running services
      --plain         store as non-secret (value visible in listings)
      --shared        set environment-wide (all services)

keel env unset

Delete variables

Usage:
  keel env unset KEY... [flags]

Flags:
  -h, --help          help for unset
      --no-redeploy   do not roll out running services
      --shared        delete environment-wide variables

keel kv

Manage serverless Valkey (Redis-compatible) databases of the environment

Usage:
  keel kv [command]

Available Commands:
  create      Create a KV database
  delete      Delete a KV database and its data (needs a token with admin)
  list        List KV databases
  url         Print the connection URL (contains the password)

Flags:
  -h, --help   help for kv

Use "keel kv [command] --help" for more information about a command.

keel kv create

Create a KV database

Usage:
  keel kv create NAME [flags]

Flags:
      --allow-flushall    allow FLUSHALL (needs a token with admin)
      --eviction string   eviction policy: noeviction (default) or allkeys-lru (cache)
  -h, --help              help for create
      --plan string       plan: kv-s (256 MB, default), kv-m (1 GB), kv-l (4 GB, pro)

keel kv delete

Delete a KV database and its data (needs a token with admin)

Usage:
  keel kv delete NAME|ID [flags]

Flags:
  -h, --help   help for delete

keel kv list

List KV databases

Usage:
  keel kv list [flags]

Flags:
  -h, --help   help for list

keel kv url

Prints the rediss:// URL through the gateway (TLS). --rest prints the REST URL and token (@upstash/redis: url and token), --internal the URL for services in the cluster.

Usage:
  keel kv url NAME|ID [flags]

Flags:
  -h, --help       help for url
      --internal   print the URL for services inside the cluster
      --rest       print the REST URL and token instead
Writes .keel/project.json. Pick interactively, or pass --workspace, --project, --environment and --service (IDs or names). Without a terminal, every choice that is not unique must be given as a flag.

Usage:
  keel link [flags]

Flags:
  -h, --help   help for link

keel login

Log in to keel.run. Without flags, keel opens the browser to approve a token for this device; the token is stored in the OS keychain (or ~/.config/keel/credentials.json, mode 0600).

In CI, set KEEL_TOKEN instead, or run `keel login --token -` and pass the token on stdin.

Usage:
  keel login [flags]

Flags:
  -h, --help           help for login
      --name string    device name shown on the approval page (default: hostname)
      --no-browser     print the URL instead of opening the browser
      --token string   use this API token instead of the browser ("-" reads it from stdin)

keel logout

Revoke and forget the stored token

Usage:
  keel logout [flags]

Flags:
  -h, --help   help for logout

keel logs

Prints log lines (with --json: one JSON object per line). -f keeps following until interrupted.

Usage:
  keel logs [flags]

Flags:
      --deployment string   show this deployment's build and release log
  -f, --follow              keep streaming new lines
  -h, --help                help for logs
      --since string        how far back to start (e.g. 10m, 2h) (default "1h")
      --tail int            runtime logs: lines per instance (default 100, max 1000)

keel mail

keel mail hosts mailboxes for your domains (IMAP, JMAP, POP3, SMTP, webmail) and sends app mail with sending keys. Domains are given by name (example.de) or ID (mdom_…), mailboxes by address or ID (mbx_…).

Usage:
  keel mail [command]

Available Commands:
  alias        Add, list and remove aliases
  app-password Create, list and revoke app passwords of a mailbox
  catchall     Set or remove the catch-all of a domain (an alias *@domain)
  domains      List, add, check and remove mail domains
  forward      Set or turn off the forwarding of a mailbox
  keys         List, create and revoke sending keys for app mail
  log          Message log of app mail (metadata only), newest first
  mailbox      Create, list, change and delete mailboxes
  quarantine   Quarantined mail (metadata only): list, release, delete
  reputation   Sending reputation, holds and limits
  routes       Inbound routes: post mail to an address to your app as a webhook
  suppressions Addresses app mail is not sent to (hard bounces, complaints)
  webhooks     Event webhooks for app mail (delivered, bounced, complained, …)

Flags:
  -h, --help   help for mail

Use "keel mail [command] --help" for more information about a command.

keel mail alias

Add, list and remove aliases

Usage:
  keel mail alias [command]

Aliases:
  alias, aliases

Available Commands:
  add         Add an alias
  list        List the aliases of a domain
  remove      Remove an alias

Flags:
  -h, --help   help for alias

Use "keel mail alias [command] --help" for more information about a command.

keel mail alias add

Add an alias

Usage:
  keel mail alias add ADDRESS --to TARGET[,TARGET] [flags]

Flags:
  -h, --help             help for add
      --send-as string   mailboxes that may send as this address (comma-separated)
      --to string        targets (comma-separated)

keel mail alias list

List the aliases of a domain

Usage:
  keel mail alias list DOMAIN [flags]

Flags:
  -h, --help   help for list

keel mail alias remove

Remove an alias

Usage:
  keel mail alias remove ADDRESS [flags]

Flags:
  -h, --help   help for remove

keel mail app-password

Create, list and revoke app passwords of a mailbox

Usage:
  keel mail app-password [command]

Aliases:
  app-password, app-passwords

Available Commands:
  create      Create an app password (shown once)
  list        List app passwords
  revoke      Revoke an app password (open sessions end)

Flags:
  -h, --help   help for app-password

Use "keel mail app-password [command] --help" for more information about a command.

keel mail app-password create

Create an app password (shown once)

Usage:
  keel mail app-password create ADDRESS [flags]

Flags:
  -h, --help           help for create
      --name string    a name for the device, e.g. iphone
      --scope string   all (default), smtp-only or read-only

keel mail app-password list

List app passwords

Usage:
  keel mail app-password list ADDRESS [flags]

Flags:
  -h, --help   help for list

keel mail app-password revoke

Revoke an app password (open sessions end)

Usage:
  keel mail app-password revoke ADDRESS ID [flags]

Flags:
  -h, --help   help for revoke

keel mail catchall

Set or remove the catch-all of a domain (an alias *@domain)

Usage:
  keel mail catchall [command]

Available Commands:
  remove      Remove the catch-all
  set         Deliver mail to unknown addresses of the domain to TARGET (catch-alls attract spam)

Flags:
  -h, --help   help for catchall

Use "keel mail catchall [command] --help" for more information about a command.

keel mail catchall remove

Remove the catch-all

Usage:
  keel mail catchall remove DOMAIN [flags]

Flags:
  -h, --help   help for remove

keel mail catchall set

Deliver mail to unknown addresses of the domain to TARGET (catch-alls attract spam)

Usage:
  keel mail catchall set DOMAIN --to TARGET[,TARGET] [flags]

Flags:
  -h, --help        help for set
      --to string   targets (comma-separated)

keel mail domains

List, add, check and remove mail domains

Usage:
  keel mail domains [flags]
  keel mail domains [command]

Available Commands:
  add         Add a mail domain and show the DNS records it needs
  dns         Show the DNS records of a domain with their status and hints
  remove      Delete a mail domain with its mailboxes, aliases and routes (needs admin)
  verify      Check the DNS records now

Flags:
  -h, --help   help for domains

Use "keel mail domains [command] --help" for more information about a command.

keel mail domains add

Adds the domain. If its zone is in keel DNS (same workspace), keel verifies it and sets all records itself. Otherwise add the shown records at your DNS provider and run `keel mail domains verify DOMAIN`.

Usage:
  keel mail domains add DOMAIN [flags]

Flags:
  -h, --help   help for add

keel mail domains dns

Show the DNS records of a domain with their status and hints

Usage:
  keel mail domains dns DOMAIN [flags]

Flags:
      --all     also optional and app-sending records
  -h, --help    help for dns
      --watch   check every 30 seconds until the domain is active

keel mail domains remove

Delete a mail domain with its mailboxes, aliases and routes (needs admin)

Usage:
  keel mail domains remove DOMAIN [flags]

Flags:
  -h, --help   help for remove

keel mail domains verify

Check the DNS records now

Usage:
  keel mail domains verify DOMAIN [flags]

Flags:
  -h, --help   help for verify

keel mail forward

Set or turn off the forwarding of a mailbox

Usage:
  keel mail forward [command]

Available Commands:
  off         Turn forwarding off
  set         Forward incoming mail (audited and mailed to the mailbox owner; spam is never forwarded)

Flags:
  -h, --help   help for forward

Use "keel mail forward [command] --help" for more information about a command.

keel mail forward off

Turn forwarding off

Usage:
  keel mail forward off ADDRESS [flags]

Flags:
  -h, --help   help for off

keel mail forward set

Forward incoming mail (audited and mailed to the mailbox owner; spam is never forwarded)

Usage:
  keel mail forward set ADDRESS --to TARGET[,TARGET] [flags]

Flags:
  -h, --help        help for set
      --keep-copy   keep a copy in the mailbox (default) (default true)
      --no-copy     do not keep a copy in the mailbox
      --to string   targets (comma-separated, up to 10)

keel mail keys

List, create and revoke sending keys for app mail

Usage:
  keel mail keys [flags]
  keel mail keys [command]

Available Commands:
  create      Create a sending key (shown once)
  revoke      Revoke a sending key

Flags:
  -h, --help   help for keys

Use "keel mail keys [command] --help" for more information about a command.

keel mail keys create

Create a sending key (shown once)

Usage:
  keel mail keys create --domain DOMAIN [flags]

Flags:
      --domain string           sender domains or addresses (comma-separated)
      --environment-id string   the environment that uses the key (env_…)
  -h, --help                    help for create
      --name string             a name (default: the first domain)

keel mail keys revoke

Revoke a sending key

Usage:
  keel mail keys revoke ID [flags]

Flags:
  -h, --help   help for revoke

keel mail log

Message log of app mail (metadata only), newest first

Usage:
  keel mail log [flags]

Flags:
  -f, --follow          keep printing new messages and status changes
  -h, --help            help for log
      --limit int       number of messages (at most 200) (default 50)
      --status string   only messages with a recipient in this state (delivered, bounced, deferred, …)
      --to string       only messages to this address

keel mail mailbox

Create, list, change and delete mailboxes

Usage:
  keel mail mailbox [command]

Aliases:
  mailbox, mailboxes

Available Commands:
  create      Create a mailbox (1.50 € per month including 5 GB)
  delete      Delete a mailbox (needs admin; contents recoverable for 30 days)
  list        List mailboxes
  set         Change quota, name, status or options of a mailbox

Flags:
  -h, --help   help for mailbox

Use "keel mail mailbox [command] --help" for more information about a command.

keel mail mailbox create

Create a mailbox (1.50 € per month including 5 GB)

Usage:
  keel mail mailbox create ADDRESS [flags]

Flags:
  -h, --help           help for create
      --name string    display name
      --owner string   the keel user who uses the mailbox: usr_… of a workspace member, or me
      --quota string   quota, e.g. 10G (default 5G)

keel mail mailbox delete

Delete a mailbox (needs admin; contents recoverable for 30 days)

Usage:
  keel mail mailbox delete ADDRESS [flags]

Flags:
  -h, --help   help for delete

keel mail mailbox list

List mailboxes

Usage:
  keel mail mailbox list [flags]

Flags:
      --domain string   only this domain
  -h, --help            help for list

keel mail mailbox set

Only the given flags change. --status disabled refuses logins and incoming mail. --save-sent true files a copy of SMTP-sent mail in Sent; --pop3-delete true makes POP3 delete for good.

Usage:
  keel mail mailbox set ADDRESS [flags]

Flags:
  -h, --help                 help for set
      --name string          display name
      --pop3-delete string   true: POP3 deletes for good instead of moving to Trash
      --quota string         quota, e.g. 20G
      --save-sent string     true: file a Sent copy of SMTP submissions
      --status string        active or disabled

keel mail quarantine

Quarantined mail (metadata only): list, release, delete

Usage:
  keel mail quarantine [command]

Available Commands:
  delete      Delete a quarantined message for good
  list        List quarantined mail
  release     Deliver a quarantined message to its recipient

Flags:
  -h, --help   help for quarantine

Use "keel mail quarantine [command] --help" for more information about a command.

keel mail quarantine delete

Delete a quarantined message for good

Usage:
  keel mail quarantine delete ID [flags]

Flags:
  -h, --help   help for delete

keel mail quarantine list

List quarantined mail

Usage:
  keel mail quarantine list [flags]

Flags:
  -h, --help   help for list

keel mail quarantine release

Deliver a quarantined message to its recipient

Usage:
  keel mail quarantine release ID [flags]

Flags:
  -h, --help   help for release

keel mail reputation

Sending reputation, holds and limits

Usage:
  keel mail reputation [flags]

Flags:
  -h, --help   help for reputation

keel mail routes

Inbound routes: post mail to an address to your app as a webhook

Usage:
  keel mail routes [flags]
  keel mail routes [command]

Available Commands:
  add         Add a route (ADDRESS may be support@d, support+*@d or *@d)
  remove      Remove a route
  test        Post a signed test payload to the route's URL

Flags:
  -h, --help   help for routes

Use "keel mail routes [command] --help" for more information about a command.

keel mail routes add

Add a route (ADDRESS may be support@d, support+*@d or *@d)

Usage:
  keel mail routes add ADDRESS --url URL [flags]

Flags:
      --copy-to string    also deliver a copy into this mailbox
  -h, --help              help for add
      --quarantine-spam   quarantine spam instead of discarding it
      --raw               post the message as message/rfc822 instead of parsed JSON
      --url string        https URL of your app

keel mail routes remove

Remove a route

Usage:
  keel mail routes remove ADDRESS|ID [flags]

Flags:
  -h, --help   help for remove

keel mail routes test

Post a signed test payload to the route's URL

Usage:
  keel mail routes test ADDRESS|ID [flags]

Flags:
  -h, --help   help for test

keel mail suppressions

Addresses app mail is not sent to (hard bounces, complaints)

Usage:
  keel mail suppressions [command]

Available Commands:
  list        List suppressed addresses
  remove      Send app mail to an address again (only when the recipient asked for it)

Flags:
  -h, --help   help for suppressions

Use "keel mail suppressions [command] --help" for more information about a command.

keel mail suppressions list

List suppressed addresses

Usage:
  keel mail suppressions list [flags]

Flags:
  -h, --help   help for list

keel mail suppressions remove

Send app mail to an address again (only when the recipient asked for it)

Usage:
  keel mail suppressions remove ADDRESS [flags]

Flags:
  -h, --help   help for remove

keel mail webhooks

Event webhooks for app mail (delivered, bounced, complained, …)

Usage:
  keel mail webhooks [flags]
  keel mail webhooks [command]

Available Commands:
  add         Add an event webhook (the signing secret is shown once)
  remove      Delete an event webhook

Flags:
  -h, --help   help for webhooks

Use "keel mail webhooks [command] --help" for more information about a command.

keel mail webhooks add

Add an event webhook (the signing secret is shown once)

Usage:
  keel mail webhooks add URL [flags]

Flags:
      --events string   event types (comma-separated; default all)
  -h, --help            help for add

keel mail webhooks remove

Delete an event webhook

Usage:
  keel mail webhooks remove ID [flags]

Flags:
  -h, --help   help for remove

keel open

Open the linked service (or a deployment) in the dashboard

Usage:
  keel open [flags]

Flags:
      --deployment string   open this deployment (dpl_…)
  -h, --help                help for open

keel previews

Preview environments of pull requests

Usage:
  keel previews [command]

Available Commands:
  approve     Approve the current commit of a forked pull request
  delete      Delete a preview environment
  list        List the project's previews

Flags:
  -h, --help   help for previews

Use "keel previews [command] --help" for more information about a command.

keel previews approve

Forked pull requests never build on their own: their code would get the environment's variables.
Review the commit first; approval covers exactly that commit, every new commit needs a new approval.

Usage:
  keel previews approve PR|ID [flags]

Flags:
  -h, --help         help for approve
      --sha string   the commit you reviewed (refuses if the pull request moved on)

keel previews delete

Delete a preview environment

Usage:
  keel previews delete PR|ID [flags]

Flags:
  -h, --help   help for delete

keel previews list

List the project's previews

Usage:
  keel previews list [flags]

Flags:
      --all    include closed previews
  -h, --help   help for list

keel projects

List the projects of the workspace

Usage:
  keel projects [flags]

Flags:
  -h, --help   help for projects

keel rollback

Roll back to an earlier deployment (default: the previous one)

Usage:
  keel rollback [deployment] [flags]

Flags:
  -h, --help    help for rollback
  -w, --watch   wait for the rollback to finish

keel run

Starts a one-off run with the image and variables of the service's active deployment, streams its output and exits with the command's exit code (124 when it timed out, 130 when cancelled, 8 when it could not start). Without a command, the service's start command runs (e.g. a cron service now). Several arguments are quoted for /bin/sh; a single argument is passed as a shell command line. Ctrl-C cancels the run unless --detach is set. With --json, output goes to stderr and the final run to stdout.

Usage:
  keel run [flags] -- <command> [args...]

Flags:
  -d, --detach             start the run and return without waiting
  -h, --help               help for run
      --size string        instance size xs, s, m, l or xl (default: the service's size)
      --timeout duration   maximum run time, e.g. 30m (default 15m; the maximum depends on the plan)

keel runs

List one-off and scheduled runs of the service

Usage:
  keel runs [flags]
  keel runs [command]

Available Commands:
  cancel      Stop a pending or running run
  list        List runs (newest first)
  logs        Show a run's log (needs logs:read and config:write)

Flags:
  -h, --help        help for runs
      --limit int   number of runs (max 100) (default 20)

Use "keel runs [command] --help" for more information about a command.

keel runs cancel

Stop a pending or running run

Usage:
  keel runs cancel <run> [flags]

Flags:
  -h, --help   help for cancel

keel runs list

List runs (newest first)

Usage:
  keel runs list [flags]

Flags:
  -h, --help        help for list
      --limit int   number of runs (max 100) (default 20)

keel runs logs

Show a run's log (needs logs:read and config:write)

Usage:
  keel runs logs <run> [flags]

Flags:
  -f, --follow   keep streaming until the run ends
  -h, --help     help for logs

keel services

List the services of the environment

Usage:
  keel services [flags]
  keel services [command]

Available Commands:
  create      Create a service (web, worker or cron) and deploy it

Flags:
  -h, --help   help for services

Use "keel services [command] --help" for more information about a command.

keel services create

Creates a service in the environment and starts its first deployment. Kinds: web (default) serves HTTP on --port; worker runs continuously without a port; cron runs --start on --schedule (5 fields, e.g. "*/15 * * * *", or @hourly/@daily/@weekly/@monthly) in --timezone.

Examples:
  keel services create api --image ghcr.io/acme/api:1 --port 3000
  keel services create jobs --repo acme/app --kind worker --start "bin/worker"
  keel services create nightly --image ghcr.io/acme/app:1 --kind cron --schedule "0 3 * * *" --timezone Europe/Berlin --start "bin/report"

Usage:
  keel services create <name> [flags]

Flags:
      --branch string            branch to deploy (default main)
      --concurrency string       cron: forbid (default) or replace a run that is still going
      --health-command string    worker: liveness check command
  -h, --help                     help for create
      --image string             container image, e.g. ghcr.io/acme/app:1.2
      --instances int            number of instances (web, worker)
      --kind string              web (default), worker or cron
      --port int                 web: port the app listens on (default 8080)
      --provider string          git provider: github, gitlab or forgejo (default "github")
      --release-command string   command run before each rollout, e.g. migrations
      --repo string              git repository owner/name (public, or through a connected provider)
      --retries int              cron: retries of a failed run
      --root string              directory inside the repository
      --schedule string          cron: schedule, e.g. "*/15 * * * *" or @daily
      --size string              instance size xs, s, m, l or xl (default s)
      --start string             start command (cron: the command each run executes)
      --timeout duration         cron: maximum run time (default 15m)
      --timezone string          cron: IANA time zone of the schedule (default UTC)

keel status

Show the linked service: deployments, runtime and domains

Usage:
  keel status [flags]

Flags:
  -h, --help   help for status

keel tokens

Manage API tokens of the workspace (needs admin)

Usage:
  keel tokens [command]

Available Commands:
  create      Create a token (the secret is shown once)
  list        List tokens
  revoke      Revoke a token

Flags:
  -h, --help   help for tokens

Use "keel tokens [command] --help" for more information about a command.

keel tokens create

Create a token (the secret is shown once)

Usage:
  keel tokens create [flags]

Flags:
      --expires-days int   expiry in days (agent tokens: default 30)
  -h, --help               help for create
      --kind string        pat, svc (CI) or agent (default "pat")
      --name string        token name
      --project strings    limit to project IDs (repeatable)
      --scopes strings     comma-separated scopes (default [read])

keel tokens list

List tokens

Usage:
  keel tokens list [flags]

Flags:
  -h, --help   help for list

keel tokens revoke

Revoke a token

Usage:
  keel tokens revoke TOKEN_ID [flags]

Flags:
  -h, --help   help for revoke

keel version

Show the CLI version. Unless --no-check is given, keel also asks the API (GET /v1/meta, no login needed) which release keel.run runs and prints how to update when the CLI is older. The check never fails the command.

Usage:
  keel version [flags]

Flags:
  -h, --help       help for version
      --no-check   do not ask the API for the current release

keel whoami

Show the logged-in user, token scopes and linked service

Usage:
  keel whoami [flags]

Flags:
  -h, --help   help for whoami

View as Markdown