|
| 1 | +--- |
| 2 | +title: (Optional) Use the Topo VS Code extension |
| 3 | +weight: 5 |
| 4 | + |
| 5 | +### FIXED, DO NOT MODIFY |
| 6 | +layout: learningpathall |
| 7 | +--- |
| 8 | + |
| 9 | +## Use Topo from VS Code |
| 10 | + |
| 11 | +You have used the Topo CLI to check your target, list compatible templates, clone a template, deploy the workload, and inspect the running application. |
| 12 | + |
| 13 | +You can also perform the same workflow from Visual Studio Code using the [Topo extension](https://marketplace.visualstudio.com/items?itemName=Arm.topo). The extension provides a graphical interface for Topo deployment. |
| 14 | + |
| 15 | +## Install the extension |
| 16 | + |
| 17 | +Install the Topo extension from the Visual Studio Marketplace using the link above. |
| 18 | + |
| 19 | + |
| 20 | + |
| 21 | +A guide is provided on the extension page, but some brief steps are also shown here. If you are familiar with Topo CLI, you should have little trouble using the extension. After installation, open the Topo view from the VS Code activity bar. |
| 22 | + |
| 23 | +## Add and inspect a target |
| 24 | + |
| 25 | +The Topo sidebar shows your host by default. Use the sidebar to also add your Arm-based Linux target. The target is the same SSH destination you used with the CLI, for example `user@my-target`. |
| 26 | + |
| 27 | +The extension shows the host and target state, available Topo actions, and deployed applications, providing similar insights to `topo health` and `topo ps`. |
| 28 | + |
| 29 | + |
| 30 | + |
| 31 | +## Run Topo commands |
| 32 | + |
| 33 | +The command palette exposes the usual Topo commands such as listing compatible templates, cloning templates, and deploying projects. |
| 34 | + |
| 35 | + |
| 36 | + |
| 37 | +These commands correspond to the CLI commands you used earlier, such as: |
| 38 | + |
| 39 | +```bash |
| 40 | +topo templates --target user@my-target |
| 41 | +topo clone <template-url> |
| 42 | +topo deploy --target user@my-target |
| 43 | +``` |
| 44 | + |
| 45 | +## Deploy from VS Code |
| 46 | + |
| 47 | +After cloning or selecting a Topo Template, you can deploy it. Open or clone the LLM Chatbot example, then deploy it using the VS Code extension. |
| 48 | + |
| 49 | + |
| 50 | + |
| 51 | +When deployment completes, you will see the processes running on the target in the Topo sidebar: |
| 52 | + |
| 53 | + |
| 54 | + |
| 55 | +Open the application in your browser just as you did with the CLI workflow: |
| 56 | + |
| 57 | +```output |
| 58 | +http://<target-ip>:3000 |
| 59 | +``` |
| 60 | + |
| 61 | +## What you've accomplished |
| 62 | + |
| 63 | +You have now seen two ways to deploy Topo workloads: directly from the command line and from Visual Studio Code. Both approaches use the same target checks, template metadata, and deployment flow, so you can choose the interface that best fits your workflow. |
0 commit comments