@sf-ai-kit/cli
v0.1.4
Published
Make every Salesforce DX project AI-ready in minutes — scaffolds Cursor rules, Claude Code config, MCP setup, skills, and security guardrails.
Maintainers
Readme
@sf-ai-kit/cli
Command-line tool for SF AI Kit.
Makes every Salesforce DX project AI-ready in minutes — generates Cursor rules, Claude Code config, Salesforce DX MCP setup, skills, agents, and guardrails from the terminal.
Installation
Run without installing:
npx @sf-ai-kit/cli initOr install globally:
npm install -g @sf-ai-kit/cli
ai-kit-sf initQuick Start
Open your Salesforce DX project folder in a terminal and run:
# Step 1 — See what is missing
npx @sf-ai-kit/cli scan
# Step 2 — Apply the full setup
npx @sf-ai-kit/cli init
# Step 3 — Configure MCP for your org
npx @sf-ai-kit/cli bootstrap-mcpThat's it. Your project has Cursor rules, CLAUDE.md, MCP config, skills, agents, and guardrails.
Commands
| Command | Description |
|---------|-------------|
| scan | Show AI readiness score and list missing items |
| init | Full setup — scan, select preset, create all missing files |
| bootstrap-mcp | Generate .cursor/mcp.json and .mcp.json for your org |
| check-drift | Check whether AI setup files are still aligned with best practices |
| deploy-preview | Preview components that would be deployed and detect risks |
| agentforce-scan | Scan force-app/ for Agentforce metadata and get recommendations |
| doctor | Full configuration health check |
| add-cursor | Add Cursor rules only |
| add-claude | Add Claude Code config only |
| add-mcp | Add MCP docs and rule only |
| add-jags-skills | Add Cursor skill templates |
| add-afv-library | Add Salesforce AFV Library guide |
| add-claude-mem | Generate a claude-mem Salesforce DX mode file |
| pick-skill | List installed skills and copy an @mention reference |
Options
Most commands support these flags:
| Flag | Description |
|------|-------------|
| --path <path> | Path to the project root (defaults to current directory) |
| --preset <name> | Setup preset: core, lwc, agentforce, data-cloud, experience-cloud |
| --dry-run | Preview changes without writing any files |
| --yes | Skip confirmation prompts |
Example:
npx @sf-ai-kit/cli init --preset agentforce --yes --dry-runWhat Gets Created
Running init --preset core creates the following files if they do not already exist:
AGENTS.md AI tool usage guide
CLAUDE.md Claude Code rules and workflow orchestration
tasks/todo.md AI task tracker
tasks/lessons.md Lessons learned log
.cursor/rules/ 6 Cursor rule files (Apex, LWC, MCP, Deployment, Safety, Project)
.cursor/skills/ 6 skill templates (Apex, LWC, Flow, Security, Agentforce, Data Cloud)
.claude/commands/ 6 slash commands
.claude/agents/ 5 sub-agent definitions
docs/ 9 reference documentation filesExisting files are never overwritten. A backup is created before any file is modified.
Requirements
- Node.js 18 or later
- A Salesforce DX project with
sfdx-project.jsonat the root
Related
- VS Code Extension — real-time inline diagnostics, status bar, and all commands inside VS Code and Cursor
- @sf-ai-kit/core — the underlying engine if you want to build your own tooling
Author
License
MIT
