The Choreo VS Code extension enhances your local development experience with Choreo projects by providing a wide range of project and component management capabilities. Learn more about Choreo.
For a seamless development experience with the Choreo extension, ensure the following are configured in your local environment:
- Visual Studio Code with the Choreo extension installed.
- Ballerina distribution Update 4 or later.
- Ballerina extension for VS Code, version 4.0.0 or later
You need an active Choreo account to utilize the capabilities of the Choreo extension in the VS Code editor. If you already have a Choreo account, follow the steps below to set up the extension.
-
Install the Choreo extension from the Visual Studio Code Marketplace and wait for activation.
-
Sign in to Choreo using one of the following methods:
- Via the Sign In prompt displayed upon successful activation of the extension
- Via the Sign In option, which becomes available when you click the Choreo icon on the activity bar of your VS Code editor
The above step redirects you to an external URI to complete the authentication process. If the sign-in is successful, all projects and organizations linked to your Choreo account will be visible in the Choreo activity panel as shown below.
Tip: If you already have a Choreo project, you can skip this section and move to the Clone a Project section.
Follow the steps below to create a new Choreo project directly from VS Code.
-
Execute the Create new project command or click the + button next to the project list in the Choreo activity panel to run the Choreo.
-
Complete the new project wizard by providing a GitHub repository if you want to use a mono repo for the project, in which all components will be stored.
**Info:**You may be redirected to GitHub to authorize a repository to be linked to the project.
Cloning a project helps you to easily create a copy of your project in the local environment. Follow the steps below to clone a project.
-
Navigate to the Choreo activity panel.
-
Select the project from the project list.
Tip: This will open the project overview displaying the list of components for that project.
-
Click the Clone button to clone the repository and the project locally.
-
Select a directory to store the project.
-
Once the project is cloned, click Open Project to load it into VS Code.
Info: Each component will be available as a workspace item. Click the Open project button if the project is already cloned.
Follow the steps below to design and develop your application.
-
Once the project is opened from the Project Overview page, click Architecture Diagram.
-
Click the Add Component button to create components in the Architecture View.
Tip: You can also mark the interactions between components with the Use APIs link in the context menu.
The above step will create sources for each component locally in the given repo, and each component will be added as a workspace item in VS Code.
Once you created the components, follow the steps below to Push your changes to Choreo.
-
Navigate to the Project Overview page.
Info: The project overview page will inform you that some of the components have not been pushed to the GitHub repository. You can go to the source control activity and commit and push the new component sources to the repo. Once you push the components, they will be visible on the Choreo platform.
-
Click Push Components to Choreo to upload the local components to the Choreo platform.
After creating the components, follow the steps below to deploy your components.
-
Navigate to the Component Deploy page and deploy them.
-
Once the components are deployed, view the build and deployment status from the Project Overview.
For troubleshooting, see the Choreo output. To view the Choreo output tab, click View, click Output, and select Choreo from the output list.
Create Github issues to reach out to us.