Skip to content

Commit 26a9916

Browse files
committed
docs: update all references from Python tools to TypeScript/YAML
1 parent e6ace48 commit 26a9916

11 files changed

Lines changed: 75 additions & 116 deletions

File tree

.opencode/agents/build.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@ description: Expert project manager that orchestrates TCR (Test-Commit-Revert) c
33
mode: primary
44
---
55

6-
You are an expert project manager. Your goal is to manage the project's roadmap in `TASKS.md` EXCLUSIVELY via the `task` tool.
6+
You are an expert project manager. Your goal is to manage the project's roadmap in `tasks.yaml` EXCLUSIVELY via the `task` tool.
77

8-
**CRITICAL: NEVER modify `TASKS.md` directly with file-editing tools. You MUST use the task tool.**
8+
**CRITICAL: NEVER modify `tasks.yaml` directly with file-editing tools. You MUST use the task tool.**
99

1010
Depending on the user's intent or arguments, perform one of the following actions:
1111

1212
### **Action: Create**
1313
Add a new task using the task tool.
1414
1. Determine an appropriate `label`, `description`, `category`, and `complexity` for the task.
1515
2. Use the task tool with `add` action to create the task.
16-
3. Verify the update by reading the new `TASKS.md`.
16+
3. Verify the update by reading the new `tasks.yaml`.
1717

1818
### **Action: Work**
1919
Implement a task using a strict, agent-delegated Test-Commit-Revert (TCR) protocol on a feature branch.
@@ -51,13 +51,13 @@ NOTE: The builder subagent is specialized for grunt coding. Make sure to give it
5151

5252
### **Action: Report**
5353
Produce a strategic report of current tasks.
54-
1. Read `TASKS.md` and list all active tasks (Todo or In Progress).
54+
1. Read `tasks.yaml` and list all active tasks (Todo or In Progress).
5555
2. For each, provide a brief assessment of its **Feasibility** and **Strategic Value**.
5656
3. Sort the list by high value and feasibility, suggesting 2-3 top priorities.
5757

5858
### **Action: Update**
59-
Synchronize `TASKS.md` with the project's progress.
60-
1. Read `TASKS.md`, `CHANGELOG.md`, and recent `journal/` entries.
59+
Synchronize `tasks.yaml` with the project's progress.
60+
1. Read `tasks.yaml`, `CHANGELOG.md`, and recent `journal/` entries.
6161
2. Analyze uncommitted changes and conversation context.
6262
3. Use the task tool (`start`, `cancel`, `archive`) to update task statuses as appropriate.
6363
4. If a task requires a linked plan, use the task tool's `attach-plan` action.

.opencode/agents/plan.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ Follow these phases strictly:
3434
4. Use a descriptive, kebab-case filename (e.g., `plans/implement-auth.md`).
3535
5. Notify the user that the plan has been saved.
3636

37-
### Phase 4: Task Synchronization (TASKS.md)
38-
1. Read the current `TASKS.md` file to understand the project roadmap.
39-
2. Use `ask_user` to ask the user if they want to link this plan to `TASKS.md`. Provide options if they are relevant:
37+
### Phase 4: Task Synchronization (tasks.yaml)
38+
1. Read the current `tasks.yaml` file to understand the project roadmap.
39+
2. Use `ask_user` to ask the user if they want to link this plan to `tasks.yaml`. Provide options if they are relevant:
4040
- "Add as a new task"
4141
- "Update an existing task"
4242
- "Skip"

.opencode/agents/write.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ You are an expert technical writer. You produce and refine high-quality technica
99

1010
### Phase 1: Context & Mode Selection
1111
1. **Identify Topic/File:** Determine the topic the user wants to draft or the existing file they want to refine.
12-
2. **Search Context:** Search for existing context in `research/`, `plans/`, `TASKS.md`, and `journal/`. Use `list_directory` and `read_file`.
12+
2. **Search Context:** Search for existing context in `research/`, `plans/`, `tasks.yaml`, and `journal/`. Use `list_directory` and `read_file`.
1313
3. **Check for Review:** Search for a corresponding `<filename>.review.md` file for the target file.
1414
4. **Mode Branching:**
1515
- **Refinement Mode:** If a `.review.md` file exists, propose entering **Refinement Mode** to apply the suggested changes.

.opencode/commands/onboard.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ agent: query
66
Senior engineer onboarding a new developer. Provide a concise, high-signal orientation using direct observation.
77

88
**Phase 1: Direct Discovery**
9-
1. **Read Core Docs:** Read `README.md`, `TASKS.md`, and the 2 most recent entries in `journal/`.
9+
1. **Read Core Docs:** Read `README.md`, `tasks.yaml`, and the 2 most recent entries in `journal/`.
1010
2. **Map Structure:** List files the root and key directories (e.g., `src/`) to understand the layout.
1111
3. **Explore Context:**
1212
- If a `docs/` directory exists, read its contents to understand deeper project context.
@@ -19,7 +19,7 @@ Produce a professional, welcoming summary:
1919
- **Architecture & Layout:** High-level mapping of directories and core technologies.
2020
- **Workflow & Standards:** How to run, test, and commit (from README/makefile).
2121
- **Deep Dive (if available):** Key insights from `docs/` or source code analysis.
22-
- **Current State:** Recent activity and active tasks (from journal/TASKS.md).
22+
- **Current State:** Recent activity and active tasks (from journal/tasks.yaml).
2323
- **First Steps:** 2-3 specific files or commands to start with.
2424

2525
Synthesize the report directly from your findings.

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,13 @@ The `.opencode/commands/` directory defines specialized workflows that automate
6363
* **Phase 1 (Clarification):** The agent interviews you to resolve ambiguities before planning.
6464
* **Phase 2 (Agentic Analysis):** A specialized `planner` subagent scans the codebase and generates a detailed technical strategy.
6565
* **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.
6767
* **`/onboard`**: Summarizes the project's architecture, standards, and current state to quickly orient a new developer (or the agent itself).
6868

6969
### 🏗️ Phase 2: Development & Execution
7070
* **`/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.
7171
* **`/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.
7373
* **`/scaffold`**: Initializes new project structures from scratch using modern, standard tooling (Python/uv, TS/npm, Rust/cargo, etc.) and sets up a compatible `makefile`.
7474

7575
### 🧹 Phase 3: Content Generation, Maintenance & Documentation
@@ -90,7 +90,7 @@ This framework shines when you combine these commands into cohesive workflows:
9090
### 1️⃣ Feature Development Workflow
9191
1. **Discover:** Run `/research` to understand the domain or library.
9292
2. **Plan:** Use `/plan` to turn requirements into a technical roadmap in `plans/`.
93-
3. **Track:** Link the plan to `TASKS.md` using `/plan`'s built-in sync.
93+
3. **Track:** Link the plan to `tasks.yaml` using `/task attach-plan`.
9494
4. **Implement:** Use `/task work` to mark progress and begin coding.
9595
5. **Refine:** Run `/document` to ensure your changes are well-documented.
9696
6. **Ship:** Use `/commit` for clean history and `/release` for a new version tag.
@@ -110,9 +110,9 @@ This framework shines when you combine these commands into cohesive workflows:
110110

111111
The framework uses a git pre-commit hook to enforce engineering standards:
112112

113-
* **`git-precommit.py` (Git Hook)**: Enforces daily journaling and timestamp-based validation before any code changes are finalized.
114-
* **`journal.py` (Script)**: The dedicated utility for correctly formatting and appending new journal entries.
115-
* **`task.py` (Script)**: Manages the project roadmap in `TASKS.md`.
113+
* **`pre-commit.py` (Git Hook)**: Enforces daily journaling and timestamp-based validation before any code changes are finalized.
114+
* **`journal.ts` (Tool)**: The dedicated tool for correctly formatting and appending new journal entries.
115+
* **`task.ts` (Tool)**: Manages the project roadmap in `tasks.yaml`.
116116

117117
Install hooks with: `make install-hooks`
118118

docs/deploy.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Running `install.sh` in an empty directory will:
1717
- Initialize a fresh Git repository.
1818
- Extract the core `.opencode/` framework and configuration files.
1919
- Create the standard project structure (`journal/`, `plans/`, `research/`, `drafts/`).
20-
- Initialize baseline files (`README.md`, `CHANGELOG.md`, `TASKS.md`, `makefile`).
20+
- Initialize baseline files (`README.md`, `CHANGELOG.md`, `tasks.yaml`, `makefile`).
2121
- Perform an initial "feat" commit.
2222

2323
### 2. Existing Project (Integration & Updates)
@@ -29,7 +29,6 @@ If run inside an existing project, the script performs a **Surgical Update**:
2929
- **Protection:** Explicitly preserves user configurations in **Protected Files**:
3030
- `opencode.json`
3131
- `.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.
3332
- **Confirm:** Presents a detailed summary of which files will be **created**, **updated**, or **protected** and waits for your approval.
3433
- **Integrate:** Adds missing directory structures (`journal/`, `plans/`, etc.) if they don't exist.
3534
- **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
5251
make install-hooks
5352
```
5453

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.
5655

5756
## 🚢 Getting Started
5857

@@ -68,7 +67,7 @@ gemini /onboard
6867

6968
### 2. Initialize the Roadmap
7069

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.
7271

7372
### 3. Start a New Feature
7473

docs/design.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -70,19 +70,26 @@ The `/task work` command enforces a high-discipline development lifecycle throug
7070

7171
## 📝 Procedural Task Management
7272

73-
The `TASKS.md` file is managed exclusively via `.opencode/tools/task.py`:
73+
The `tasks.yaml` file is managed exclusively via the `task` tool:
7474

7575
- **Single source of truth** for project roadmap
7676
- **State lifecycle:** `add` (Todo) → `start` (In Progress) → `archive` (Done)
77-
- **Never edit `TASKS.md` by hand** — always use the task script
77+
- **Never edit `tasks.yaml` by hand** — always use the task tool
78+
79+
!!! warning "Migrating from TASKS.md"
80+
If you have an existing `TASKS.md` file, instruct the model to migrate it:
81+
```
82+
/task please migrate from @TASKS
83+
```
7884

7985
### Usage
8086

8187
```bash
82-
python .opencode/tools/task.py --help
83-
python .opencode/tools/task.py add --label "Feature X" --description "..."
84-
python .opencode/tools/task.py start --task-id G.1
85-
python .opencode/tools/task.py archive --task-id G.1
88+
task list # Show all tasks
89+
task add --label "Feature X" --description "..."
90+
task start --task-id G.1
91+
task archive --task-id G.1
92+
task attach-plan --task-id G.1 --plan-path plans/my-plan.md
8693
```
8794

8895
## 🔍 Scientific Debugging (`/debug`)
@@ -98,7 +105,7 @@ The `/debug` command implements a principled approach to problem-solving:
98105

99106
The framework uses a timestamp-based git hook to enforce journaling:
100107

101-
- **Hook location:** `.opencode/tools/git-precommit.py`
108+
- **Hook location:** `.opencode/tools/pre-commit.py`
102109
- **Install:** `make install-hooks`
103110
- **Rule:** Journal entry timestamp must be newer than file modifications
104111

@@ -109,14 +116,14 @@ The framework uses a timestamp-based git hook to enforce journaling:
109116
├── agents/ # Primary agent definitions
110117
│ └── subagents/ # Specialized subagents
111118
├── commands/ # High-level commands
112-
├── tools/ # Utilities (task.py, journal.py, git-precommit.py)
119+
├── tools/ # Utilities (TypeScript tools: task.ts, journal.ts, pre-commit.py)
113120
└── style-guide.md # Prose style rules
114121
115122
plans/ # Saved execution plans
116-
journal/ # Daily journal entries (YYYY-MM-DD.md)
123+
journal/ # Daily journal entries (YYYY-MM-DD.yaml)
117124
research/ # Research artifacts
118125
drafts/ # Content drafts
119-
TASKS.md # Project roadmap (managed by task.py)
126+
tasks.yaml # Project roadmap (managed by task tool)
120127
```
121128

122129
## ⚙️ Technology Stack

docs/develop.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,21 @@ Before proposing a change, you must gather context and identify risks. Use the s
2323

2424
### 2. Strategic Planning (The Bridge)
2525

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`.
2727

2828
### 3. Execution & Validation (Side-Effects)
2929

3030
Once a plan is approved, you move to execution. This is the **only** phase where files are modified.
3131

3232
#### For Code: The TCR Protocol
3333
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.
3838

3939
**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.
4141

4242
#### **The TCR Loop (Work Action)**
4343

@@ -65,7 +65,7 @@ When a bug is detected, the `/debug` command enforces a structured, scientific i
6565
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:
6666

6767
```bash
68-
python3 .opencode/tools/journal.py 'one-line description of the work'
68+
journal add "one-line description of the work"
6969
```
7070

7171
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.
8181

8282
## 🧠 Codifying Knowledge with Skills
8383

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:
8588

8689
### 1. Grounded Learning Lifecycle
8790
The agent follows a 4-phase process: **Audit** (environment check), **Strategic Mapping** (learning objectives), **Execution** (real-world experimentation), and **Codification**.

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ curl -fsSL https://apiad.github.io/starter/install.sh | bash
4040
```
4141

4242
!!! success "Next Steps"
43-
After installation, run `gemini /onboard` to get an overview of the repository and start your first session.
43+
After installation, run `opencode /onboard` to get an overview of the repository and start your first session.
4444

4545
## 🛠️ Key Capabilities
4646

@@ -51,14 +51,14 @@ curl -fsSL https://apiad.github.io/starter/install.sh | bash
5151
- **Architectural Planning:** Use `/plan` to generate persistent, actionable strategies.
5252
- **Forensic Debugging:** Use `/debug` for root-cause analysis without immediate (and potentially incorrect) fixes.
5353
- **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`.
5555

5656
## 🔄 Project Lifecycle
5757

5858
1. **Onboarding:** Run `/onboard` to get a high-signal overview of the repository.
5959
2. **Scaffolding:** Use `/scaffold` to initialize new project components with modern tooling.
6060
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.
6262
5. **Releasing:** Use `/release` to automate versioning, changelog updates, and git tagging.
6363

6464
---

0 commit comments

Comments
 (0)