Skip to content

Latest commit

 

History

History
37 lines (29 loc) · 1.65 KB

README.md

File metadata and controls

37 lines (29 loc) · 1.65 KB

Lynchpin documentation

Lynchpin keeps public documentation close to the layer that owns each contract. This page is the short map for readers; source docstrings, schemas, and generated catalogs provide the detailed API reference.

System model

  • Architecture explains owner-native inputs, typed source APIs, canonical materialization, DuckDB refreshes, evidence graphs, and product interfaces.
  • Data sources maps configured roots and active adapter families to their roles and coverage boundaries.
  • Analysis methodology defines the evidence, timeframe, denominator, calibration, and reporting rules for canonical analysis products.

Project and machine evidence

Operate and extend

  • Start with the README for the supported Nix-first environment, materialization commands, current-state packs, and MCP server.
  • Use python -m lynchpin.cli.materialize --help to inspect dependency-ordered materialization and promotion options.
  • Use python -m lynchpin.mcp for the eight-tool stdio MCP surface; tool schemas and examples are available through lynchpin_catalog.
  • Run pytest -q, ruff check ., and nix flake check for the public quality gates.

Active work belongs to the committed Beads graph. Browse the web board or use bd ready locally.