kings-guard/README.md

47 lines
1.4 KiB
Markdown

# kings-guard
Adaptive security contracts and posture-evaluation scaffold for NetKingdom's
immune-architecture work.
## Current slice
This repository now contains four aligned pieces:
- `INTENT.md` / `SCOPE.md` for the repo's stable boundary
- `specs/NetKingdomImmuneArchitecture.md` for the reference architecture
- `specs/ImmuneContracts.md` for the first canonical contract layer
- `src/kings_guard/` plus `tests/` for a minimal posture loop scaffold
The current implementation is intentionally narrow. It does **not** provide a
running security control plane yet. It provides:
- typed contracts for security genome, phenotype, observation, posture,
signal, effector request, and immune memory entry;
- a minimal posture evaluator that turns a normalized observation into a
posture assessment and bounded response hints;
- a fixture-driven pilot based on `qonto-assistant`, chosen because it already
exposes a security genome record, an audit stream, and a fast local loop.
## Repo layout
- `specs/NetKingdomImmuneArchitecture.md`
- `specs/ImmuneContracts.md`
- `docs/AdjacentSystemBoundary.md`
- `docs/pilots/QontoAssistantPosturePilot.md`
- `src/kings_guard/`
- `tests/`
- `workplans/`
## Dev commands
```bash
# preferred, if make + pip are available
make install-dev
make test
make lint
make run-demo
# direct shell fallback used in minimal environments
python3 -m pytest -q
PYTHONPATH=src python3 -m kings_guard.main --pilot qonto-assistant
```