Skip to content

README.md

Latest commit

 

History

History
78 lines (57 loc) · 4.37 KB

README.md

File metadata and controls

78 lines (57 loc) · 4.37 KB

hello-squad

Beginner sample for the Squad SDK that demonstrates how to locate or create a team directory, cast a themed team of agents from The Usual Suspects universe, onboard them with persistent identities, and verify that agent names remain consistent across multiple casts.

Prerequisites

  • Node.js >= 20
  • npm
  • The SDK must be built first: cd ../../ && npm run build

Quick start

  1. Install dependencies: npm install
  2. Run the sample: npm start

What you'll learn

  • How to use resolveSquad() to find or create a .squad/ directory
  • How to cast a themed team from the Squad SDK universe system
  • How to onboard each agent with a charter and history files
  • How casting history provides deterministic, persistent agent identities

How it works

The sample walks through five steps. First, it locates or creates a .squad/ directory using resolveSquad(). Next, it uses the CastingEngine to create a team of four agents from The Usual Suspects universe, assigning them lead, developer, tester, and scribe roles based on their personalities. Then it onboards each agent by creating their individual agent directories and initializing their charter and history files. It displays the team roster in a formatted table showing each agent's name, role, and personality. Finally, it demonstrates the casting history system by casting the same team configuration twice and verifying that agent names match across both casts, proving the system is deterministic.

Expected output

🎬 hello-squad — Squad SDK beginner sample

────────────────────────────────────────────────────────────
  Step 1 — Resolve .squad/ directory
────────────────────────────────────────────────────────────
✅ Created demo .squad/ at: /tmp/hello-squad-demo/.squad
   resolveSquad() → /tmp/hello-squad-demo/.squad

────────────────────────────────────────────────────────────
  Step 2 — Cast a team from "The Usual Suspects"
────────────────────────────────────────────────────────────
  Universe: The Usual Suspects
  Team size: 4

  🎭 Keyser — Lead
     Personality: Quietly commanding; sees the whole board before anyone else.

────────────────────────────────────────────────────────────
  Step 3 — Onboard agents
────────────────────────────────────────────────────────────
  ✅ Keyser — Lead
  ✅ McManus — Developer
  ✅ Fenster — Tester
  ✅ Verbal — Scribe

────────────────────────────────────────────────────────────
  Step 4 — Team roster
────────────────────────────────────────────────────────────
  Names match across casts: ✅ Yes

────────────────────────────────────────────────────────────
  Step 5 — Casting history (persistent names)
────────────────────────────────────────────────────────────
  Casting records: 2
  Names match across casts: ✅ Yes

Key files

File Purpose
index.ts Main demo script showcasing all five steps
tests/hello-squad.test.ts Acceptance tests for casting and onboarding
TEST-SCRIPT.md Manual test walkthrough

Next steps