Skip to content

Commit d069058

Browse files
committed
update README
1 parent 7f078d3 commit d069058

1 file changed

Lines changed: 40 additions & 14 deletions

File tree

README.md

Lines changed: 40 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Most agent stacks today bury prompts, tool wiring, and permissions in applicatio
2222
- Enforce **policies** (budgets, approvals, tool rules) at execution time
2323
- Stay **local-first** while the architecture leaves room for a future remote control plane
2424

25-
The full product vision, YAML spec v0, and architecture are documented in [**`docs/design_doc.md`**](docs/design_doc.md).
25+
The full product vision, YAML spec v0, and architecture are documented in [**`docs/DESIGN_DOC.md`**](docs/DESIGN_DOC.md).
2626

2727
---
2828

@@ -49,7 +49,7 @@ The full product vision, YAML spec v0, and architecture are documented in [**`do
4949
- **State** — single SQLite file (default `.agentic/state.db` under the project root; override with `--state`)
5050
- **Tests** — unit/integration coverage, golden CLI output tests, end-to-end `init → … → logs` in `test/integration`
5151

52-
See **section 18 (MVP)** and **section 19 (End Goal)** in [`docs/design_doc.md`](docs/design_doc.md) for the full included/excluded list.
52+
See **section 18 (MVP)** and **section 19 (End Goal)** in [`docs/DESIGN_DOC.md`](docs/DESIGN_DOC.md) for the full included/excluded list.
5353

5454
---
5555

@@ -74,14 +74,40 @@ Or: `make install` / `go install ./cmd/agentctl` (honours `GOBIN` / `GOPATH/bin`
7474
From the repo root (or anywhere):
7575

7676
```bash
77-
./bin/agentctl init my-agent-system
78-
./bin/agentctl validate --project my-agent-system
79-
./bin/agentctl plan --project my-agent-system
80-
./bin/agentctl apply --project my-agent-system --auto-approve
81-
./bin/agentctl run workflow/hello --project my-agent-system
82-
./bin/agentctl logs --project my-agent-system --workflow hello
77+
agentctl init my-agent-system
78+
agentctl validate --project my-agent-system
79+
agentctl plan --project my-agent-system
80+
agentctl apply --project my-agent-system --auto-approve
81+
agentctl run workflow/hello --project my-agent-system
82+
agentctl logs --project my-agent-system --workflow hello
8383
```
8484

85+
### Example `project.yaml`
86+
87+
The project root is a **`Project`** resource: `apiVersion`, `kind`, `metadata.name`, and **`spec.imports`** listing other YAML files (policies, tools, workflows). After **`agentctl init my-agent-system`**, `my-agent-system/project.yaml` looks like this:
88+
89+
```yaml
90+
apiVersion: agentic.dev/v0
91+
kind: Project
92+
metadata:
93+
name: my-agent-system
94+
spec:
95+
imports:
96+
- ./policies/default.yaml
97+
- ./tools/helper.yaml
98+
- ./workflows/hello.yaml
99+
defaults:
100+
policy: default
101+
model: openai/gpt-4o-mini
102+
providers:
103+
models:
104+
openai:
105+
type: openai
106+
apiKeyFrom: env:OPENAI_API_KEY
107+
```
108+
109+
Field-by-field rules, extra kinds, and env overlays are in [`docs/DESIGN_DOC.md`](docs/DESIGN_DOC.md).
110+
85111
Notes:
86112

87113
- **`init`** creates `my-agent-system/` with `apiVersion: agentic.dev/v0` resources and a **`hello`** workflow (native `echo` tool only — **no network**).
@@ -99,7 +125,7 @@ Notes:
99125
| `-o` / `--output` | `table`, `json`, or `yaml` |
100126
| `--no-color` | ASCII-friendly validate output |
101127

102-
Exit codes are summarized in **section 11.2** of [`docs/design_doc.md`](docs/design_doc.md) (`0` success, `2` validation, `4` execution, `5` policy denial, …).
128+
Exit codes are summarized in **section 11.2** of [`docs/DESIGN_DOC.md`](docs/DESIGN_DOC.md) (`0` success, `2` validation, `4` execution, `5` policy denial, …).
103129

104130
---
105131

@@ -117,7 +143,7 @@ Exit codes are summarized in **section 11.2** of [`docs/design_doc.md`](docs/des
117143
| `internal/policy` | Policy evaluation |
118144
| `internal/state/sqlite` | SQLite deployment + runtime/trace tables |
119145
| `test/integration` | End-to-end CLI flow tests |
120-
| `docs/design_doc.md` | Spec, CLI UX, architecture, roadmap |
146+
| `docs/DESIGN_DOC.md` | Spec, CLI UX, architecture, roadmap |
121147

122148
---
123149

@@ -157,7 +183,7 @@ GO_UPDATE_GOLDEN=1 go test ./internal/cli/... -run TestGolden_
157183
### Near term (MVP hardening)
158184

159185
- More **`diff` / drift** UX where the design doc calls for it
160-
- **`inspect`** and richer **`logs`** filters (see sections **10.2** and **17.3** in `docs/design_doc.md`)
186+
- **`inspect`** and richer **`logs`** filters (see sections **10.2** and **17.3** in `docs/DESIGN_DOC.md`)
161187
- **`agentctl test`**-style workflow fixtures (**stretch** per design doc)
162188

163189
### Post-MVP (from design doc section 19)
@@ -167,13 +193,13 @@ GO_UPDATE_GOLDEN=1 go test ./internal/cli/... -run TestGolden_
167193
- Stronger drift semantics and multi-runtime targets
168194
- Deeper approval workflows and multi-tenant controls
169195

170-
The **recommended implementation phases** are outlined in **section 20** of [`docs/design_doc.md`](docs/design_doc.md).
196+
The **recommended implementation phases** are outlined in **section 20** of [`docs/DESIGN_DOC.md`](docs/DESIGN_DOC.md).
171197

172198
---
173199

174200
## Documentation
175201

176-
- **[`docs/design_doc.md`](docs/design_doc.md)** — design document v0 (problem statement, spec, CLI, engine, state model, testing strategy, MVP vs end state, section 23 recommendation).
202+
- **[`docs/DESIGN_DOC.md`](docs/DESIGN_DOC.md)** — design document v0 (problem statement, spec, CLI, engine, state model, testing strategy, MVP vs end state, section 23 recommendation).
177203
- **License:** [MIT](LICENSE)
178204

179205
---
@@ -185,4 +211,4 @@ Issues and pull requests are welcome. Please run **`make fmt`**, **`make vet`**,
185211
---
186212

187213
> **Local declarative agent systems with validate, plan, apply, run, and logs.**
188-
> *(Closing recommendation in [`docs/design_doc.md`](docs/design_doc.md), section 23.)*
214+
> *(Closing recommendation in [`docs/DESIGN_DOC.md`](docs/DESIGN_DOC.md), section 23.)*

0 commit comments

Comments
 (0)