generated from coulomb/repo-seed
Refresh agent instruction files
This commit is contained in:
65
AGENTS.md
65
AGENTS.md
@@ -2,13 +2,12 @@
|
||||
|
||||
## Repo Identity
|
||||
|
||||
**Purpose:** Generic artifact registry and storage gateway for generated outputs,
|
||||
evidence packages, reports, logs, snapshots, exports, and release artifacts.
|
||||
**Purpose:** Generic artifact registry and storage gateway for generated outputs, evidence packages, reports, logs, snapshots, exports, and release artifacts.
|
||||
|
||||
**Domain:** stack
|
||||
**Repo slug:** artifact-store
|
||||
**Topic ID:** `595afc64-bd28-47bf-aafb-ba230b28371b`
|
||||
**Workplan prefix:** `ARTIFACT-STORE-WP-`
|
||||
**Workplan prefix:** `ARTIFACT-WP-`
|
||||
|
||||
---
|
||||
|
||||
@@ -83,7 +82,7 @@ curl -s -X PATCH "http://127.0.0.1:8000/tasks/<task_id>" \
|
||||
**Start:**
|
||||
1. `cat .custodian-brief.md` — domain goal and open workstreams (offline-safe)
|
||||
2. Check inbox: `GET /messages/?to_agent=artifact-store&unread_only=true`; mark read
|
||||
3. Scan workplans: `ls workplans/` — note `status: active` files and open tasks
|
||||
3. Scan workplans: `ls workplans/` — note `status: ready`, `active`, or `blocked` files and open tasks
|
||||
4. Check blocked tasks: `GET /tasks/?needs_human=true`
|
||||
|
||||
**During work:**
|
||||
@@ -94,7 +93,7 @@ curl -s -X PATCH "http://127.0.0.1:8000/tasks/<task_id>" \
|
||||
1. Update workplan file task statuses to reflect progress
|
||||
2. Log: `POST /progress/` with a summary of what changed
|
||||
3. Note for the custodian operator: after workplan file changes, run from
|
||||
`~/the-custodian/state-hub`:
|
||||
`~/state-hub`:
|
||||
```bash
|
||||
make fix-consistency REPO=artifact-store
|
||||
```
|
||||
@@ -107,10 +106,10 @@ curl -s -X PATCH "http://127.0.0.1:8000/tasks/<task_id>" \
|
||||
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/ARTIFACT-STORE-WP-NNNN-<slug>.md`
|
||||
**File location:** `workplans/ARTIFACT-WP-NNNN-<slug>.md`
|
||||
|
||||
**Archived location:** completed workplans may move to
|
||||
`workplans/archived/YYMMDD-ARTIFACT-STORE-WP-NNNN-<slug>.md`. The `YYMMDD` prefix is
|
||||
**Archived location:** finished workplans may move to
|
||||
`workplans/archived/YYMMDD-ARTIFACT-WP-NNNN-<slug>.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
|
||||
@@ -122,12 +121,12 @@ anything needing analysis, design, approval, dependencies, or multiple phases.
|
||||
|
||||
```yaml
|
||||
---
|
||||
id: ARTIFACT-STORE-WP-NNNN
|
||||
id: ARTIFACT-WP-NNNN
|
||||
type: workplan
|
||||
title: "..."
|
||||
domain: stack
|
||||
repo: artifact-store
|
||||
status: active | done
|
||||
status: proposed | ready | active | blocked | backlog | finished | archived
|
||||
owner: codex
|
||||
topic_slug: ...
|
||||
created: "YYYY-MM-DD"
|
||||
@@ -136,13 +135,17 @@ state_hub_workstream_id: "<uuid>" # written by fix-consistency — do not edit
|
||||
---
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
**Task block format** (one per `##` section):
|
||||
|
||||
```
|
||||
## Task Title
|
||||
|
||||
` ` `task
|
||||
id: ARTIFACT-STORE-WP-NNNN-T01
|
||||
id: ARTIFACT-WP-NNNN-T01
|
||||
status: todo | in_progress | done | blocked
|
||||
priority: high | medium | low
|
||||
state_hub_task_id: "<uuid>" # written by fix-consistency — do not edit
|
||||
@@ -157,43 +160,3 @@ To create a new workplan:
|
||||
1. Write the file following the format above
|
||||
2. Notify the custodian operator to run `make fix-consistency REPO=artifact-store`
|
||||
(or send a message to the hub agent via `POST /messages/`)
|
||||
|
||||
---
|
||||
|
||||
## Current Repo Shape
|
||||
|
||||
v0.1 baseline (WP-0001) is live: library, CLI, minimal HTTP app, local FS
|
||||
backend, end-to-end ingest + finalize + replay. The pinned tech stack is in
|
||||
[ADR-0005](docs/adr/0005-v1-tech-stack.md).
|
||||
|
||||
Sources of truth:
|
||||
|
||||
- `INTENT.md` — purpose, product thesis, scope, service boundary.
|
||||
- `SCOPE.md` — lightweight orientation.
|
||||
- `docs/OPERATOR.md` — runbook: env vars, DB backends, CLI / HTTP reference, smoke test, replay procedure.
|
||||
- `docs/ARCHITECTURE-BLUEPRINT.md` — architecture v2: modules, data model, API shape.
|
||||
- `docs/PLATFORM-AMBITION.md` — longer-horizon thesis and the v1 schema commitments (A1–A9).
|
||||
- `docs/adr/` — architecture decision records ADR-0001 … ADR-0006 (content-addressed storage, event log as source of truth, canonical CBOR manifests, control/data plane contract, v1 tech stack, OCI reachability).
|
||||
- `docs/ROADMAP.md` — workplan sequencing across phases.
|
||||
- `docs/ASSEMBLY-EXPERIMENT.md` — opt-in research line on hand-tuned asm for hot kernels.
|
||||
- `workplans/ARTIFACT-STORE-WP-0001-service-baseline.md` — Foundation workplan (done).
|
||||
- `workplans/ARTIFACT-STORE-WP-{0002..0005}-*.md` — planned next workplans.
|
||||
|
||||
Local commands:
|
||||
|
||||
```sh
|
||||
make install # uv sync --all-extras
|
||||
make migrate-fresh # drop + re-create the dev SQLite DB
|
||||
make dev # uvicorn on 127.0.0.1:8000
|
||||
make test # pytest
|
||||
make lint type # ruff + mypy --strict
|
||||
artifactstore health
|
||||
```
|
||||
|
||||
## Repo Boundary
|
||||
|
||||
This repo owns artifact identity, package/file metadata, storage backend
|
||||
abstraction, retention policy, retrieval metadata, and audit trails.
|
||||
|
||||
It does not own StateHub work records, guide-board assessment semantics, formal
|
||||
records-management certification, or producer-specific business logic.
|
||||
|
||||
Reference in New Issue
Block a user