mirror of
https://github.com/himanshudongre/smriti.git
synced 2026-08-28 05:14:59 +00:00
Metrics: GET /api/v5/metrics/spaces/{id} returns coordination (checkpoints,
agents, cross-agent continuations, claim completion rate), state quality
(decisions/tasks per checkpoint, structured task adoption, milestones),
and branch lifecycle KPIs. All computed on demand from existing data —
no new schema, no events, no background jobs. CLI: smriti metrics <space>.
Doc sync: fix stale tool counts (CONTRIBUTING 15→17, cli/README 16→17),
update REPO_STRUCTURE (skill pack v1.5→v1.9, test files/counts), remove
shipped branch-lifecycle from ARCHITECTURE "not yet" section, add task
IDs + task-referenced claims + capabilities manifest + recheck pattern
to ARCHITECTURE structured tasks section, add coordination primitives
summary to README.
8.6 KiB
8.6 KiB
Smriti — Repository Structure
smriti/
│
├── README.md Product overview, core concepts, setup,
│ coding-agent quick start
├── ARCHITECTURE.md System model, isolation mechanism, API versioning,
│ multi-branch state, skill pack surface
├── DECISIONS.md Key architectural and product decisions
├── CONTRIBUTING.md Development setup and contribution guide
├── AGENTS.md Smriti skill pack for Codex (generated, committed)
├── REPO_STRUCTURE.md This file
│
├── Makefile Dev, test, build, and migration targets
├── docker-compose.yml Postgres + backend + frontend services
├── .env.example Environment variable template (dotenv-loaded)
│
├── backend/
│ ├── app/
│ │ ├── main.py FastAPI app factory, CORS, router registration,
│ │ │ startup provider validation
│ │ ├── config.py Pydantic settings (DATABASE_URL, DEBUG)
│ │ ├── config_loader.py Provider config loader (dotenv + providers.yaml
│ │ │ + env vars), reset_config() for dev reloads
│ │ ├── schemas/
│ │ │ └── __init__.py Pydantic request/response schemas
│ │ ├── db/
│ │ │ ├── database.py SQLAlchemy engine and session factory
│ │ │ └── models.py ORM models: RepoModel, CommitModel, ChatSession,
│ │ │ TurnEvent, WorkClaim
│ │ ├── domain/
│ │ │ └── enums.py SessionStatus, TargetTool, etc.
│ │ ├── api/
│ │ │ └── routes/
│ │ │ ├── chat.py V4: sessions, send_message, commit, head,
│ │ │ │ multi-branch state (/state), provider status
│ │ │ ├── checkpoint.py V5: draft, review, extract
│ │ │ ├── lineage.py V5: fork, branch tree, checkpoint compare,
│ │ │ │ reachable checkpoints
│ │ │ ├── claims.py V5: work claims (create, update, list)
│ │ │ ├── repos.py V2: Space CRUD, Checkpoint CRUD
│ │ │ ├── commits.py V2: direct commit creation
│ │ │ └── context_git.py V2: context extraction
│ │ ├── providers/
│ │ │ ├── registry.py Provider lookup, adapter instantiation,
│ │ │ │ MockAdapter fallback with warning log
│ │ │ ├── openai_adapter.py
│ │ │ ├── anthropic_adapter.py
│ │ │ └── openrouter_adapter.py
│ │ └── services/
│ │ ├── extractor.py Transcript → structured extraction
│ │ ├── embedding.py Embedding generation (pgvector)
│ │ ├── parser.py Transcript parsing utilities
│ │ ├── pack_generator.py Context pack rendering (V1 legacy)
│ │ └── llm/
│ │ ├── base.py LLM provider base class
│ │ ├── mock_provider.py Deterministic mock for testing
│ │ └── openai_provider.py OpenAI chat completions
│ ├── config/
│ │ ├── providers.example.yaml Template — copy to providers.yaml
│ │ └── providers.yaml Your keys (gitignored, not committed)
│ ├── alembic/ Database migrations (10 versions)
│ ├── tests/
│ │ ├── integration/ API integration tests (177 tests)
│ │ │ ├── test_api_v4_chat.py
│ │ │ ├── test_api_v5_lineage.py
│ │ │ ├── test_multi_branch_state.py
│ │ │ ├── test_claims.py
│ │ │ ├── test_checkpoint_extract.py
│ │ │ └── test_delete_endpoints.py
│ │ └── unit/ Unit tests (97 tests)
│ │ ├── test_config_loader.py
│ │ ├── test_extractor.py
│ │ ├── test_golden_outputs.py
│ │ ├── test_pack_generator.py
│ │ └── test_parser.py
│ └── pyproject.toml Python dependencies (includes python-dotenv)
│
├── frontend/
│ ├── src/
│ │ ├── pages/
│ │ │ ├── WorkspaceOverviewPage.tsx Resume-focused landing page
│ │ │ ├── ChatWorkspacePage.tsx Primary chat UI: sidebar, checkpoint
│ │ │ │ modal, history panel, context indicators
│ │ │ └── LineagePage.tsx Branch tree with author_agent tags,
│ │ │ checkpoint compare
│ │ ├── api/
│ │ │ └── client.ts API client functions (V4, V5, V2)
│ │ ├── types/
│ │ │ └── index.ts TypeScript type definitions (includes
│ │ │ CheckpointNode.author_agent)
│ │ └── main.tsx App entry point, router
│ └── package.json
│
├── cli/ Programmatic CLI + MCP server for agents
│ ├── README.md Command reference, MCP tools, skill pack install,
│ │ agent handoff workflow
│ ├── pyproject.toml Installable as `pip install -e ./cli`
│ │ → `smriti` + `smriti-mcp` on PATH
│ ├── smriti_cli/
│ │ ├── main.py argparse dispatcher: init, space, state,
│ │ │ checkpoint, fork, restore, compare,
│ │ │ branch, claim, skills
│ │ ├── mcp_server.py FastMCP server (17 tools, stdio transport)
│ │ ├── client.py SmritiClient HTTP wrapper (includes claims)
│ │ ├── formatters.py Continuation-oriented markdown renderers
│ │ │ (multi-branch, active claims, divergence)
│ │ └── skill_pack/ Agent skill pack source and renderer
│ │ ├── template.md Single source of truth (v1.9, 15 sections)
│ │ ├── renderer.py Pure-function render + versioned install
│ │ └── targets.py Target configs (claude-code, codex)
│ └── tests/ CLI + MCP tests (107 tests)
│ ├── test_branch_close.py
│ ├── test_init.py
│ ├── test_mcp_server.py
│ ├── test_skill_pack.py
│ ├── test_smoke.py
│ └── test_state_multi_branch.py
│
├── docs/
│ └── API.md V2, V4, and V5 endpoint reference
│
└── demos/
└── branching-reasoning-demo/ Complete demo scenario with runbook,
script, and expected outcomes
API version map
| Prefix | Module | Status | Notes |
|---|---|---|---|
/api/v1 |
sessions.py |
Legacy | Transcript paste ingestion |
/api/v2 |
repos.py, commits.py |
Current | Space CRUD, checkpoint read/list. CommitResponse includes assumptions and artifacts. |
/api/v4 |
chat.py |
Current | Chat sessions, send_message, commit, head, multi-branch state (/state with active branches, active claims, and divergence signal). Provider status. |
/api/v5 |
checkpoint.py, lineage.py, claims.py |
Current | Checkpoint draft/review/extract, fork, lineage tree, compare, work claims. |
Make targets
make setup Install all deps (backend + CLI + frontend) + run migrations
make dev Run backend dev server (port 8000)
make dev-frontend Run frontend dev server (port 5173)
make up Start all services via Docker Compose
make down Stop all services
make test Run all backend tests
make lint Lint backend code (ruff)
make format Format backend code (ruff)
make migrate Run pending Alembic migrations
make migration Create a new migration (usage: make migration msg="...")
Test counts (as of v1.9 skill pack + task IDs + metrics)
| Suite | Count | Location |
|---|---|---|
| Backend integration | 107 | backend/tests/integration/ |
| Backend unit | 117 | backend/tests/unit/ |
| CLI + MCP | 107 | cli/tests/ |
| Total | 331 |