Apps CLI Command Reference

Every dcloud deploy command. The shape is dcloud <service> <resource> <verb>; every command also takes the global flags (--json, --profile, --dry-run, …).

dcloud deploy apps

Deployable applications: what runs, how it is checked, where it is served

  • listList apps
  • getDescribe an app with its environment, deployments, domains and machines
  • createCreate an app
  • updateChange an app, including its release command and health checks
  • deleteDelete an app
  • routingShow how each hostname of the app resolves right now
  • resourcesShow the app as a tree: deployment, load balancer, machines, containers, names and bound data, each with health and sync
  • resource-activityRead one node's last events and, for a container, its last log lines
  • live-diffCompare what one machine runs with what it was asked to run

dcloud deploy hosting

Pooled hosting of a Next.js app: hand over a build, see where and how the app runs (scales to zero)

  • getShow how a pooled app is served: its URLs, deployments and previews, what is served from files and what needs its server, and whether the server runs
  • create-bundleStart a deployment of a pooled app from a build: returns an upload URL for the bundle
  • complete-bundleConfirm a bundle upload: the deployment is served at its URLs

dcloud deploy host-database

A pooled app's Postgres on its pool host: single node, no failover, backed up daily and before a delete

  • getShow a pooled app's pool-host database and its backups, newest first
  • createGive a pooled app a Postgres database on its pool host; the app gets DATABASE_URL at its next start
  • set-limitSet the database size limit (MiB); over it the database is read only
  • backupBack the database up now (kept 30 days)
  • restoreReplace the database with one of its backups
  • moveMove the database to managed Postgres in one step: dump, create the role and database there, restore, bind

dcloud deploy deployments

Rollouts of an app: trigger, read, wait for, cancel

  • listList the deployments of an app, newest first
  • createStart a deployment of an app
  • getDescribe one deployment
  • waitWait until a deployment is live, failed or superseded
  • eventsRead the activity feed of a deployment, including release output
  • build-logRead the log of a deployment's image build, line by line
  • cancelStop a deployment that has not finished

dcloud deploy env

Environment of an app: plain values, secrets, synced 1Password references

  • getVariables with sync status, database bindings, and whether a redeploy is pending
  • replaceReplace the whole environment of an app
  • importImport a .env or .env.op file — dry run for the plan, then apply atomically
  • exportThe environment as .env text — plain values, references, secret names; no secret values

dcloud deploy connections

How each database and cache binding connects — everything but the password

  • getHost (private or public, as the binding resolves it), port, database, role and the secret holding the password

dcloud deploy redeploy

Roll the saved configuration out

  • applyRedeploy the live deployment’s source with the current configuration (no rebuild)

dcloud deploy database

Managed Postgres binding — DATABASE_URL and PG* generated from it

  • bindBind a managed Postgres database (a dedicated app role by default)
  • rotateNew password for the app role; redeploys by default
  • unbindRemove the binding (the role and its data are kept)

dcloud deploy cache

Managed Valkey binding — REDIS_URL and VALKEY_URL generated from it

  • bindBind a managed Valkey cache (its private address, in the app’s VPC)
  • unbindRemove the binding (the cache is unchanged)

dcloud deploy kafka

Managed Kafka binding — KAFKA_BOOTSTRAP_SERVERS and the SASL settings, as a named user

  • bindBind a managed Kafka cluster as one of its users (private, in the app’s VPC)
  • unbindRemove the binding (the cluster and its user are unchanged)

dcloud deploy rabbitmq

Managed RabbitMQ binding — AMQP_URL and AMQP_HOSTS, as a named user

  • bindBind a managed RabbitMQ broker as one of its users (private, in the app’s VPC)
  • unbindRemove the binding (the broker and its user are unchanged)

dcloud deploy docdb

Document Database binding — MONGODB_URL, as the master user or one of its users

  • bindBind a Document Database cluster (MongoDB-compatible) as one of its users
  • unbindRemove the binding (the cluster is unchanged)

dcloud deploy errors

Error Tracking binding — SENTRY_DSN, NEXT_PUBLIC_SENTRY_DSN, SENTRY_ENVIRONMENT, SENTRY_RELEASE and a per-build upload token

  • getThe app’s Error Tracking binding: project, variable names, environment, DSN
  • connectConnect Error Tracking: DSN, environment and release at build and run time
  • disconnectDisconnect (the project, its key and its managed secret are unchanged)

dcloud deploy jobs

Scheduled jobs (cron) of an app: a command run on a schedule in the app’s image

  • listList an app’s jobs with their schedule in words, next run and last result
  • createAdd a scheduled job to an app
  • updateChange a job, or enable/disable it
  • deleteRemove a job and its run history
  • runRun a job now, outside its schedule
  • runsRead a job’s run history, newest first, with each run’s exit code and output

dcloud deploy registry-credentials

Pull credentials for external registries (ghcr.io, Docker Hub, any v2 registry)

  • listList the registry credentials of an app (never the password)
  • replaceReplace the registry credentials of an app

dcloud deploy domains

Custom domains of an app

  • listList the custom domains of an app
  • addAttach a custom domain to an app
  • verifyCheck that a custom domain points at the app, and record it
  • removeDetach a custom domain

Generated from the API description, the same one the API checks requests against and the CLI is built from.