Skip to content

ARCHITECTURE.md

Latest commit

 

History

History
136 lines (87 loc) · 7.3 KB

ARCHITECTURE.md

File metadata and controls

136 lines (87 loc) · 7.3 KB
Raw

Architecture (10-minute tour)

This is the orientation map. It's deliberately short and points you at the deep docs in docs/architecture/ when you want more.

If you only read one section, read The Four Layers. Everything else in Shep follows from those rules.

The Big Picture

Shep is a TypeScript / Node.js SDLC platform that runs AI agents in parallel git worktrees. The codebase is a pnpm workspace with a single packages/core/ package (the platform) and a top-level src/ tree (the presentation surfaces — CLI, TUI, Web).

shep/
├── tsp/                          # TypeSpec — domain models live here
├── packages/core/src/
│   ├── domain/                   # ← inner-most; no external deps
│   ├── application/              # ← use cases + output ports
│   └── infrastructure/           # ← adapters: SQLite, agents, GitHub, fs
└── src/presentation/             # ← CLI, TUI, Web (Next.js)

Dependencies point inward only: presentation depends on application, application depends on domain, infrastructure depends on application's port interfaces. Nothing outside infrastructure imports from infrastructure.

The Four Layers

1. Domain — tsp/ and packages/core/src/domain/

Pure business logic and types. Authored in TypeSpec, generated into TypeScript at packages/core/src/domain/generated/output.ts. Hand-edited code in domain/ is rare and never depends on anything outside the layer.

If a concept is part of the language you'd use in a planning meeting (Feature, Contributor, Lane, RecognitionEvent), it lives here.

→ Deep dive: docs/architecture/clean-architecture.md § Domain → TypeSpec primer: docs/development/typespec-guide.md → Domain field listings: docs/api/domain-models.md

2. Application — packages/core/src/application/

Use cases (one class per file under application/use-cases/) and output port interfaces (application/ports/output/). Use cases orchestrate domain logic and call external systems through ports. They never import from infrastructure/.

If you find yourself writing if/else business logic in a CLI command or React component, that logic belongs in a use case here.

→ Deep dive: docs/architecture/clean-architecture.md § Application → Implementation patterns: docs/development/implementation-guide.md → Repository pattern + DI: docs/architecture/repository-pattern.md

3. Infrastructure — packages/core/src/infrastructure/

Adapters: SQLite repositories (infrastructure/persistence/sqlite/), agent executors (infrastructure/agents/), GitHub services, file-system utilities, Discord client, scheduling. Each adapter implements an output port from application/ports/output/.

This is the only layer allowed to import third-party SDKs (@octokit/rest, better-sqlite3, agent provider SDKs). DI wiring lives in infrastructure/di/.

→ Deep dive: docs/architecture/clean-architecture.md § Infrastructure → Repository pattern: docs/architecture/repository-pattern.md → Settings service walkthrough: docs/architecture/settings-service.md

4. Presentation — src/presentation/

The surfaces you actually interact with: a Commander-based CLI (cli/), an Ink-based TUI (tui/), and a Next.js dashboard (web/). Presentation files are thin — they handle UI, input, formatting, and routing. All business logic flows through use cases.

→ CLI architecture: docs/cli/architecture.md → TUI architecture: docs/tui/architecture.md → Web UI architecture: docs/ui/architecture.md

Cross-Cutting Concerns

Agents

Every LLM call goes through IAgentExecutorProvider. No component hardcodes Claude / Cursor / Gemini — the resolution flow is documented in AGENTS.md. Provider-specific code lives only in adapters under infrastructure/agents/.

→ docs/architecture/agent-system.md → docs/development/adding-agents.md

Supervision & approval gates

External side-effects (GitHub writes, Discord posts, recap publishes) flow through ISupervisorAgent.evaluate(...) before execution. The supervisor either auto-approves (configurable per side-effect kind) or pauses for a human.

→ docs/architecture/supervision.md

Persistence

SQLite via better-sqlite3. Migrations live in packages/core/src/infrastructure/persistence/sqlite/migrations/ and are run by umzug. Each migration owns one table and is idempotent (CREATE TABLE IF NOT EXISTS).

→ docs/architecture/repository-pattern.md

Settings

A typed key/value store backed by SQLite, exposed through ISettingsService. Per-user, per-repo, and per-feature scopes are layered.

→ docs/architecture/settings-service.md

Where Things Go

A quick lookup when you're not sure which layer something belongs in:

You want to… It lives in…
Add a new domain concept (entity, enum, value object) tsp/ → regenerate domain/generated/output.ts
Add a new business operation application/use-cases/<group>/<verb-noun>.use-case.ts
Talk to GitHub, Discord, the file system, SQLite, an LLM New port in application/ports/output/, adapter in infrastructure/
Add a CLI command src/presentation/cli/commands/<name>.command.ts (calls a use case)
Add a web component src/presentation/web/components/<group>/<Name>.tsx + colocated .stories.tsx
Schedule something on a cron Register on Shep's in-process scheduler (NOT GitHub Actions)
React to a webhook .github/workflows/<event>.yml invoking a CLI subcommand

Mandatory Rules (skim before your first PR)

These are enforced. Read CLAUDE.md for the canonical list.

  • TDD: failing test first, then implementation, then refactor
  • TypeSpec-first: domain concepts in tsp/, never in raw TS strings
  • Agent resolution: through IAgentExecutorProvider, never hardcoded
  • Storybook stories: every web component ships with .stories.tsx
  • No infrastructure imports outside infrastructure: define a port instead
  • No singletons outside DI bootstrap: inject by string token
  • File length: ~300 lines per file before refactor
  • Conventional commits: type + scope + lowercase imperative subject

Where to Go Next