Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,15 @@ activemq-data/
.cfg/
/.cfg.toml

# Local project notes and recording drafts
docs/project-notes/
*.mp4
*.mov
*.webm
*.mkv
*.avi
*.m4v

# Local secrets and overrides
*.local
.streamlit/secrets.toml
Expand Down
35 changes: 23 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,25 +103,39 @@ system, or schema migration tool.

## Install

From a checkout:
From PyPI:

- [`cfgit`](https://pypi.org/project/cfgit/)
- [`cfgit-impact`](https://pypi.org/project/cfgit-impact/) for optional impact narration

```bash
python -m venv .venv
. .venv/bin/activate
pip install -e '.[mongo,postgres,mcp,dev]'
pip install -e plugins/cfg_impact
pip install 'cfgit[mongo,postgres,mcp]'
```

Minimal install for Mongo only:

```bash
pip install -e '.[mongo]'
pip install 'cfgit[mongo]'
```

Minimal install for Postgres only:

```bash
pip install -e '.[postgres]'
pip install 'cfgit[postgres]'
```

Optional impact plugin:

```bash
pip install cfgit-impact
```

If you use `pipx`, install cfgit first and inject the optional plugin into the
same isolated environment:

```bash
pipx install 'cfgit[mongo,postgres,mcp]'
pipx inject cfgit cfgit-impact
```

## Quick start
Expand Down Expand Up @@ -453,7 +467,7 @@ explains in plain language what the change does, what it ripples into, and how t
roll it back:

```bash
pip install -e plugins/cfg_impact
pip install cfgit-impact
cfg impact agent_configs:agent_planner --llm --json
```

Expand Down Expand Up @@ -526,10 +540,7 @@ against a safe environment.
- [docs/AGENTS.md](docs/AGENTS.md): MCP, skill, and impact plugin usage
- [docs/SPEC_CORE.md](docs/SPEC_CORE.md): project framing and v1 scope
- [docs/SPEC.md](docs/SPEC.md): deeper engine reference
- [docs/README.md](docs/README.md): full documentation index, including archived project notes and historical specs
- [docs/project-notes/findings.md](docs/project-notes/findings.md): implementation findings from the origin build
- [docs/project-notes/handoff.md](docs/project-notes/handoff.md): archived handoff notes
- [docs/archive/spec-v0.1.md](docs/archive/spec-v0.1.md): original historical spec
- [docs/README.md](docs/README.md): full documentation index

## Development

Expand Down
4 changes: 2 additions & 2 deletions docs/ADAPTERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ details. Core owns hashing, history semantics, drift detection, and restore logi
Install:

```bash
pip install -e '.[mongo]'
pip install 'cfgit[mongo]'
```

Configuration:
Expand Down Expand Up @@ -45,7 +45,7 @@ Mongo notes:
Install:

```bash
pip install -e '.[postgres]'
pip install 'cfgit[postgres]'
```

Configuration:
Expand Down
4 changes: 2 additions & 2 deletions docs/AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ tokens through MCP unless that client/session is trusted for secrets.
Install the MCP extra:

```bash
pip install -e '.[mcp]'
pip install 'cfgit[mcp]'
```

Run:
Expand Down Expand Up @@ -120,7 +120,7 @@ as token/DB-principal based rather than author-string based.
Install:

```bash
pip install -e plugins/cfg_impact
pip install cfgit-impact
```

Deterministic impact:
Expand Down
8 changes: 0 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,3 @@ Technical references:

- [Core spec](SPEC_CORE.md): framing and v1 scope.
- [Engine spec](SPEC.md): detailed engine and adapter reference.

Project notes and historical artifacts:

- [Implementation findings](project-notes/findings.md): source-code and data-shape findings from the origin implementation.
- [Review findings](project-notes/review-findings.md): implementation audit defects and fix order.
- [Session handoff](project-notes/handoff.md): archived implementation handoff.
- [Session handoff JSON](project-notes/handoff.json): machine-readable handoff archive.
- [Original v0.1 spec](archive/spec-v0.1.md): early historical spec.
2 changes: 1 addition & 1 deletion docs/SPEC_CORE.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ writers = ["alice@*", "bob@*", "carol@*"]
admin_actions = ["init", "restore_system"]
```

> **First-task gate (archived in `docs/project-notes/handoff.md`):** before building, pin each collection's real id + live-rule against the actual data. `modelgarden_models` already has duplicate `model_id` values in local dev data, while `model_path` is unique and runtime-authoritative in the code paths checked. Use `model_path` unless production data proves otherwise. Getting this wrong makes the tool wrong on day one.
> **First-task gate for any real deployment:** before tracking a collection, pin the stable id field and live-record rule against actual data. If multiple rows or documents can share the apparent id, configure a different id field or an explicit `live_when` selector before importing history. Getting this wrong makes the tool wrong on day one.

---

Expand Down
563 changes: 0 additions & 563 deletions docs/archive/spec-v0.1.md

This file was deleted.

128 changes: 0 additions & 128 deletions docs/project-notes/findings.md

This file was deleted.

107 changes: 0 additions & 107 deletions docs/project-notes/handoff.json

This file was deleted.

Loading
Loading