Products > App Platform > References >Command-Line Reference

Reference for the DigitalOcean Command-Line Interface (doctl) with App Platform

Validated on 30 September 2020 • Posted on 30 September 2020

doctl is a command-line interface for the DigitalOcean API and supports many of the same actions.

Get Started

To use doctl, you must first install it.

The commands for App Platform are inside the apps command space

To create or update an app, you can pass in a YAML or JSON app specification to doctl apps create:

doctl apps create --spec <path-to-spec>

How to Install doctl

Install and configure doctl, the official DigitalOcean command-line client (CLI).

Command List

create

Create an app with the given app spec.

create-deployment

Create a deployment for an app. Creating an app deployment will pull the latest changes from your repository and schedule a new deployment for your app.

delete

Deletes an app with the provided id. This permanently deletes the app and all its associated deployments.

get

Get an app with the provided id. Only basic information is included with the text output format. For complete app details including its app spec, use the JSON format.

get-deployment

Get a deployment for an app. Only basic information is included with the text output format. For complete app details including its app specs, use the JSON format.

list

List all apps. Only basic information is included with the text output format. For complete app details including the app specs, use the JSON format.

list-alerts

List all alerts associated to an app and its components

list-deployments

List all deployments for an app. Only basic information is included with the text output format. For complete app details including the app specs, use the JSON format.

list-regions

List all regions supported by App Platform including details about their current availability.

logs

Get component logs for a deployment of an app. Three types of logs are supported and can be configured with –type: - build - deploy - run

propose

Reviews and validates an app specification for a new or existing app. The request returns some information about the proposed app, including app cost and upgrade cost. If an existing app ID is specified, the app spec is treated as a proposed update to the existing app. Only basic information is included with the text output format. For complete app details including an updated app spec, use the JSON format.

spec

The subcommands of doctl app spec manage your app specs.

tier

The subcommands of doctl app tier retrieve information about app tiers.

update

Update the specified app with the given app spec. For more information about app specs, see https://www.digitalocean.com/docs/app-platform/concepts/app-spec

update-alert-destinations

Update alert destinations