Skip to content

docs: add helper CLI product spec #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sven1103 merged 2 commits into from
Mar 19, 2026
+451 −0
Merged

docs: add helper CLI product spec #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5e33f9
docs: add helper CLI product spec
sven1103 Mar 18, 2026
f9f22b7
docs: add repo guidance and traceable anchors
sven1103 Mar 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# AGENTS.md

## Scope

This repository contains OpenCode agent configuration assets and supporting setup materials.

Primary repo contents:
- `opencode.openai.json` and `opencode.mixed.json` are the main OpenCode config presets
- `.opencode/schemas/` contains the vendored inter-agent handoff and result schemas used by this repo's workflow
- `scripts/opencode-config` is the current shell helper for installing and validating vendored schemas
- `docs/opencode-helper-cli.md` is the traceable product document for the planned helper CLI
- `README.md` explains the multi-agent configuration approach and how the repo is intended to be used

## Working Expectations

- Keep changes aligned with the repo's planning-first, schema-validated workflow
- Preserve the role of `.opencode/schemas/handoff.schema.json` and `.opencode/schemas/result.schema.json` as the local canonical artifact contracts for this repo
- Prefer additive, traceable documentation changes over informal notes scattered across files
- Treat helper CLI planning in `docs/opencode-helper-cli.md` as the source of truth for requirements, features, and later user stories
- Avoid changing unrelated session artifacts under `.opencode/sessions/`

## Quick Orientation

- If the task is about agent behavior or configuration presets, inspect `README.md`, `opencode.openai.json`, and `opencode.mixed.json`
- If the task is about local schema installation or validation, inspect `scripts/opencode-config`
- If the task is about future helper CLI behavior, update `docs/opencode-helper-cli.md` first so product decisions remain traceable
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ Repository configuration files:
- `opencode.mixed.json` — mixed model stack (routing/planning/review vs. code execution)
- `opencode.openai.json` — OpenAI-based variant (including docs routing examples in this README)

Product planning:

- `docs/opencode-helper-cli.md` — traceable PRD, requirements, features, and later user-story source for the helper CLI

---

## Design Philosophy
Expand Down
Loading