Creating a New Salesforce Project
Walk the user through a wizard that scaffolds a new Salesforce DX project, relocates this session into the new project, connects it to an org, and configures it for development. Run each step in order, confirming with the user before any environment-changing action.
The
plugin's MCP servers (
,
salesforce-metadata-experts
,
) are provided by the
installed plugin, not by the project — so they stay available in the new project automatically once the session relocates. There is no per-project
to copy.
Step 1: Choose a Project Template
Prompt the user to pick a template. Default to
if they don't have a preference.
| Template | Use for |
|---|
| (default) | General-purpose SFDX project with the conventional layout |
| Bare project with minimal scaffolding |
| CRM Analytics (Tableau CRM) development |
| React-based internal app |
| React-based external/experience app |
| Agentforce agent development |
Step 2: Choose a Project Name
Prompt the user for a project name. This becomes the new directory name, so it must be a valid directory name (no spaces or path separators).
Step 3: Generate the Project
Run in the current working directory:
bash
sf project generate -t {template} -n {name}
This creates a new
directory under the current working directory.
Step 4: Relocate the Session Into the New Project
Modern Claude Code (v2.1.169+) can move the current session into the new directory in place — no new terminal, no relaunch, conversation history preserved. Tell the user to run:
This relocates the session: the new directory's
is loaded, project storage moves there (so
/
find it), and the cwd becomes the project root, so all remaining
commands run as plain
with no path prefix.
is a client-side move: it fires no hook and gives you no turn, so the session goes
quiet the instant they run it — expected, not a hang. But it also means the message in which you hand them
is your last word until they speak again, so that message MUST end with an affordance telling them how to resume. Close it with a line like:
Once you're in, just say "what's next" (or "connect an org") and I'll pick up from there.
Saying "what's next" re-engages this session and paints the position rail, which points at the next step (authenticating an org). Never imply the session will continue on its own after
— it won't.
When they re-engage, confirm the move in one short line (e.g. "You're in {name} now.") and continue to Step 5. Do
not run
or
to "re-surface" the banner:
invoked as a tool prints the raw hook JSON (not a rendered banner), and the plugin already surfaces the banner on its own — it shows the HEADLESS identity once per session (at the user's first Salesforce ask, at session start, or on their first orientation question), and paints the position rail whenever they ask "where am I" / "what's next". A dev-environment health check is available on demand via
/salesforce-development:setup
.
Fallback for older Claude Code (before v2.1.169): reports
. In that case the user must relaunch in the new directory instead:
The
plugin is installed globally (via the marketplace), so a fresh session in the new directory loads it automatically and fires SessionStart — the banner and health check appear on their own, no manual
calls needed. The remaining steps below then run from inside the project.
Step 5: Authenticate to an Org
Authenticate the org this project will deploy to:
bash
sf org login web --alias {alias}
- Prompt the user for an so later steps can reference the org by name.
- For a sandbox, add
--instance-url https://test.salesforce.com
.
- For production, omit (defaults to login.salesforce.com).
If the user already has the org authenticated, skip the login and just collect the existing alias.
Step 6: Set as Default Org
Set the freshly authenticated org as the project's default target:
bash
sf config set target-org {alias}
Step 7: Ensure Source Tracking Is Enabled
Check whether source tracking works against the org using a deploy preview (the lightest read-only source-tracking probe):
bash
sf project deploy preview --target-org {alias} --json
If this fails with an error mentioning source tracking not supported or not enabled, offer to enable it:
bash
sf org enable tracking --target-org {alias}
Confirm with the user before running the enable command.
Closing Message
Once all steps are complete, tell the user:
text
Your project is ready! Here's what was set up:
✅ Project generated: {name}/
✅ Session relocated into {name}/ (via /cd)
✅ Default org: {alias}
✅ Source tracking: enabled (or status)
You're already working inside the new project — this same session moved
here with /cd, so just keep going. Run /salesforce-development:setup
anytime to re-check your dev environment.
If the user took the older-version fallback (relaunched with
instead of
), they're in a fresh session in the project and the SessionStart banner already walked them through the environment — point them to
/salesforce-development:setup
to re-check tools.
Rules
- Run the steps in order; confirm before any environment-changing action (login, set-default, enable tracking).
- The plugin's MCP servers come from the installed plugin, not the project — do NOT create or copy a into the new project (the plugin's config uses , which does not resolve in a project-level file).
- Prefer to relocate the session in place (Claude Code v2.1.169+) — a skill can't relocate the session on the user's behalf, so instruct the user to run it. Only fall back to (relaunch) when reports on an older build.
- The message that hands the user is your last turn until they speak again ( fires no hook), so it MUST end with a resume affordance — e.g. 'once you're in, just say "what's next".' Never promise the session will connect an org or continue on its own after ; it stays silent until the user re-engages.
- After , do NOT run or to "show" the banner — as a tool prints raw JSON, and the plugin surfaces the banner itself (once per session; the position rail on orientation questions). Just confirm the move in one line and continue. Health is available on demand via
/salesforce-development:setup
.
- For sandbox login,
--instance-url https://test.salesforce.com
is REQUIRED (the CLI default points at production).
- NEVER store or display access tokens.
- For an EXISTING project that just needs tooling validated, use
platform-environment-validate
(or /salesforce-development:setup
); for org auth on an existing project, use /salesforce-development:login
.