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

  4. Using Anypoint Code Builder on Private Cloud Edition

Using Anypoint Code Builder on Private Cloud Edition

Connect the Anypoint Code Builder to an Anypoint Platform Private Cloud Edition 4.3.0 control plane and design, implement, and package Mule applications against that instance. Package a deployable JAR and deploy it to a hybrid server in Runtime Manager on your private network. MuleSoft Vibes skills are optional. When you use them, a coding agent on your machine calls Anypoint CLI against the same Anypoint Platform Private Cloud Edition instance.

Before You Begin

Before you connect Anypoint Code Builder to Anypoint Platform Private Cloud Edition, make sure you have:

  • An Anypoint Platform Private Cloud Edition 4.3.0 environment.

  • Microsoft Visual Studio Code (VS Code) on your computer. Change the control plane. Browser-based Anypoint Code Builder doesn’t provide this setting.

  • Network access from your computer to your Anypoint Platform Private Cloud Edition control plane URL.

  • An Anypoint Platform account on anypoint.mulesoft.com. This account is separate from your Anypoint Platform Private Cloud Edition license. Anypoint Code Builder uses it to retrieve assets and export the application artifact.

  • Network access to the Visual Studio Marketplace and npm, or the private distribution bundle and offline packages for Anypoint CLI and MuleSoft Vibes skills. Request the offline packages from your customer success manager.

  • Node.js 22.0.0 or later and npm 7 or later, when you install Anypoint CLI or MuleSoft Vibes skills.

  • Maven and a JDK on your terminal PATH, when a coding agent runs mvn clean package. Run mvn -v to confirm both are available.

  • A connected app in Anypoint Platform Private Cloud Edition, when you use Anypoint CLI or MuleSoft Vibes skills. Grant the connected app only the scopes the skills need.

Install Anypoint Code Builder for a Private Network

Install Anypoint Extension Pack from the Visual Studio Marketplace when your computer can reach the Marketplace. When it can’t, install the private distribution bundle.

Install from the Visual Studio Marketplace

In VS Code, to install Anypoint Extension Pack, see Setting Up Anypoint Code Builder.

Install the Private Distribution Bundle

The private distribution bundle is on the Customer Portal page in the Salesforce Help customer portal. The installer script installs every Anypoint Code Builder extension.

To install the bundle:

  1. Unpack the bundle and run the installer.

    • macOS

    • Windows

    Decompress the private-dist archive. Open a terminal in the resulting folder and run:

    +

    ./install-bundle.sh

    Unzip the private-dist archive at the root of C:\, for example C:\win32-x64-dist. If you unzip it into a deeply nested folder, the install fails because the file paths exceed the Windows path-length limit.

    + In the extracted folder, right-click install-bundle-windows.ps1 and select Run with PowerShell.

    + If PowerShell reports that install-bundle-windows.ps1 can’t be loaded because the file isn’t digitally signed, open PowerShell in the extracted folder, run this command, and then run the script again from that same window:

    +

    Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
.\install-bundle-windows.ps1

  2. When the installer asks Would you like to clean up your currently installed ACB extensions? (Y/n), enter Y.

    This removes the Anypoint Code Builder extensions already installed so the bundle starts from a clean set.

  3. When the install finishes, open the Command Palette and run Developer: Reload Window.

    The MuleSoft icon appears in the activity bar.

Connect Anypoint Code Builder to Your Anypoint Platform Private Cloud Edition Control Plane

Anypoint Code Builder talks to the MuleSoft-hosted control plane until you select Private Cloud Edition.

To connect to your Anypoint Platform Private Cloud Edition control plane:

  1. In VS Code, open Settings > Extensions > Anypoint Code Builder (Platform).

    You can also open MuleSoft settings from the Command Palette. See Set Anypoint Code Builder to a Different Control Plane.

  2. Set Mule: Control Plane to Private Cloud Edition.

  3. Set Mule: Control Plane Anypoint Platform Private Cloud Edition_URL to your Anypoint Platform Private Cloud Edition control plane URL, for example https://pce.example.com.

    Anypoint Code Builder uses this URL only when Private Cloud Edition is selected and imports custom SSL certificates for that host automatically.

  4. Restart Anypoint Code Builder.

  5. Open the Command Palette and run:

    MuleSoft: Login to Anypoint Platform

    Anypoint Code Builder opens your Anypoint Platform Private Cloud Edition sign-in page. Sign-in uses OAuth or OIDC with the identity provider hosted by Anypoint Platform Private Cloud Edition.

  6. Confirm that the status bar shows your username.

Private cloud mode keeps application metadata in your network and blocks standard cloud telemetry.

If you use SSO or multi-factor authentication, set the ANYPOINT_BEARER_TOKEN environment variable in your terminal to an access token from your authenticated Anypoint Platform session.

For the setting descriptions, see Mule: Control Plane and Mule: Control Plane Anypoint Platform Private Cloud Edition_URL.

Configure Anypoint CLI for Anypoint Platform Private Cloud Edition

Anypoint CLI plugins for Anypoint Platform Private Cloud Edition manage business groups, roles, and federated identity settings, Design Center projects, Exchange assets and Maven dependencies, and API Manager registration, contracts, and policies. The CLI runs in the VS Code terminal and in other shells, including CI/CD jobs, against your Anypoint Platform Private Cloud Edition instance.

Install the CLI and confirm that it runs:

npm install -g anypoint-cli-v4-public
anypoint-cli-v4 --version

If the shell returns command not found, add npm’s global bin directory to your PATH.

Install the plugins that Anypoint Platform Private Cloud Edition supports:

anypoint-cli-v4 plugins:install anypoint-cli-account-plugin
anypoint-cli-v4 plugins:install anypoint-cli-api-manager-plugin
anypoint-cli-v4 plugins:install anypoint-cli-exchange-plugin
anypoint-cli-v4 plugins:install mulesoft-anypoint-cli-designcenter-plugin

To install the CLI from the offline package, unzip the Anypoint CLI installer and run the install script from that folder. The script installs the CLI and the plugins:

./install.sh

Run anypoint-cli-v4 plugins and confirm that all four plugins are listed.

Anypoint CLI runs on Node.js, which rejects an Anypoint Platform Private Cloud Edition TLS certificate it doesn’t recognize. Point Node.js at the certificate before you call the CLI.

On macOS or Linux, save the certificate and point Node.js at it:

echo | openssl s_client -connect pce.example.com:443 -showcerts 2>/dev/null | openssl x509 -outform PEM > anypoint.pem
export NODE_EXTRA_CA_CERTS=$(pwd)/anypoint.pem

Replace pce.example.com with your Anypoint Platform Private Cloud Edition host. Add the export line to your shell profile, such as ~/.zshrc, so new terminals and your coding agent pick it up.

On Windows, open your Anypoint Platform Private Cloud Edition URL in Chrome or Edge, view the site certificate, and export it as a Base64-encoded PEM file. Then point Node.js at it and restart VS Code:

setx NODE_EXTRA_CA_CERTS "C:\certs\anypoint.pem"

If your Anypoint Platform Private Cloud Edition certificate comes from an internal CA, set NODE_EXTRA_CA_CERTS to your organization’s root CA file instead.

Point the CLI at your Anypoint Platform Private Cloud Edition host, organization, environment, and connected app. Use the hostname only, without https://.

anypoint-cli-v4 conf host pce.example.com
anypoint-cli-v4 conf organization <root-org-id>
anypoint-cli-v4 conf client_id <your-client-id>
anypoint-cli-v4 conf client_secret <your-client-secret>
anypoint-cli-v4 conf session.selectedOrganization.id <your-org-id>
anypoint-cli-v4 conf session.selectedEnvironment.id <your-environment-id>

The CLI stores these values in its local config. The agent acts with the permissions of the connected app.

Confirm the connection:

anypoint-cli-v4 account:business-group:list

When the command returns your Anypoint Platform Private Cloud Edition business groups, the CLI is talking to your instance. For other conf keys, see Authentication to the Anypoint Platform CLI.

Add MuleSoft Vibes Skills

MuleSoft Vibes is optional on Anypoint Platform Private Cloud Edition. The skills are files on your machine. They run in a coding agent such as Claude Code, Cursor, or others. The skills call the Anypoint CLI you configured for Anypoint Platform Private Cloud Edition.

Point the coding agent at your organization’s internal model endpoint so prompts and code stay inside your network.

The MuleSoft Vibes assistant inside Anypoint Code Builder, including Einstein generative AI, is available on the US, EU, Canada, Japan, India, Australia, and United Kingdom cloud hosts. See MuleSoft Vibes Overview.

To install the skills when your computer can reach npm:

  1. Install @salesforce/anypoint-cli-dx-mule-plugin version 1.3.0 or later:

    npm install -g @salesforce/anypoint-cli-dx-mule-plugin@latest

  2. Add the MuleSoft skills:

    npx skills add mulesoft/mulesoft-dx/skills/mule-development

To install from the offline package, install the DX Mule plugin from the local file, then add the skills from the unzipped skills folder:

npm install -g ./<dx-mule-plugin-file>.tgz
npx skills add ./<path-to-unzipped>/skills/mule-development

The installer asks you to:

  1. Keep Universal (.agents/skills) selected, and select any other approved agents, such as Claude Code (.claude/skills).

  2. Choose Project or Global for the scope.

  3. Choose Symlink (Recommended).

  4. Confirm the installation.

For the full installer steps and the skills catalog, see Using Skills with MuleSoft Vibes.

To add organization-specific rules, such as naming conventions, standard headers, or required logging, see Workflows and Rules. To store private skills in a repository, see Sharing Rules and Skills from GitHub with MuleSoft Vibes and Set Up Skills in Your Project.

Check the CLI and the Skills

Before you build an application, confirm:

  1. The Anypoint Code Builder status bar shows that you are signed in to your Anypoint Platform Private Cloud Edition instance.

  2. anypoint-cli-v4 account:business-group:list returns your Anypoint Platform Private Cloud Edition business groups.

  3. The skills you installed appear under .agents/skills or .claude/skills in your project.

Build an Application in Phases

Ask the agent to build one phase at a time so you can review each change in the Anypoint Code Builder canvas. Give the agent the source and target systems, schemas, and business rules.

  1. Generate a phased plan from your API specification, data documentation, and product requirements document (PRD).

  2. Implement one phase at a time. Each phase must finish mvn clean package with BUILD SUCCESS before the next phase starts.

  3. Write MUnit tests for the finished flows.

  4. Document the application.

Name the build-mule-integration skill in the prompt, limit the prompt to one phase, and make the Maven build the gate:

Use /build-mule-integration.
Read IMPLEMENTATION_PLAN.md and implement Phase 1 only: <first endpoints in your plan>.
When you're done, run mvn clean package.
If it isn't BUILD SUCCESS, stop and report the error. Don't start Phase 2.

Review the flow in the canvas before you start the next phase. If the build fails, send the error or your notes back to the agent, or revert the phase and narrow its scope.

build-mule-integration builds flows and applications from a specification and can add MUnit tests to an existing application. secure-mule-app scans configuration for security risks, encrypts secure properties, and suggests logging improvements. generate-doc-description writes doc:description values for flows that don’t have them. You can also prompt for DataWeave mappings. For the skill descriptions, see MuleSoft Skills Catalog.

Choose a Mule Runtime Version for Anypoint Platform Private Cloud Edition

Anypoint Platform Private Cloud Edition 4.3.0 supports these Mule runtime versions:

Mule runtime engine Java

4.6

8 and 17

4.9

17

4.11

17

4.12

17

Bundled Mule runtime versions in Anypoint Code Builder are available when the control plane is Private Cloud Edition. To add a runtime that Anypoint Code Builder doesn’t include, see Add a Mule Runtime Version Locally.

Anypoint Code Builder doesn’t validate that a Mule runtime version is compatible with your Anypoint Platform Private Cloud Edition environment. Confirm compatibility before you run or deploy.

Anypoint Platform Private Cloud Edition 4.3.0 supports FIPS 140-3. To enable FIPS mode in Anypoint Code Builder, see Configuring FIPS Compliance in Anypoint Code Builder. That topic requires a FIPS 140-3 compliant runtime: Mule runtime 4.9 (LTS) or 4.10 and later, and Java 17 for Mule runtime 4.9.

For bundled and project versions, see Version Settings for Mule, Java, and Connectors.

Deploy a Mule Application to Anypoint Platform Private Cloud Edition

Develop the specification, the flow, DataWeave transformations, and security configuration in Anypoint Code Builder.

MuleSoft: Deploy to CloudHub deploys to CloudHub or CloudHub 2.0. To deploy to Anypoint Platform Private Cloud Edition, export a deployable JAR and upload it in Runtime Manager.

The hybrid server must be registered and in the Running state. See Deploying Mule Applications to Anypoint Platform PCE.

To package the application:

  1. In the VS Code Explorer, right-click mule-artifact.json or any XML file in src/main/mule.

    You can also open the Command Palette and run MuleSoft: Export Mule Project.

  2. Select Export Mule Project.

  3. Choose Deployable JAR.

  4. Select Include Project Sources.

    Project sources let you import the project again later.

  5. Save the JAR on your computer.

See Deployable JAR.

To deploy the JAR:

  1. Log in to Anypoint Platform Private Cloud Edition and open Runtime Manager.

  2. Select the environment, and then click Deploy Application.

  3. Set Deployment Target to your hybrid server or cluster.

  4. Click Choose File > Upload File and select the JAR.

  5. Click Deploy Application.

After the application status is Started, apply API Manager policies to the endpoints. Use API Manager in Anypoint Platform Private Cloud Edition, or the Anypoint CLI API Manager plugin.

To validate the deployment:

  1. In Runtime Manager, wait until the application status is Started.

  2. Send a request to the server IP and the port in your HTTP Listener, for example http://10.0.0.1:8081/api/test.

  3. Open the Logs tab in Runtime Manager and confirm that the request was processed.

Publish an Asset to Exchange on Anypoint Platform Private Cloud Edition

Publishing an asset directly from Anypoint Code Builder to Exchange on Anypoint Platform Private Cloud Edition has partial support. Publish the deployable JAR from Exchange in Anypoint Platform Private Cloud Edition:

  1. In Anypoint Platform Private Cloud Edition, open Exchange.

  2. Click Publish New Asset.

  3. Enter an asset name and select Mule Application as the asset type.

  4. Upload the same JAR file.

The asset is published to your organization’s private library.

To publish an API specification from Anypoint Code Builder on a MuleSoft-hosted control plane, see Publishing API Projects to Exchange.

See Also