Managing Apps

The Apolo CLI provides a powerful and efficient way to manage your applications directly from the terminal. You can explore, install, monitor, and uninstall applications using a set of simple commands.

Explore available apps

Before installing an application, you can explore the full catalog of available app templates.

To list all available application templates, run the following command:

apolo app-template ls

This command will fetch and display a table of all templates you can install, including their name, version, and description.

 Name               Title              Version   Description                                  Tags
 ------------------ ------------------ --------- -------------------------------------------- ----------------------------------
  dify               Dify               apolo     Run Dify an open-source, no-code/low-code... Dify, LLM, LLMOps, Rag, Agent
  dockerhub          DockerHub          v25.5.0   Access Images from your private DockerHub... DockerHub, MLOps, Container registry
  jupyter            Jupyter            v25.5.1   Web-based interactive development env...     Jupyter, Notebooks, EDA, ETL, ...
  ...

Install application

The most robust way to install applications via the CLI is by using a YAML configuration file. This allows you to define all installation parameters declaratively.

Create a YAML configuration file

The configuration file includes your application's template name, version, metadata and input parameters such as resource presets, storage mounts, and other app-specific inputs. There are several ways to create config file:

Craft one by yourself using app documentation and inputs reference
Get example using CLI command apolo app-template get <application-name>

Example vscode.yaml:

# Example of myvscode.yaml
template_name: vscode
template_version: latest
display_name: myvscode
input:
  preset:
    name: cpu-medium
  vscode_specific:
    extra_storage_mounts:
      mounts:
        - storage_uri: storage:my-extra-storage
          mount_path: /mnt/extra
          mode: rw
  networking:
    http_auth: true

Build the configuration using Apolo web console and then save it to the application configuration file. You can do it with this button (after specifying all needed parameters):

Run the install command

Use Apolo CLI point it to your YAML file using the --file flag and trigger installation

apolo app install --file vscode.yaml

Upon execution, the CLI will confirm the installation:

App installed from vscode.yaml

Manage installed apps

Once an app is installed, you can list, monitor, and manage it. To see all applications currently installed in your project, run:

apolo app ls

This command displays a list of your app instances, their unique ID, and their current State (e.g., progressing, healthy, errored).

 ID                                     Name                       Display Name      Template    Version   State
 ------------------------------------   -------------------------- ----------------- ----------- --------- ------------
  5a5fa379-4635-4418-959f-457b44280c21   apolo-demo-user-vscode...  myvscode          vscode      v25.5.1   healthy
  c4bd3c55-1985-4525-9cf9-f8453b...      apolo-demo-user-hugging... Hugging Face Cache  hugging-face-cache HEAD      healthy
  ...

When a newer version of the app's template is available, the Version column shows it next to the installed one:

 ID            ...   Template   Version                       State
 -----------   ---   --------   ---------------------------   -------
  f42138e1...   ...   postgres   v26.5.0 (v26.8.0 available)   healthy
  ...

See Upgrade app for how to move the app to that version.

View app logs

To view the logs for a running application, use the logs command with the application's ID (which you can get from apolo app ls).

# First, get the App ID
apolo app ls

# Then, view the logs
apolo app logs 5a5fa379-4635-4418-959f-457b44280c21

The CLI will stream the application's logs directly to your terminal.

Configure app

In order to reconfigure the application providing new inputs, update the previously mentioned configuration file and trigger update pointing Apolo CLI to the application instance you are re-configuring:

apolo app configure 5a5fa379-4635-4418-959f-457b44280c21 --file vscode.yaml

Reconfiguring keeps the app on the template version it was installed with, even if template_version in the file is different. In that case the CLI tells you which version the app stays on.

For more detailed description of application updates, refer to the web console application management pages.

Upgrade app

Upgrading requires Apolo CLI 26.9.0 or newer. Check your version with apolo --version.

To move an installed app to a newer version of its template, set the target version in the configuration file and pass the --upgrade flag to the configure command.

Find the version to upgrade to. apolo app ls shows the newest one in the Version column, and the following command lists all versions of a template:
```
apolo app-template ls-versions postgres
```

Set template_version in the app's configuration file to that version, or to latest:

template_name: postgres
template_version: v26.8.0
display_name: PostgreSQL
input:
  ...

Run configure with the --upgrade flag:

apolo app configure f42138e1-9c4e-4ac6-b217-1fca435a7d6d \
  --file postgres.yaml --upgrade

The CLI confirms the version the app is on now:

App f42138e1-9c4e-4ac6-b217-1fca435a7d6d configured using postgres.yaml.
The app is now on v26.8.0.

The inputs from the file are applied together with the upgrade and are validated against the new version, so check the inputs of the target version with apolo app-template get postgres -V v26.8.0 if it changed them.

An app can only be moved to a newer version of the same template. Moving to an older version is refused.

Uninstall an app

To remove an application instance, use the uninstall command with the application's ID.

apolo app uninstall 5a5fa379-4635-4418-959f-457b44280c21

Use installed app

For applications with a web interface (like VS Code, Jupyter, or a deployed model), you need to retrieve their public URL.

Use the get-values command with the application's ID:
```
apolo app get-values <app-id>
```

This command returns a table of output values for the app, including API endpoints. Look for the path external_web_app_url.

 App Instance ID                        Type      Path                    Value
 ------------------------------------   -------   ----------------------- ----------------------------------------------------
  5a5fa379...c21                         RestAPI   external_web_app_url    {"host": "vscode--5a5fa379...c21.apps.apolo.us", "port": 80, ...}
  5a5fa379...c21                         RestAPI   internal_web_app_url    {"host": "apolo-demo-user-vscode-5a5fa379-custom...", "port": 8080, ...}

Copy the host URL from the external_web_app_url value and open it in your browser to access the application's interface.

References

PreviousInstallable Apps

NextAvailable apps

Last updated 10 days ago

Was this helpful?