Getting started: Codewind for VS Code

Codewind for VS Code enables you to develop and debug your containerized projects from within VS Code (debug is only supported for Microprofile/Java EE, Spring, and Node.js projects).

Complete the following steps to install Codewind for VS Code:

  1. Install VS Code version 1.28 or later.
  2. Install Codewind from the VS Code Marketplace, or by searching for Codewind in the VS Code Extensions view.
  3. Open the Codewind view in the Explorer view group, or enter Focus on Codewind View into the Command Palette.
    • If you do not see the Codewind view in either the Explorer or the Command Palette, the extension did not install correctly.
  4. Codewind requires the installation of additional Docker images to run. Choose Install when prompted to complete the installation. The installation may take a few minutes to complete.
  5. Codewind creates a folder called codewind-workspace within your home directory (C:\codewind-workspace on Windows) to contain your projects. When the installation is complete, you can open the codewind-workspace folder or a project within the workspace as your VS Code workspace. The tools offer to open the workspace for you if it’s not open already.

You are now ready to use the tools. You can use the Codewind view to create new projects or add existing ones. Right-click a project in the Codewind tree or enter Codewind into the Command Palette to look at the features available.

  1. Create a new project or work with an existing project.
    • To create a new project, right-click the Projects (Local) item and select Create New Project, or click on the + icon beside the Projects (Local) item.
    • To work with an existing project, right-click the Projects (Local) item and select Add Existing Project, or click on the link icon beside the Projects (Local) item. Note that the project must already exist within the codewind-workspace folder.
  2. Work with your project from within VS Code including:
    • Editing
    • Debugging
    • Opening the application in a browser
    • Viewing the logs
    • Opening a shell into the application container
    • And more