diff --git a/.gitignore b/.gitignore index e1736e9..5361415 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,9 @@ __pycache__/ *.pyc *.egg-info/ .pytest_cache/ + +# state-hub: track .claude/rules +# Claude Code local state (track shared rules; ignore machine-specific files) +.claude/* +!.claude/rules/ +!.claude/rules/*.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..8a22b15 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,189 @@ +# rein-openweights — Agent Instructions + +## Repo Identity + +**Purpose:** Agentic tool-use harness driving open-weight models via OpenRouter + +**Domain:** infotech +**Repo slug:** rein-openweights +**Topic ID:** `cee7bedf-2b48-46ef-8601-006474f2ad7a` +**Workplan prefix:** `REIN-OW-` + +--- + +## State Hub Integration + +The Custodian State Hub tracks work across all domains. Interact via HTTP REST — +there is no MCP server for Codex agents. + +| Context | URL | +|---------|-----| +| Local workstation | `http://127.0.0.1:8000` | +| Remote via tunnel | `http://127.0.0.1:18000` | +| Optional local edge relay | http://127.0.0.1:18080 | + +When an operator has enabled the edge relay, set API_BASE to the relay URL. +Queueable writes return an explicit queued receipt if the central hub is +unreachable. Treat that as pending local evidence, then ask the operator to run +statehub outbox status/replay after connectivity returns. + +### Orient at session start + +```bash +# Offline brief — works without hub connection +cat .custodian-brief.md + +# Active workplans for this domain +curl -s "http://127.0.0.1:8000/workplans/?topic_id=cee7bedf-2b48-46ef-8601-006474f2ad7a&status=active" \ + | python3 -m json.tool + +# Check inbox +curl -s "http://127.0.0.1:8000/messages/?to_agent=rein-openweights&unread_only=true" \ + | python3 -m json.tool +``` + +Mark a message read: +```bash +curl -s -X PATCH "http://127.0.0.1:8000/messages//read" \ + -H "Content-Type: application/json" -d '{}' +``` + +### Log progress (required at session close) + +```bash +curl -s -X POST http://127.0.0.1:8000/progress/ \ + -H "Content-Type: application/json" \ + -d '{ + "summary": "what was done", + "event_type": "note", + "author": "codex", + "workplan_id": "", + "task_id": "" + }' +``` + +Omit `workplan_id` / `task_id` when not applicable. + +### Update task status + +```bash +curl -s -X PATCH "http://127.0.0.1:8000/tasks/" \ + -H "Content-Type: application/json" \ + -d '{"status": "progress"}' +# values: wait | todo | progress | done | cancel +``` + +### Flag a task for human review + +```bash +curl -s -X PATCH "http://127.0.0.1:8000/tasks/" \ + -H "Content-Type: application/json" \ + -d '{"needs_human": true, "intervention_note": "reason"}' +``` + +--- + +## Session Protocol + +**Start:** +1. `cat .custodian-brief.md` — domain goal and open workplans (offline-safe) +2. Check inbox: `GET /messages/?to_agent=rein-openweights&unread_only=true`; mark read +3. Scan workplans: `ls workplans/` — note `status: ready`, `active`, or `blocked` files and open tasks +4. Check human-needed tasks: `GET /tasks/?needs_human=true` + +**During work:** +- Update task statuses in workplan files as tasks progress +- Record significant decisions via `POST /decisions/` + +**Close:** +1. Update workplan file task statuses to reflect progress +2. If finishing a workplan: hand off **residuals** as live work records first + (intake with `origin: residual` + `origin_ref: `, or a next workplan / + decision / engagement). Do not park leftovers only in prose or `SCOPE.md`. + Canon: `the-custodian/canon/standards/work-record-types_v0.1.md` § Residuals. +3. Log: `POST /progress/` with a summary of what changed (name handoff ids) +4. After workplan file changes, run: + ```bash + statehub fix-consistency + ``` + Coding agents should run this directly; ask the operator only if the CLI or + State Hub API is unavailable. This syncs task status from files into the hub DB. + +--- + +{CREDENTIAL_ROUTING} + + + + +--- + +## Workplan Convention (ADR-001) + +Work items originate as files in this repo — not in the hub. The hub is a +read/cache/index layer that rebuilds from files. + +**File location:** `workplans/REIN-OW-NNNN-.md` + +**Archived location:** finished workplans may move to +`workplans/archived/YYMMDD-REIN-OW-NNNN-.md`. The `YYMMDD` prefix is +the completion/archive date; the frontmatter `id` does not change. + +**Ad Hoc Tasks:** small opportunistic fixes discovered during a session use +`workplans/ADHOC-YYYY-MM-DD.md` with task ids `ADHOC-YYYY-MM-DD-T01`, etc. Use +this only for low-risk work completed directly; create a normal workplan for +anything needing analysis, design, approval, dependencies, or multiple phases. + +**Frontmatter:** + +```yaml +--- +id: REIN-OW-NNNN +type: workplan +title: "..." +domain: infotech +repo: rein-openweights +status: proposed | ready | active | blocked | backlog | finished | archived +owner: codex +topic_slug: ... +created: "YYYY-MM-DD" +updated: "YYYY-MM-DD" +state_hub_workstream_id: "" # fix-consistency — do not edit (legacy field name; workplan UUID) +--- +``` + +Use `proposed` for a new draft, `ready` after review against current repo +state, and `finished` after implementation. `stalled` and `needs_review` are +derived health labels, not frontmatter statuses. + +**Terminology:** workplan is the fleet term; `workstream` appears only in legacy +API/MCP/frontmatter bridges until `STATE-WP-0069` retires them — see +`the-custodian/canon/standards/workplan-terminology-fleet_v0.1.md`. + +**Task block format** (one per `##` section): + +``` +## Task Title + +` ` `task +id: REIN-OW-NNNN-T01 +status: wait | todo | progress | done | cancel +priority: high | medium | low +state_hub_task_id: "" # written by fix-consistency — do not edit +` ` ` + +Task description text. +``` + +Status progression: `todo` → `progress` → `done`; use `wait` for waiting/blocked work and `cancel` for stopped work. + +**Residuals when finishing:** actionable leftovers become live work records +before `status: finished` — usually an intake (`origin: residual`, +`origin_ref: REIN-OW-NNNN`) or a spawned workplan. Residual is a *role*, +not a kind. Fleet list lives on State Hub, not in `SCOPE.md`. + +To create a new workplan: +1. Write the file following the format above +2. Run `statehub fix-consistency` locally; ask the operator only if the CLI or + State Hub API is unavailable. diff --git a/SCOPE.md b/SCOPE.md new file mode 100644 index 0000000..6315a7f --- /dev/null +++ b/SCOPE.md @@ -0,0 +1,32 @@ +# SCOPE + +> This file was generated by `statehub register`. Refine it as the repository +> boundaries become clearer. + +## One-liner + +Agentic tool-use harness driving open-weight models via OpenRouter + +## Core Idea + +rein-openweights exists to provide the capability described in INTENT.md. + +## In Scope + +- Maintain the repository's primary implementation. +- Keep docs, tests, and operational metadata current. + +## Out of Scope + +- Own unrelated adjacent systems. +- Make irreversible operational decisions without human approval. + +## Current State + +- Status: active; implementation and stability should be verified by the repo agent. + +## Getting Oriented + +- Start with: INTENT.md +- Agent instructions: AGENTS.md +- Workplans: workplans/ diff --git a/WORK-RECORDS.md b/WORK-RECORDS.md new file mode 100644 index 0000000..4e7e674 --- /dev/null +++ b/WORK-RECORDS.md @@ -0,0 +1,20 @@ +# Work Records — rein-openweights + +> Generated by `statehub fix-consistency` (CUST-WP-0061-T04, work-record +> stage 3). Do not edit by hand — edit the source file/block listed for +> each record and re-run fix-consistency to refresh this index. Archived +> workplans are omitted; closed decisions/intakes/engagements stay listed +> so recently-resolved work is still visible. [auto] + +| Kind | ID | Status | Lane | Source | +| --- | --- | --- | --- | --- | +| workplan | REIN-OW-0001 | ready | — | workplans/REIN-OW-0001-statehub-bootstrap.md | +| workplan | REIN-OW-WP-0001 | active | — | workplans/REIN-OW-WP-0001-bootstrap.md | +| task | REIN-OW-0001-T01 | todo | — | workplans/REIN-OW-0001-statehub-bootstrap.md | +| task | REIN-OW-0001-T02 | todo | — | workplans/REIN-OW-0001-statehub-bootstrap.md | +| task | REIN-OW-0001-T03 | todo | — | workplans/REIN-OW-0001-statehub-bootstrap.md | +| task | REIN-OW-WP-0001-T01 | done | — | workplans/REIN-OW-WP-0001-bootstrap.md | +| task | REIN-OW-WP-0001-T02 | done | — | workplans/REIN-OW-WP-0001-bootstrap.md | +| task | REIN-OW-WP-0001-T03 | done | — | workplans/REIN-OW-WP-0001-bootstrap.md | +| task | REIN-OW-WP-0001-T04 | done | — | workplans/REIN-OW-WP-0001-bootstrap.md | +| task | REIN-OW-WP-0001-T05 | todo | — | workplans/REIN-OW-WP-0001-bootstrap.md | diff --git a/workplans/REIN-OW-0001-statehub-bootstrap.md b/workplans/REIN-OW-0001-statehub-bootstrap.md new file mode 100644 index 0000000..d1038bf --- /dev/null +++ b/workplans/REIN-OW-0001-statehub-bootstrap.md @@ -0,0 +1,59 @@ +--- +id: REIN-OW-0001 +type: workplan +title: "Bootstrap State Hub integration" +domain: infotech +repo: rein-openweights +status: ready +owner: codex +topic_slug: custodian +created: "2026-07-26" +updated: "2026-07-26" +state_hub_workstream_id: "e1af194f-d405-4aee-ab82-42ddc5940bcf" +--- + +# Bootstrap State Hub integration + +Agentic tool-use harness driving open-weight models via OpenRouter + +## Review Generated Integration Files + +```task +id: REIN-OW-0001-T01 +status: todo +priority: high +state_hub_task_id: "1254c1aa-a8c8-4e1e-9289-20f9de1b465e" +``` + +Review `INTENT.md`, `SCOPE.md`, `AGENTS.md`, and `.custodian-brief.md`. +Replace generated placeholders with repo-specific facts where needed. + +## Verify Local Developer Workflow + +```task +id: REIN-OW-0001-T02 +status: todo +priority: high +state_hub_task_id: "b3e39838-9273-4d3c-9eac-b9fdf3c35fc2" +``` + +Identify the repo's install, test, lint, build, and run commands. Add or refine +those commands in the agent instructions so future coding sessions can verify +changes confidently. + +## Seed First Real Workplan + +```task +id: REIN-OW-0001-T03 +status: todo +priority: medium +state_hub_task_id: "d7dc4378-09b1-459d-9fa5-f49980e294f4" +``` + +Create the first implementation workplan for the repository's most important +next change. After workplan file updates, run the sync locally from this repo +checkout: + +```bash +statehub fix-consistency +``` diff --git a/workplans/REIN-OW-WP-0001-bootstrap.md b/workplans/REIN-OW-WP-0001-bootstrap.md index adb0bdf..1a2b957 100644 --- a/workplans/REIN-OW-WP-0001-bootstrap.md +++ b/workplans/REIN-OW-WP-0001-bootstrap.md @@ -2,6 +2,7 @@ id: REIN-OW-WP-0001 title: "Bootstrap: minimal open-weight agentic loop" status: active +state_hub_workstream_id: "f73c1db1-0364-431f-9b3b-34e84ff2d86b" --- First working milestone for rein-openweights: prove an agentic tool-use @@ -38,6 +39,7 @@ default (`meta-llama/llama-3.1-70b-instruct`), not hardcoded. id: REIN-OW-WP-0001-T01 status: done priority: high +state_hub_task_id: "e13d28f0-b203-4af4-8f32-0a60fbe9eee0" ``` ## Task: Minimal agentic loop @@ -57,6 +59,7 @@ mocked at the `httpx`/subprocess boundary. id: REIN-OW-WP-0001-T02 status: done priority: high +state_hub_task_id: "4fd66d93-9b83-4418-849b-3ed517e08203" ``` ## Task: Success criterion + reporting @@ -73,6 +76,7 @@ this rein family. id: REIN-OW-WP-0001-T03 status: done priority: medium +state_hub_task_id: "3d23058d-4368-4319-8929-6df294cf1ed5" ``` ## Task: Credential brokering @@ -88,17 +92,21 @@ broker this. id: REIN-OW-WP-0001-T04 status: done priority: medium +state_hub_task_id: "d7d35b1b-8381-4b18-958d-101216439458" ``` ## Task: Forgejo repo creation -This repo is local-only. Create `coulomb/rein-openweights.git` on -Forgejo and wire the remote once T02 has something worth pushing — -coordinate with the operator (repo creation is not something this -session can do unattended). +Operator created `coulomb/rein-openweights.git` on Forgejo (stub with +LICENSE + README). Local history merged in with +`--allow-unrelated-histories` (kept the local README, took the stub's +MIT LICENSE — matches the sibling rein repos), pushed to `origin/main`, +registered with State Hub (`domain: infotech`, `wp-prefix: REIN-OW`). +Repo is no longer local-only. ```task id: REIN-OW-WP-0001-T05 -status: todo +status: done priority: low +state_hub_task_id: "ae2f0032-2be8-42db-9c82-31ce1042a039" ```