Getting Started with Codewind

There are three ways of using Codewind - locally, remotely or as a hosted application on the cloud. To get started, you can try out Codewind by using the local configuration. In this configuration, you create, develop, build and run your containerised applications on your local machine using your local IDE.

Follow the instructions to get started with using Codewind locally. This will guide you through:

  1. Installing Codewind into your IDE on your local machine
  2. Creating your first project
  3. Making a code change to try out the inner loop experience

Select your IDE to get started:

Codewind on Eclipse Che If you want to go straight to using Codewind as a hosted application in the cloud, follow these instructions.

Using Codewind Remotely If you want to use Codewind remotely, you must first follow the step to install Codewind locally. By using Codewind remotely, Codewind is configured for making code changes on your local IDE but building and running your application in the cloud. Once you have installed Codewind remotely, you can proceed to either:

  1. Deploy Codewind to your cloud if not already done so by you or a sysadmin/DevOps engineer. See tutorial Deploying Codewind Remotely.
  2. Connect your Codewind extension of your local desktop IDE to Codewind in your cloud by following the tutorial Using Codewind Remotely.

The different configurations of Codewind To find out about the different ways of using Codewind - locally, remotely, or as an application hosted on the cloud - see Codewind Architecture.

Installing Codewind for VS Code

Install Codewind for Visual Studio Code (VS Code) to develop your containerized projects from within VS Code.

To install Codewind for VS Code, complete the following steps:

  1. Install VS Code version 1.41.0 or later.
  2. Install Docker 17.06 or later. If you use Linux, you must also install Docker Compose.
  3. If you are installing Codewind on Windows, enable your local drive for sharing in Docker. To do this, open the Docker Settings window, click the Shared Drives tab, and select the drive on which you are installing Codewind.
  4. Install Codewind by clicking this link to install from the VS Code Marketplace or by searching for Codewind in the VS Code Extensions view.
  5. 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.
  6. Codewind requires the installation of additional Docker images to run. Choose Install when prompted to complete the installation. The installation might take a few minutes to complete.
  7. Once complete, you have a Codewind section in the IDE.

image of Codewind once installed

After Installation

Getting started with Codewind - next steps Continue to instructions for creating your first VS Code Codewind Project.

Installing Codewind for remote use If you intend to use Codewind remotely, you have now completed the pre-requisite step of installing Codewind on your local machine and can proceed to:

  1. Deploy Codewind to your cloud if not already done so by you or a sysadmin/DevOps engineer. See tutorial Deploying Codewind Remotely.
  2. Connect your Codewind extension of your local desktop IDE to Codewind in your cloud by following the tutorial Using Codewind Remotely.