How to Use the Command 'doctl apps' (with Examples)

The doctl apps command is a powerful tool within the DigitalOcean Command Line Interface (CLI) ecosystem, tailored for managing applications hosted on DigitalOcean’s platform. This robust command-line interface enables developers to execute a variety of tasks, including creating, updating, deleting, and retrieving information about applications and their deployments. With doctl apps, managing your DigitalOcean applications can be done efficiently and programmatically, making it an indispensable resource for developers who prefer interacting with cloud services through a command line.

Create an App

Code:

doctl apps create

Motivation: The primary motivation for using the doctl apps create command is to automate the deployment of a new application within the DigitalOcean environment. Instead of manually navigating the web interface to set up an app, this command streamlines the process, making it especially beneficial for developers who embrace automation or those managing multiple applications.

Explanation: The command doctl apps create doesn’t require additional arguments because it prompts the user to follow a guided creation process. During this process, you will be asked to provide necessary configurations for the app you wish to create, such as specifying the source code repository, build settings, environment variables, etc.

Example Output:

A new application has been successfully created with ID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Create a Deployment for a Specific App

Code:

doctl apps create-deployment app_id

Motivation: Deployments are crucial in enabling applications to move through different stages, from development to production. By using the doctl apps create-deployment command, developers can trigger a new deployment for a specific application, ensuring that updates or new features are seamlessly delivered to the app without manual intervention.

Explanation: For this command, app_id is a mandatory argument that uniquely identifies the application for which you want to create a deployment. The app ID can be found using other doctl commands, like doctl apps list.

Example Output:

A new deployment has been initiated for the app with ID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Delete an App Interactively

Code:

doctl apps delete app_id

Motivation: There are times when applications are no longer needed, or instances require removal to free up resources. The doctl apps delete command offers an interactive way to delete an application, providing an additional layer of security by prompting the user for confirmation, preventing accidental data loss.

Explanation: The app_id argument is required to specify which application to delete. Running the command will prompt a confirmation to ensure that the deletion is intended.

Example Output:

Are you sure you want to delete the app with ID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx? (y/N)
App with ID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx has been deleted successfully.

Get an App

Code:

doctl apps get app_id

Motivation: Retrieving detailed information about a specific application is essential for monitoring, troubleshooting, and documenting purposes. The doctl apps get command serves this need by furnishing comprehensive details of the app configuration, status, and other metadata.

Explanation: You need to provide the app_id to specify which application’s details you are requesting. The app ID is used to fetch and display all pertinent information about the designated application from DigitalOcean’s platform.

Example Output:

{ 
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", 
  "state": "ACTIVE", 
  "spec": { ... },
  ...
}

List All Apps

Code:

doctl apps list

Motivation: For developers managing multiple applications on DigitalOcean, it’s crucial to have an overarching view of all the applications at any given time. The doctl apps list command provides a concise yet comprehensive list of all apps associated with the account, facilitating easy monitoring and management.

Explanation: This command requires no additional arguments and, when executed, outputs a list of all applications the user has access to under their DigitalOcean account.

Example Output:

ID                                    Name       Status
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx  myApp1     Active
yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy  myApp2     Active

List All Deployments from a Specific App

Code:

doctl apps list-deployments app_id

Motivation: Keeping track of all deployments related to a specific application can aid in auditing, issue tracking, and ensuring compliance with DevOps practices. By using doctl apps list-deployments, developers gain insights into the deployment history and status for a specified application.

Explanation: The app_id is required here to identify the application whose deployment history you wish to review. This parameter helps in filtering and retrieving only those deployments that are pertinent to the specified app.

Example Output:

Deployment ID                          Status     Created At
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx  succeeded  2023-10-01T12:00:00Z
yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy  failed     2023-09-25T15:30:00Z

Get Logs from a Specific App

Code:

doctl apps logs app_id

Motivation: Logs are instrumental in debugging and understanding the internal workings and issues within your application. The doctl apps logs command fetches logs from a specified application, offering real-time insights that aid in troubleshooting and optimizing app performance.

Explanation: You need to provide app_id to specify from which application the logs should be fetched. This ensures that only relevant logs from the intended application are displayed.

Example Output:

Timestamp                  Log
2023-10-01T12:00:00Z       INFO: Application started successfully
2023-10-01T12:01:00Z       ERROR: Failed to connect to the database

Update a Specific App with a Given App Spec

Code:

doctl apps update app_id --spec path/to/spec.yml

Motivation: Application requirements often evolve, necessitating updates to configurations or specifications. The doctl apps update command is pivotal in applying these changes programmatically by updating an application’s configuration using a predefined app spec file.

Explanation: The app_id specifies the app to be updated. The --spec option is followed by the path to the YAML file containing the new configuration specifications. This file outlines how the app should be set up and run.

Example Output:

The app with ID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx has been successfully updated with the provided spec.

Conclusion

The doctl apps command in the DigitalOcean CLI suite offers extensive functionality for managing applications seamlessly and efficiently. Each use case addresses a specific aspect of application management, making it an indispensable tool for developers who seek to integrate cloud operations into their command line workflows. Leveraging these commands not only enhances productivity but also empowers developers with precise control over their DigitalOcean-hosted applications.