generated from coulomb/repo-seed
Refresh agent instruction files
This commit is contained in:
61
AGENTS.md
61
AGENTS.md
@@ -2,46 +2,15 @@
|
||||
|
||||
## Repo Identity
|
||||
|
||||
**Purpose:** HelixForge turns natural-language intent into governed, reusable software capabilities through architecture-aware discovery, validation, implementation, feedback, and reuse.
|
||||
**Purpose:** Capability-first development ecosystem for evolving reusable software capabilities from natural-language intent through architecture-aware discovery, validation, implementation, feedback, and reuse.
|
||||
|
||||
**Domain:** helix_forge
|
||||
**Repo slug:** helix-forge
|
||||
**Topic ID:** `f39fa2a3-c491-414c-a91b-b4c5fcc6139c`
|
||||
**Workplan prefix:** `HF-WP-`
|
||||
**Workplan prefix:** `HELIX-WP-`
|
||||
|
||||
---
|
||||
|
||||
## Repo Orientation
|
||||
|
||||
This repository is currently documentation-first. Treat `INTENT.md` as the
|
||||
primary source of truth, with `wiki/HelixForgeVision.md` carrying the compact
|
||||
vision statement and `wiki/OrthogonalArchitectureSchema.md` preserving the
|
||||
current Orthogonal Architecture Standard schema reference.
|
||||
|
||||
Current responsibilities:
|
||||
- Define HelixForge as a capability-first development ecosystem.
|
||||
- Preserve the Orthogonal Architecture Dimensions and VSM-inspired vocabulary
|
||||
that future implementation artifacts must follow.
|
||||
- Track near-term work in `workplans/`, currently focused on using `ops-hub`
|
||||
as the first Inter-Hub extension pattern.
|
||||
|
||||
Current state:
|
||||
- No application/runtime source code exists yet.
|
||||
- No build, test, or package commands are defined yet.
|
||||
- The repo already uses `HF-WP-` workplan IDs; keep that prefix unless the
|
||||
existing workplan files are deliberately migrated.
|
||||
|
||||
Useful orientation commands:
|
||||
|
||||
```bash
|
||||
sed -n '1,220p' INTENT.md
|
||||
sed -n '1,160p' workplans/HF-WP-0001-establish-ops-hub-first-extension.md
|
||||
sed -n '1,120p' wiki/HelixForgeVision.md
|
||||
```
|
||||
|
||||
When adding executable artifacts later, update this file with the real stack,
|
||||
dependency, build, test, and validation commands.
|
||||
|
||||
## State Hub Integration
|
||||
|
||||
The Custodian State Hub tracks work across all domains. Interact via HTTP REST —
|
||||
@@ -55,8 +24,8 @@ there is no MCP server for Codex agents.
|
||||
### Orient at session start
|
||||
|
||||
```bash
|
||||
# Offline brief, if generated by StateHub consistency sync
|
||||
test -f .custodian-brief.md && cat .custodian-brief.md || sed -n '1,120p' SCOPE.md
|
||||
# Offline brief — works without hub connection
|
||||
cat .custodian-brief.md
|
||||
|
||||
# Active workstreams for this domain
|
||||
curl -s "http://127.0.0.1:8000/workstreams/?topic_id=f39fa2a3-c491-414c-a91b-b4c5fcc6139c&status=active" \
|
||||
@@ -111,9 +80,9 @@ curl -s -X PATCH "http://127.0.0.1:8000/tasks/<task_id>" \
|
||||
## Session Protocol
|
||||
|
||||
**Start:**
|
||||
1. Read `.custodian-brief.md` when present; otherwise read `SCOPE.md` and `INTENT.md`
|
||||
1. `cat .custodian-brief.md` — domain goal and open workstreams (offline-safe)
|
||||
2. Check inbox: `GET /messages/?to_agent=helix-forge&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:**
|
||||
@@ -124,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=helix-forge
|
||||
```
|
||||
@@ -137,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/HF-WP-NNNN-<slug>.md`
|
||||
**File location:** `workplans/HELIX-WP-NNNN-<slug>.md`
|
||||
|
||||
**Archived location:** completed workplans may move to
|
||||
`workplans/archived/YYMMDD-HF-WP-NNNN-<slug>.md`. The `YYMMDD` prefix is
|
||||
**Archived location:** finished workplans may move to
|
||||
`workplans/archived/YYMMDD-HELIX-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
|
||||
@@ -152,12 +121,12 @@ anything needing analysis, design, approval, dependencies, or multiple phases.
|
||||
|
||||
```yaml
|
||||
---
|
||||
id: HF-WP-NNNN
|
||||
id: HELIX-WP-NNNN
|
||||
type: workplan
|
||||
title: "..."
|
||||
domain: helix_forge
|
||||
repo: helix-forge
|
||||
status: active | done
|
||||
status: proposed | ready | active | blocked | backlog | finished | archived
|
||||
owner: codex
|
||||
topic_slug: ...
|
||||
created: "YYYY-MM-DD"
|
||||
@@ -166,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: HF-WP-NNNN-T01
|
||||
id: HELIX-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
|
||||
|
||||
Reference in New Issue
Block a user