Template
refactor: restore Makefile, document two usage modes
The framework supports both technical operations (SSH/screen/CLI/harness) and knowledge work (Hermes/OWUI/Conduit via MCP/API). The Makefile is restored as a convenience layer over the scripts — use make or call scripts directly, whichever fits the interface you're working through. README rewritten with a Mode 1 / Mode 2 comparison table. AGENTS.md key commands now show both make and direct script invocation. ADOPTING.md updated to use make shorthand. The scripts remain the real entry points; make is shorthand. Mode 2 agents invoke the same scripts via container exec or MCP tool calls. 💘 Generated with Crush Assisted-by: Crush via Crush <crush@charm.land>
This commit is contained in:
@@ -50,6 +50,7 @@ Replace this bracketed text.>
|
||||
│ ├── up.sh / down.sh ← docker compose lifecycle wrappers
|
||||
│ ├── garden.sh ← doc-sprawl / Discourse-migration report
|
||||
│ └── lib/common.sh ← shared bash library (colors, log_*, docker_run, check)
|
||||
├── Makefile ← convenience dispatch (setup/validate/fast/lint/test/garden/up/down/status)
|
||||
├── docker-compose.yml.example ← lifecycle template (copy to docker-compose.yml)
|
||||
├── .env.example ← copy to .env, fill in secrets
|
||||
└── .crush/memory/ ← operational memory read each session (if using Crush)
|
||||
@@ -145,16 +146,21 @@ docker run --rm --env-file ~/projects/KNEL-AIMiddleware/discourse-cli/.env \
|
||||
|
||||
## Key Commands
|
||||
|
||||
At a terminal (Mode 1), use `make` or call scripts directly:
|
||||
|
||||
```bash
|
||||
bash scripts/setup-hooks.sh # install git hooks (run once after clone)
|
||||
bash scripts/check-rules.sh --fast # fast rule audit (pre-commit equivalent)
|
||||
bash scripts/check-rules.sh # full audit (includes test suite)
|
||||
bash scripts/test.sh # run the test suite (override per project)
|
||||
bash scripts/garden.sh # doc-sprawl / Discourse-migration report
|
||||
bash scripts/up.sh # bring up the docker-compose stack
|
||||
bash scripts/down.sh # bring it down
|
||||
bash scripts/setup-hooks.sh # make setup — install git hooks
|
||||
bash scripts/check-rules.sh --fast # make fast — fast audit (pre-commit)
|
||||
bash scripts/check-rules.sh # make validate — full audit (incl tests)
|
||||
bash scripts/test.sh # make test — run test suite
|
||||
bash scripts/garden.sh # make garden — doc-sprawl report
|
||||
bash scripts/up.sh # make up — bring up stack
|
||||
bash scripts/down.sh # make down — bring down stack
|
||||
```
|
||||
|
||||
Via MCP/API (Mode 2): invoke the same scripts through container exec or MCP
|
||||
tool calls. The scripts are the real entry points; `make` is shorthand.
|
||||
|
||||
## Enforcement Model (belt and suspenders)
|
||||
|
||||
Policy is enforced by **git hooks** (portable, harness-agnostic): `scripts/pre-commit`
|
||||
|
||||
Reference in New Issue
Block a user