platform-environment-validate
forcedotcom/sf-skills
Validate and configure your local Salesforce development environment with a prerequisite scan.
What is platform-environment-validate?
Runs a comprehensive check of required tools (Salesforce CLI, Node.js, NPM, Git, Code Analyzer, MCP, and source tracking) and reports per-tool status. Use this when you need to verify your setup is complete, troubleshoot missing tools, or confirm prerequisites before starting Salesforce development.
- Scans all required Salesforce development tools and reports status (green/yellow/red) for each
- Detects missing, outdated, or misconfigured tools with actionable fix hints
- Handles JIT plugins correctly (Code Analyzer auto-installs on first use)
- Checks MCP configuration, endpoint connectivity, and provides guidance on process health
- Offers guided install/update options for tools that need attention
- Provides diagnostic information (paths, shell, platform) when critical failures occur
How to install platform-environment-validate
npx skills add https://github.com/forcedotcom/sf-skills --skill platform-environment-validateHow to use platform-environment-validate
- 1.Run the skill when prompted or when you need to check your setup
- 2.Review the status banner showing each tool's state (green/yellow/red)
- 3.If issues are found, choose to fix all items, select specific ones, or skip
- 4.Follow the provided install/update commands for your OS (macOS/Linux/Windows)
- 5.Confirm the command before it runs; re-run the skill after fixes to verify
Use cases
- Verify your local environment is ready before starting a new Salesforce project
- Troubleshoot why a tool isn't being found or recognized
- Update outdated tools after a Salesforce CLI or Node.js release
- Confirm MCP is properly configured and the org instance is reachable
- Check source tracking is enabled for your connected org
- Salesforce developers setting up a new machine or workspace
- Teams onboarding new developers and verifying prerequisites
- Developers troubleshooting tool resolution or environment issues
- Anyone preparing to use Salesforce development skills in Claude Code or Cursor
platform-environment-validate FAQ
🟢 Green = tool is installed and meets requirements. 🟡 Yellow = tool is installed but outdated or misconfigured. 🔴 Red = tool is missing or below minimum version and blocks Salesforce development. ℹ️ Info = contextual note that cannot be auto-verified (e.g., MCP process health).
Code Analyzer is a JIT (just-in-time) plugin — it's registered with the CLI and will auto-install the first time you run a code-analyzer command. The skill recognizes this and reports it as ready.
The script cannot verify the MCP subprocess directly. Confirm process health by running `/mcp` or `/doctor` in Claude Code to see if the MCP connection is active.
No — the skill shows you the correct command for your OS and asks you to confirm before running it. This ensures you control what gets installed.
The skill will use the deterministic renderer to print the banner. The JSON result is always the authoritative source of truth; do not override a failed check by re-running the tool a different way.
Full instructions (SKILL.md)
Source of truth, from forcedotcom/sf-skills.
name: platform-environment-validate description: "Validate and configure the local Salesforce development environment. Runs a prerequisite scan across required tools with per-tool status and offers to install or update missing items. Use when the user asks to 'check my setup', 'validate tools', 'verify prerequisites', 'am I set up correctly', or reports a tool is missing or not working. DO NOT TRIGGER for org auth (/salesforce-development:login), deployment problems (platform-metadata-deploy), or status checks (/salesforce-development:status)." allowed-tools:
- Bash
- Read
Validating: Salesforce Development Environment
Validate all required prerequisites and surface a clear, actionable status report. This skill is on-demand — it does not run automatically on session start. Run it explicitly to check or repair your local setup.
Phase 1: Prerequisite Scan
Run the tool check:
${CLAUDE_PLUGIN_ROOT}/scripts/sf-context check-tools
The output is a JSON object with a tools array (plus a diagnostic block on any critical failure).
The banner is painted for you — do not reproduce it. When check-tools runs, the plugin paints the framed "Ready to build on Salesforce?" banner deterministically on the visible channel — one status row per tool, the footer verdict, and the wayfinding footer — exactly like the SessionStart banner. It is a Tier-1 surface: read the JSON for your own understanding, but do NOT reproduce, redraw, or re-render the banner. Add only a short read of what the result means for the user, then go to Phase 2.
The painted banner looks like this (illustrative — the version/message text in each row comes straight from the JSON: version for 🟢, message + fix hint for 🟡/🔴, the note for ℹ️; the values below show the style, not fixed strings):
──────────────────────────────────────────────────────────────
Ready to build on Salesforce? checking your toolchain…
──────────────────────────────────────────────────────────────
🟢 Salesforce CLI v2.144.6
🟢 Code Analyzer v5.14.0 · JIT, auto-installs on first use
🟢 Node.js v22.11.0 LTS
🟢 NPM v10.9.0
🟢 Git v2.50.1
🟢 Salesforce MCP (config) .mcp.json + proxy present
🟢 Salesforce MCP (endpoint) org instance reachable
ℹ️ Salesforce MCP (process) confirm with /mcp or /doctor
🟢 Source Tracking enabled
──────────────────────────────────────────────────────────────
✓ toolchain ready (skill: platform-environment-validate)
Each row's status dot carries the state — 🔴 critical (missing or below minimum — Salesforce development cannot proceed), 🟡 warn (installed but outdated, non-LTS, or misconfigured), 🟢 ok, ℹ️ info (a contextual note that can't be auto-verified, e.g. MCP process health) — and the framed footer gives the verdict plus the single most relevant Next: step. The JSON status field is the source of truth per tool; use these states when you write your short read.
If the banner did not paint (an older Claude Code build, or a paint fallback), do not hand-render it from the JSON. Print it with the deterministic renderer instead:
${CLAUDE_PLUGIN_ROOT}/scripts/sf-context readiness-banner
This reads the same scan result check-tools just recorded and prints the identical framed banner — rows in fixed order, the footer verdict, and the "you don't memorize commands here" wayfinding footer with its Next: step — so ordering, padding, counts, and next-step selection are decided once in the script, never re-derived by hand. The check-tools JSON stays the authoritative, machine-readable result.
Deterministic results — do NOT override a failure: the JSON report
is the authoritative, machine-readable result. If a tool reports 🔴/🟡, report it
as-is. Do not re-run the tool a different way (PowerShell, a raw shell probe,
a different command) and then present the result as 🟢 — a fallback that happens
to find the tool does not mean the deterministic check passed. A failed check
must stay failed until that same check-tools check passes. When the report
includes a diagnostic block (attached on any critical failure), surface it: it
carries the platform, active shell, working directory, plugin root, and the
resolved executable paths — the fastest way to see why a tool didn't resolve
(e.g. a Windows sf.cmd not on PATH). The diagnostic is secret-free by design;
never add tokens or org auth to it.
MCP is reported as three distinct rows — never inferred from one another:
Salesforce MCP (config) (is .mcp.json + the sf-mcp-proxy.bundled.js present?),
Salesforce MCP (endpoint) (is the platform endpoint reachable?), and
Salesforce MCP (process) (is the MCP process actually healthy?). The process row
is reported as ℹ️ informational (not a warning) — this script cannot see the
MCP subprocess that Claude Code owns, so a green config/endpoint must not be
presented as a working MCP. Confirm process health with /mcp or /doctor. The
endpoint row probes the org instance URL as a connectivity proxy, not the
platform-MCP endpoint itself.
Tools Checked
| Tool | Minimum Requirement | Verification |
|---|---|---|
| Salesforce CLI | Present, and on the latest release | sf --version (🟡 when an update is available) |
| Code Analyzer plugin | Installed or JIT-registered | sf plugins inspect @salesforce/plugin-code-analyzer, falling back to the CLI's oclif.jitPlugins registry |
| Node.js | >= 18 (even/LTS) | node --version |
| NPM | >= 3.10 | npm --version |
| Git | Must be present | git --version |
| Salesforce MCP (config) | .mcp.json configured + proxy bundle present | Plugin root .mcp.json check + sf-mcp-proxy.bundled.js presence |
| Salesforce MCP (endpoint) | Org instance URL reachable (connectivity proxy) | HTTP probe of org instance URL |
| Salesforce MCP (process) | ℹ️ informational — not verifiable here | Confirm with /mcp or /doctor |
| Source Tracking | Enabled for connected org | sf project deploy preview |
All external tools (sf, npm, node, git) are launched through a single
cross-platform resolver: shutil.which (PATHEXT-aware) finds the tool,
and a Windows .cmd/.bat shim (sf.cmd, npm.cmd) is invoked via a
COMSPEC-wrapped argv array — never a shell string — so this scan and
/salesforce-development:org detect sf/npm/the default org correctly on
Windows, macOS, and Linux.
Code Analyzer is a JIT plugin — registered ≠ installed. The Salesforce CLI
declares @salesforce/plugin-code-analyzer as a "just-in-time" (JIT) plugin: it
is only physically installed the first time a sf code-analyzer command runs.
Until then, sf plugins inspect fails for it even though it is fully
available to the user. The check therefore treats JIT registration as success —
if inspect returns no version, it falls back to the CLI's own
oclif.jitPlugins registry (read from the root entry of sf plugins --json) and
reports 🟢 with the pinned version and a note that it auto-installs on first use.
Only a plugin that is neither installed nor JIT-registered is 🔴 critical.
Phase 2: Install / Update
If all green: Confirm setup is complete. The user is ready to develop.
If warnings or critical items exist: Present the user with options:
Some tools need attention. What would you like to do?
[1] Fix all items
[2] Choose which items to fix
[3] Skip for now
For each tool the user wants to fix, provide the correct install/update command for their OS. Do not run install commands automatically — show the command and ask the user to confirm before running it.
Install / Update Commands by Tool
Salesforce CLI — not installed:
# macOS/Linux (npm)
npm install --global @salesforce/cli
# macOS (Homebrew)
brew install sf
Salesforce CLI — update:
sf update
Code Analyzer plugin — not installed:
sf plugins install @salesforce/plugin-code-analyzer
Code Analyzer plugin — update:
sf plugins update @salesforce/plugin-code-analyzer
Node.js — not installed or below minimum:
# macOS (nvm — recommended, installs LTS)
nvm install --lts && nvm use --lts
# macOS (Homebrew)
brew install node
# Windows — download from https://nodejs.org (LTS version)
NPM — update:
npm install --global npm@latest
Git — not installed:
# macOS (Xcode CLT)
xcode-select --install
# macOS (Homebrew)
brew install git
# Windows — download from https://git-scm.com
Source Tracking — not enabled:
sf org enable tracking --target-org <alias>
Salesforce MCP — misconfigured: If .mcp.json is missing or empty, reload the plugin:
/reload-plugins
Important Notes
- After installing a tool that modifies PATH (Node.js, SF CLI), the user may need to exit and restart Claude Code for the change to take effect.
- Source Tracking requires a connected org — if no org is configured, prompt to run
/salesforce-development:loginfirst. - For org authentication issues (expired session, wrong org, INVALID_SESSION_ID), run
/salesforce-development:logininstead of this skill. - SF CLI outdated → 🟡 in the readiness scan: readiness means latest. When the CLI's cached update check reports a newer release,
check-toolsreports the Salesforce CLI as 🟡 (installed but outdated) with the correct update command, rather than 🟢. Unlike the session-start notice below, this warning ignores the per-version no-nag gate — an explicit readiness scan always reports the factual state — but it still honors the hard opt-outSFDX_SKIP_CLI_UPDATE_CHECK=1. - SF CLI update notice at session start: when the CLI reports an available update, the
sf-context detectSessionStart hook surfaces it once and asks the agent to offer the update (sf update, ornpm install --global @salesforce/cli@latestfor npm-global installs). Declining or a failed update records a per-version no-nag gate (.sf/sf-cli-update-state.json) so the same version won't nag again, but a newer release will re-prompt. SetSFDX_SKIP_CLI_UPDATE_CHECK=1to disable the check entirely.
Related skills
More from forcedotcom/sf-skills and the wider catalog.

platform-flexipage-generate
Create, generate, and customize Salesforce Lightning FlexiPages with CLI-driven metadata generation.

platform-lightning-app-coordinate
Build complete Salesforce Lightning Experience applications from natural language descriptions.

platform-lightning-type-widget-coordinate
Coordinate Apex-backed Lightning Type and HXL widget generation for Salesforce.

platform-list-view-generate
Create and validate Salesforce List View metadata for filtered record listings.

platform-lsp-integrate
Reference for Salesforce LSP MCP tools, error codes, and fallback patterns.

platform-manifest-generate
Generate Salesforce package.xml and destructive manifests from source, component lists, or org introspection.