Skip to content

README.md

Latest commit

 

History

History
81 lines (58 loc) · 3.47 KB

README.md

File metadata and controls

81 lines (58 loc) · 3.47 KB
Raw

sf-intelligence documentation

Start here. This index covers user guides, architecture, configuration, and maintainer docs for the sf-intelligence Claude Code plugin.

New users

Doc What it covers
README Product overview, install, first run, privacy
Installation guide Prerequisites, npm install, troubleshooting
Guided onboarding /sfi-onboard: org selection, init, refresh, verification, first question
First refresh /sfi-init, /sfi-refresh, vault layout, git policy
Asking questions What to ask, resolver behavior, live plane, boundaries
Routing The host contract: advisory routing, refusal gates, clarifications, conversation context
Configuration Environment variables, live consent, audit log
Positioning Honest competitive framing — when to use something else
Compare pages (website) Scannable vs Salesforce MCP, Elements, dx0, Hubbl, Metazoa, Sweep
Agent-readiness audit Compose existing tools into an AI / Agentforce prep playbook

Technical depth

Doc Audience What it covers
Architecture Admins, architects Data flow, vault layout, MCP tools, determinism, upgrades
Repository structure Contributors Monorepo layout, packages, build commands
review-change PR gate (Action) DevOps, release engineers The sfi.review_change deploy gate as a GitHub Action — offline SARIF + PR-comment risk verdicts
PR-gate CI workflow (template) DevOps, release engineers Drop-in .github/workflows template wiring the review-change Action into a PR gate

Contributing and security

Doc What it covers
Contributing Dev setup, PR checklist, adding tools
Security policy Vulnerability reporting, trust model
Code of conduct Community standards

| CHANGELOG | Version history |

Agent skills (Claude Code)

Skills auto-activate in Claude Code sessions. Entry points:

  • .claude/skills/using-sf-intelligence/SKILL.md — tool cascade, resolve-first
  • .claude/skills/answering-org-questions/SKILL.md — intent routing

Slash commands: /sfi-onboard, /sfi-init, /sfi-refresh, /sfi-status (see .claude/commands/).

Run sfi.capabilities in a session for the live tool map and count.

Quick commands

pnpm install && pnpm build   # compile
pnpm test                    # unit + integration
pnpm tsc                     # project-reference typecheck (tsc -b)
pnpm guard                   # privacy scan

In your Salesforce DX repo (not this source repo):

sfi init                               # set up org-kb/ and pick the org alias
sfi refresh --target-org my-org-alias  # retrieve + build the vault
sfi status                             # freshness, source-tree hash, counts

These wrap as /sfi-onboard, /sfi-init, /sfi-refresh, /sfi-status slash commands when sf-intelligence is loaded as a Claude Code plugin.