Contact Us 1-800-596-4880
  1. Homepage
  2. Anypoint Code Builder
  3. Getting Started

  4. Setting Up the Desktop IDE

Setting Up the Desktop IDE

logo desktop IDE Desktop IDE

Open Beta Release: The cloud IDE is in open beta. Any use of Anypoint Code Builder in its beta state is subject to the applicable beta services terms and conditions, available from the IDE.

The desktop-based IDE extensions in Anypoint Extension Pack are available from the Visual Studio Marketplace.

Before You Begin Desktop IDE Setup

Before installing the desktop extensions to VS Code, set up git and have an Anypoint Platform account with the required permissions:

  • Install git, and add git to your PATH. To work properly, some Anypoint Extension Pack extensions depend on this requirement.

  • Anypoint Platform requires a user account. You can use an existing account or create one from Anypoint Platform in the US or EU cloud (see US and EU Cloud Hosts). Unexpired trial accounts are allowed.

  • An administrator with an Anypoint Platform organization account must provide you with the necessary permissions. See Configuring Permissions.

For information about OS and system compatibility, see Anypoint Code Builder Release Notes.

Install, Update, or Uninstall Anypoint Extension Pack

Use of Anypoint Code Builder in VS Code on your computer requires the Anypoint Extension Pack.

Install Anypoint Extension Pack

To install the Anypoint Extension Pack into the desktop IDE:

  1. Open VS Code.

  2. Find Anypoint Extension Pack from the desktop IDE or from Visual Studio Marketplace.

    To avoid installation errors:

    Do not install the individual Anypoint Code Builder extensions that are also available separately from Anypoint Extension Pack in Visual Studio Marketplace.

    • To install from the desktop IDE, launch the Extensions menu by clicking the Extensions icon from the activity bar or pressing Cmd+Shift+x (Mac) or Ctrl+Shift+x (Windows), and search for the extension pack.

      Select Install Release Version.

    • To install from the Visual Studio Marketplace website, find the extension pack, and install:

      Select Install Release Version.

      For additional guidance, see the Visual Studio Code website.

  3. Open the Extensions menu, and review the extensions in Anypoint Extension Pack:

    Anypoint Extension Pack contains these extensions:

    • Anypoint Code Builder - API Extension

    • Anypoint Code Builder - APIkit Extension

    • Anypoint Code Builder - DataWeave Extension

    • Anypoint Code Builder - Dependencies Extension

    • Anypoint Code Builder - Integration Extension

    • Anypoint Code Builder - MUnit Extension

    • Anypoint Code Builder - Platform Extension

      For versioning information about extensions in Anypoint Extension Pack, see the Change Log.

  4. Recommended: Ensure that the Anypoint extensions update automatically by right-clicking each extension to see if Auto Update All (From Publisher) is checked. If it’s not, select Auto Update for each extension, for example:

    Setting an extension to auto-update

    Ensure this option is checked.

  5. Click the MuleSoft icon in the activity bar to access and use Anypoint Code Builder features.

    MuleSoft icon for Anypoint Code Builder in the activity bar

  6. Check that the IDE loads the Anypoint Code Builder menu with Quick Actions and Documentation links.

  7. If you have an Anypoint Platform account running in the EU cloud, change the Mule: Control Plane setting to EU cloud.

    For guidance, see Set the Desktop IDE to the EU or US Cloud.

  8. Follow the steps in Log in to Anypoint Platform from the IDE.

    NOTE

    If an Anypoint Platform session is active in any of your browsers when you install Anypoint Extension Pack, the extension pack uses that session to sign in to Anypoint Platform from the IDE. You can log out or sign in from the status bar in the IDE.

Update Anypoint Extension Pack

If Anypoint Extension Pack is installed on your desktop IDE, update to the latest version of the extension pack by following VS Code instructions in Update an extension manually.

Uninstall Anypoint Extension Pack

Typically, it is unnecessary to uninstall the extension pack or individual Anypoint Code Builder extensions from VS Code. For example, you can update to a new version without uninstalling first.

If you decide to uninstall Anypoint Extension Pack, follow the same procedure that you use for other VS Code extensions. Uninstalling the extension pack also uninstalls the individual Anypoint Code Builder extensions that are bundled within the extension pack, such as the DataWeave and APIkit extensions.

To uninstall:

  1. Open VS Code.

  2. From the activity bar, open the Extensions panel.

  3. Find and select Anypoint Extension Pack.

  4. In the Anypoint Extension Pack tab that opens, click Uninstall.

  5. To remove the Anypoint Code Builder extensions from the Extensions panel, click Reload on one of the extensions.

For additional guidance, see the VS Code documentation, Manage extensions.

You can reinstall at any time.