IBM Cloud Docs
IBM Cloud CLI for Microsoft Visual Studio Code

IBM Cloud CLI for Microsoft Visual Studio Code

The IBM Cloud® CLI extension for Microsoft® Visual Studio Code provides access to capabilities from the IBM Cloud Command Line Interface directly within the VS Code editor’s command palette.

The extension supports the deployment of applications into VMs by using IBM Cloud Kubernetes Service or Red Hat OpenShift on IBM Cloud. The extension can be used for managing toolchains, and more – all without the need to leave the editor’s context.

Screen capture of the IBM Cloud CLI extension download screen.
Figure 1. Extension download screen within Visual Studio Code.

Dependencies

To use the IBM Cloud CLI extension for Visual Studio Code, you need the IBM Cloud CLI installed on your system.

Installation

The simplest way to install the IBM Cloud CLI extension is to use Visual Studio Code’s quick open command:

  1. Open the quick open command palette by using the following key combinations from within the editor:

    • Mac: cmd + p
    • Windows™ or Linux™: ctrl + p
  2. Enter the ext install IBM Cloud CLI command, and then press Enter to install the IBM Cloud CLI extension inside the Visual Studio Code editor.

Or, you can install the IBM Cloud CLI extension through the "Extensions" management window:

  1. Open the Extensions sidebar in the Visual Studio Code editor, and then search by using the string IBM Cloud CLI. The IBM Cloud CLI extension is displayed in the search results.
  2. Click Install to begin the installation.

You can also access the IBM Cloud CLI extension directly within the Visual Studio Code Marketplace.

Usage

Start the extension commands by using Visual Studio Code’s command palette.

First, open the command palette by using the following key combination:

  • Mac: cmd + shift + p
  • Windows™ or Linux™: ctrl + shift + p

Next, either enter or select the command that you want to start. You can type ibmcloud within the command palette to see the list of all available commands.