API Reference
Technical reference documentation for Shep AI CLI interfaces and models.
Contents
Overview
This directory contains technical specifications for:
- Domain Models – Business entities, value objects, and enums (TypeSpec-generated)
- Repository Interfaces – Ports for data persistence (IFeatureRepository, ISettingsRepository, IRepositoryRepository)
- Agent Interfaces – Agent execution, orchestration, and lifecycle contracts
Audience
This documentation is for:
- Contributors implementing new repositories
- Developers extending the agent system
- Anyone working with the domain layer
Usage Notes
- All types are generated from TypeSpec definitions in
tsp/
- Generated output lives in
packages/core/src/domain/generated/output.ts
- Repository interfaces are in
packages/core/src/application/ports/output/repositories/
- Agent interfaces are in
packages/core/src/application/ports/output/agents/
Quick Links
Domain
Repositories
Agents
Maintaining This Directory
Update when:
- New interfaces are added
- Existing interfaces change
- New models are introduced
Format:
- Use TypeScript code blocks
- Include JSDoc comments
- Reference actual file paths