ApexBlueprint Installation Prerequisites

•Apex Stem Docs
ApexApexBlueprintPrerequisitesSetupCLI
Essential prerequisites and environment setup required before installing ApexBlueprint. Ensure Salesforce CLI, organization configuration, and necessary tools are properly configured.

Before introducing Apex Blueprint, please ensure that the following tools and environments are properly set up.

💡 If you install via the Unlocked Package path, only "Salesforce CLI Setup" and "Target Org" are needed — the make setup is specific to the Git Submodule path. See the Installation Guide for choosing a path.

✅ Salesforce CLI Setup

Apex Blueprint deployment uses the Salesforce CLI. If you haven't installed it yet, please install it from the official website.

  • Installation verification:
BASH 
$ sf -v

If version information is displayed, you're all set.

✅ Target Organization Verification

In your project root directory, run the following command to verify organization information:

BASH 
$ sf org list

Confirm that the organization you want to target has the 🍁Default Org indicator.

Example:

CODE 
┌────┬─────────┬────────────┬────────────────────────────────────────┬────────────────────┬───────────┐
│    │ Type    │ Alias      │ Username                               │ Org Id             │ Status    │
├────┼─────────┼────────────┼────────────────────────────────────────┼────────────────────┼───────────┤
│ 🌳 │ DevHub  │ devhub     │ example-user@example.com               │ 00DxxxxxxxxxxxxXXX │ Connected │
│ 🍁 │ Sandbox │ sandbox    │ example-user@example.com.sandbox       │ 00DyyyyyyyyyyyyYYY │ Connected │
└────┴─────────┴────────────┴────────────────────────────────────────┴────────────────────┴───────────┘

⚙️ Default Organization Configuration

If the 🍁 indicator is not present, log in and configure as follows:

BASH 
# Login to organization (replace alias and URL as appropriate)
$ sf org login web --alias my-sandbox --instance-url https://orgfarm-xxxxxxx-dev-ed.develop.my.salesforce.com
 
# Set as default organization
$ sf config set target-org=my-sandbox

After configuration, run sf org list again to confirm the 🍁 mark is present.

🛠️ Make Command Setup

Apex Blueprint uses a Makefile to simplify some deployment operations. Please verify that the make command is available.

BASH 
$ make -v

If you see output like the following, you're ready:

CODE 
GNU Make 4.3

🔗 Back to Guide

← Back to ApexBlueprint Developer Guide

← Back to ApexBlueprint Guide