> For the complete documentation index, see [llms.txt](https://docs.apolo.us/index/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apolo.us/index/apolo-concepts-cli/apps/installable-apps/managing-apps.md). # 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: ```bash 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: 1. Craft one by yourself using app documentation and inputs reference 2. Get example using CLI command `apolo app-template get ` **Example `vscode.yaml`:** ```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 ``` 3. 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):

Extract PrivateGPT app configuration file

### **Run the install command** Use Apolo CLI point it to your YAML file using the `--file` flag and trigger installation ```bash 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: ```bash 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 ... ``` ### **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`). ```bash # 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: ```bash apolo app config 5a5fa379-4635-4418-959f-457b44280c21 --file vscode.yaml ``` For more detailed description of application updates, refer to the web [console application management](/index/apolo-console/apps/installable-apps/managing-apps.md) pages. ### **Uninstall an app** To remove an application instance, use the `uninstall` command with the application's `ID`. ```bash 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. 1. Use the `get-values` command with the application's `ID`: ```bash apolo app get-values ``` 2. 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, ...} ``` 3. Copy the `host` URL from the `external_web_app_url` value and open it in your browser to access the application's interface. ## References * [Apps vs Jobs](/index/getting-started/apolo-jobs-vs-apps.md) * [Available apps](/index/apolo-console/apps/installable-apps/available-apps.md) * [Managing apps](/index/apolo-console/apps/installable-apps/managing-apps.md) * [Managing apps (Apolo console)](/index/apolo-console/apps/installable-apps/managing-apps.md)