Quick Start

Get SquireX running in 5 minutes. This guide covers installing the binary, running your first Agentforce scan, and running your first Apex test.

---

1. Install

# Install the CLI globally via npm
npm install -g squirex

Verify the install:

squirex --version

---

2. Check Your Environment

squirex doctor

Expected output:

🩺 SquireX Doctor
══════════════════════════════════════
  ✅ Node.js              v18.19.0 (>= 18 required)
  ✅ Go Interpreter       v2.0.0 at /usr/local/bin/squirex
  ✅ Project Type         SFDX project detected
  ✅ Configuration        .squirex.json v1.0

---

3. Run Your First Agentforce Scan

Point squirex scan at your Salesforce project's metadata directory:

squirex scan -d ./force-app

SquireX will discover all Agentforce metadata — .agent, .genAiFunction-meta.xml, .genAiPlugin-meta.xml, .genAiPlannerBundle-meta.xml, .genAiPromptTemplate-meta.xml, Apex classes (.cls), Apex triggers (.trigger), Flows, Named Credentials, LWC components, and Connected Apps.

Save results as SARIF:

squirex scan -d ./force-app --sarif results.sarif

No violations?

Run squirex diagnose -d ./force-app to see exactly what metadata was discovered and how many rules were evaluated.

---

4. Initialize for Apex Testing

cd my-salesforce-project
squirex init

This creates .squirex.json with auto-detected paths:

{
  "version": "1.0",
  "interpreter": "go",
  "sourceDirectory": "force-app/main/default/classes",
  "testPattern": "**/*Test.cls"
}

---

5. Run Apex Tests Locally

squirex run -d force-app/main/default/classes

Sample output:

═══════════════════════════════════════════════════════════════
  ✅ 12/14 PASSED (85.7%)
═══════════════════════════════════════════════════════════════
  Total: 14    Duration: 2340ms
  ✓ Passed: 12    ✗ Failed: 2    ⚠ Errors: 0

  ✓ AccountTest.testInsert                    45ms [3 asserts]
  ✓ AccountTest.testBulkInsert               180ms [12 asserts]
  ✗ AccountTest.testUpdate                   120ms [2 asserts]
    Expected: "Active"   Actual: "Inactive"

---

What's Next?

Goal	Guide
Scan only changed files on a PR	PR Integration →
See all security rules	Security Rules →
Upload SARIF to GitHub	SARIF Output →
Mock SObject data for tests	Mock Data →
Use with Claude / Gemini / Copilot	MCP Server →
Add to GitHub Actions	CI/CD Integration →