You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,13 +63,13 @@ The `.opencode/commands/` directory defines specialized workflows that automate
63
63
***Phase 1 (Clarification):** The agent interviews you to resolve ambiguities before planning.
64
64
***Phase 2 (Agentic Analysis):** A specialized `planner` subagent scans the codebase and generates a detailed technical strategy.
65
65
***Phase 3 (Artifact Generation):** A persistent Markdown plan is saved in `plans/` (e.g., `plans/feature-x.md`).
66
-
***Phase 4 (Synchronization):** The plan is optionally linked to `TASKS.md` and can be synchronized with GitHub issues.
66
+
***Phase 4 (Synchronization):** The plan is optionally linked to `tasks.yaml` and can be synchronized with GitHub issues.
67
67
***`/onboard`**: Summarizes the project's architecture, standards, and current state to quickly orient a new developer (or the agent itself).
68
68
69
69
### 🏗️ Phase 2: Development & Execution
70
70
***`/issues`**: Your gateway to GitHub integration. It allows you to list, create, or update issues. Use `/issues work <number>` to transition an issue directly into a detailed research and planning mode.
71
71
***`/debug`**: Activates a specialized `debugger` subagent to perform forensic root-cause analysis (RCA). It analyzes error logs, traces code execution, and generates structured reports to pinpoint bugs.
72
-
***`/task`**: Manages the project roadmap in `TASKS.md`. Use it to `create` new tasks, `work`on existing ones (marks as In Progress), `report` on priorities, or `update` the roadmap.
72
+
***`/task`**: Manages the project roadmap in `tasks.yaml`. Use it to `add` new tasks, `start` work on existing ones, `archive` completed ones, or `list` priorities.
73
73
***`/scaffold`**: Initializes new project structures from scratch using modern, standard tooling (Python/uv, TS/npm, Rust/cargo, etc.) and sets up a compatible `makefile`.
@@ -29,7 +29,6 @@ If run inside an existing project, the script performs a **Surgical Update**:
29
29
-**Protection:** Explicitly preserves user configurations in **Protected Files**:
30
30
-`opencode.json`
31
31
-`.opencode/style-guide.md`
32
-
-**Intelligent GEMINI.md Merge:** Preserves your custom content in the `## Project Notes` section of `GEMINI.md` while updating the core mandates above it.
33
32
-**Confirm:** Presents a detailed summary of which files will be **created**, **updated**, or **protected** and waits for your approval.
34
33
-**Integrate:** Adds missing directory structures (`journal/`, `plans/`, etc.) if they don't exist.
35
34
-**Commit:** Automatically creates a descriptive `chore` commit marking the update.
@@ -52,7 +51,7 @@ After installation, you **must** link the framework's hooks to your git reposito
52
51
make install-hooks
53
52
```
54
53
55
-
This target creates a symbolic link from `.opencode/tools/git-precommit.py` to `.git/hooks/pre-commit`, enabling the automated journal and validation checks.
54
+
This target creates a symbolic link from `.opencode/tools/pre-commit.py` to `.git/hooks/pre-commit`, enabling the automated journal and validation checks.
56
55
57
56
## 🚢 Getting Started
58
57
@@ -68,7 +67,7 @@ gemini /onboard
68
67
69
68
### 2. Initialize the Roadmap
70
69
71
-
Check the current `TASKS.md` file and use the `/task` command to define your project's initial goals.
70
+
Check the current `tasks.yaml` file and use the `/task` command to define your project's initial goals.
Copy file name to clipboardExpand all lines: docs/develop.md
+11-8Lines changed: 11 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,21 +23,21 @@ Before proposing a change, you must gather context and identify risks. Use the s
23
23
24
24
### 2. Strategic Planning (The Bridge)
25
25
26
-
A feature or fix is not considered "active" until a persistent Markdown plan has been created in the `plans/` directory. Use the `/plan` command to synthesize the artifacts generated in Phase 1 into an actionable strategy, and synchronize it with `TASKS.md`.
26
+
A feature or fix is not considered "active" until a persistent Markdown plan has been created in the `plans/` directory. Use the `/plan` command to synthesize the artifacts generated in Phase 1 into an actionable strategy, and synchronize it with `tasks.yaml`.
27
27
28
28
### 3. Execution & Validation (Side-Effects)
29
29
30
30
Once a plan is approved, you move to execution. This is the **only** phase where files are modified.
31
31
32
32
#### For Code: The TCR Protocol
33
33
The `/task` command is the primary tool for repository execution:
34
-
-**`/task create`**: Adds a new task using the `task.py` script.
35
-
-**`/task work on ...`**: Implements a strict **TCR (Test-Commit-Revert)** protocol to ensure high-velocity, high-quality code. The orchestrator automatically uses `task.py` to mark the task as in-progress.
36
-
-**`/task report`**: Provides a summary of the roadmap and current priorities.
37
-
-**`/task update`**: Updates the status or plan-path of an existing task via the script.
34
+
-**`task add`**: Adds a new task using the `task` tool.
35
+
-**`task start --task-id X`**: Marks a task as in-progress.
36
+
-**`task list`**: Provides a summary of the roadmap and current priorities.
37
+
-**`task archive --task-id X`**: Marks a task as done.
38
38
39
39
**CLI-First Roadmap Discipline:**
40
-
The project roadmap (`TASKS.md`) must **never** be edited by hand. All task operations must be performed via the `.opencode/tools/task.py` script or the corresponding `/task` actions. This ensures structural integrity and a verifiable audit trail.
40
+
The project roadmap (`tasks.yaml`) must **never** be edited by hand. All task operations must be performed via the `task` tool or the corresponding `/task` actions. This ensures structural integrity and a verifiable audit trail.
41
41
42
42
#### **The TCR Loop (Work Action)**
43
43
@@ -65,7 +65,7 @@ When a bug is detected, the `/debug` command enforces a structured, scientific i
65
65
Before merging or committing any final change, the work **must** be documented in the daily journal. This is enforced by a **timestamp-based git hook**. Use the following tool to satisfy the requirement:
66
66
67
67
```bash
68
-
python3 .opencode/tools/journal.py 'one-line description of the work'
68
+
journal add "one-line description of the work"
69
69
```
70
70
71
71
Failure to do this will block your commit or turn execution.
@@ -81,7 +81,10 @@ Failure to do this will block your commit or turn execution.
81
81
82
82
## 🧠 Codifying Knowledge with Skills
83
83
84
-
The `/learn` command is the primary tool for expanding the project's long-term memory. When mastering a new technology, follow this workflow:
84
+
!!! warning "[PENDING IMPLEMENTATION]"
85
+
The `/learn` command for expanding the project's long-term memory is **not yet implemented**. This section describes the planned feature.
86
+
87
+
The planned `/learn` command will be the primary tool for expanding the project's long-term memory. When mastering a new technology, follow this workflow:
85
88
86
89
### 1. Grounded Learning Lifecycle
87
90
The agent follows a 4-phase process: **Audit** (environment check), **Strategic Mapping** (learning objectives), **Execution** (real-world experimentation), and **Codification**.
-**Architectural Planning:** Use `/plan` to generate persistent, actionable strategies.
52
52
-**Forensic Debugging:** Use `/debug` for root-cause analysis without immediate (and potentially incorrect) fixes.
53
53
-**Automated Documentation:** Use `/document` to keep the documentation synchronized with the evolving codebase.
54
-
-**Procedural Roadmap Management:** Use `/task` and the `.opencode/tools/task.py` utility to maintain a structured, machine-managed project roadmap in `TASKS.md`.
54
+
-**Procedural Roadmap Management:** Use `/task` and the `task` tool to maintain a structured, machine-managed project roadmap in `tasks.yaml`.
55
55
56
56
## 🔄 Project Lifecycle
57
57
58
58
1.**Onboarding:** Run `/onboard` to get a high-signal overview of the repository.
59
59
2.**Scaffolding:** Use `/scaffold` to initialize new project components with modern tooling.
60
60
3.**Iterative Development:** Follow the Discovery -> Plan -> Execute cycle for every feature.
61
-
4.**Quality Control:** Rely on the `make.py` hook to maintain codebase integrity.
61
+
4.**Quality Control:** Rely on the `pre-commit` hook to maintain codebase integrity.
62
62
5.**Releasing:** Use `/release` to automate versioning, changelog updates, and git tagging.
0 commit comments