README.md

Intract Docs

Dokumentacja projektu Intract — warstwy kontraktów intencji dla kodu, endpointów, artefaktów DevOps i CI/CD.

Start

• Getting Started — instalacja, pierwsze uruchomienie, podstawowy workflow.
• Contract Format — format jednej linijki @intract.v1.
• Manifest: intract.yaml — kontrakty wielu plików, relacje require, graf intencji.
• Commands Reference — pełna lista komend CLI.
• Examples Guide — opis przykładów testowych i jak je uruchomić.
• SUMD Descriptor — metadata projektu, workflow, quality pipeline (pyqual.yaml), env i release.

Główne obszary

• Architecture — jak działa core, pluginy, engine, walidatory i raporty.
• Validation Model — statusy, reguły, fail_on, warn_on, policy.
• Watch & Engine — intract watch, drift, auto-suggest kontraktów.
• Integrations — pre-commit, GitHub Actions, Docker, OpenAPI, planfile, vallm, reDUP.
• Plugins — system pluginów i SDK.
• Roadmap — co dalej rozwijać.

Istotne miejsca w projekcie

• src/intract/ — kod źródłowy paczki.
• src/intract/engine/ — analiza codebase, sugestie kontraktów, drift.
• src/intract/plugins/ — plugin registry i wbudowane pluginy.
• src/intract/integrations/ — integracje, m.in. planfile-compatible export.
• src/intract/reporters/ — raporty, m.in. SARIF.
• examples/integration_tests/ — 3 gotowe przykłady testowe.
• templates/ — gotowe konfiguracje do nowych projektów.
• sdks/ — SDK/template’y dla różnych języków.
• schemas/intract.schema.json — JSON Schema manifestu.