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
+9-11Lines changed: 9 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ This interactive script will:
30
30
2.**Clone** the latest framework components to a temporary location.
31
31
3.**Analyze** your current directory and propose a list of files to create or update.
32
32
4.**Prompt** for your explicit confirmation before applying any changes.
33
-
5.**Integrate** the `.gemini/` configuration and framework files (non-destructively).
33
+
5.**Integrate** the `.opencode/` configuration and framework files (non-destructively).
34
34
6.**Commit** the changes automatically with a descriptive message.
35
35
36
36
Once the installation is complete, run `gemini /onboard` to get an overview of the repository and start your first session.
@@ -54,12 +54,11 @@ This repository is a heavily customized and oppinionanted Gemini CLI agent, read
54
54
55
55
## 🛠️ The Project Lifecycle
56
56
57
-
The `.gemini/commands/` directory defines specialized workflows that automate every phase of the development lifecycle:
57
+
The `.opencode/commands/` directory defines specialized workflows that automate every phase of the development lifecycle:
58
58
59
59
### 🔍 Phase 1: Planning & Discovery
60
60
***`/research <topic>`**: A deep, 3-phase investigation (Planning -> Data Gathering -> Reporting) that produces exhaustive Markdown reports in the `research/` directory. **Crucial for gathering technical requirements and state-of-the-art context.**
61
-
***`/learn <topic>`**: A grounded learning lifecycle (Audit -> Strategic Mapping -> Execution -> Codification) for mastering new technologies and building a permanent, machine-readable knowledge base in `.gemini/skills/` using the specialized `learner` subagent.
62
-
***`/brainstorm`**: An interactive, high-signal brainstorming session. The agent acts as a critical partner—challenging your assumptions, identifying architectural risks, and asking hard follow-up questions—without making any changes to the codebase.
61
+
***`/learn <topic>`**: A grounded learning lifecycle for mastering new technologies through structured exploration and experimentation.***`/brainstorm`**: An interactive, high-signal brainstorming session. The agent acts as a critical partner—challenging your assumptions, identifying architectural risks, and asking hard follow-up questions—without making any changes to the codebase.
63
62
***`/plan`**: The **Architectural Bridge**. This interactive workflow translates ideas into actionable execution plans:
64
63
***Phase 1 (Clarification):** The agent interviews you to resolve ambiguities before planning.
65
64
***Phase 2 (Agentic Analysis):** A specialized `planner` subagent scans the codebase and generates a detailed technical strategy.
@@ -107,16 +106,15 @@ This framework shines when you combine these commands into cohesive workflows:
107
106
2.**Draft:** Run `/draft` to build an outline and expand it into a full article.
108
107
3.**Review:** Use `/review` for non-destructive, multi-phase audits and refinements.
109
108
110
-
## ⚓ The Hook System
109
+
## ⚓ Pre-Commit Validation
111
110
112
-
The framework uses a dual-layer hook system to synchronize the agent with your project state:
111
+
The framework uses a git pre-commit hook to enforce engineering standards:
113
112
114
-
***`session.py` / `welcome.py`**: Initialize the environment, provide a project summary, and check for environment readiness.
115
-
***`log.py`**: Provides a comprehensive, structured audit trail of every agent turn and tool execution.
116
-
***`notify.py`**: Sends a desktop notification and sound when the agent completes its work, minimizing downtime.
117
-
***`cron.py`**: Synchronizes repetitive tasks with **systemd user timers**.
118
-
***`pre-commit.py` (Git Hook)**: Enforces daily journaling and timestamp-based validation before any code changes are finalized.
113
+
***`git-precommit.py` (Git Hook)**: Enforces daily journaling and timestamp-based validation before any code changes are finalized.
119
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`.
-**Protection:** Explicitly preserves user configurations in **Protected Files**:
30
-
-`.gemini/settings.json`
31
-
-`.gemini/style-guide.md`
30
+
-`opencode.json`
31
+
-`.opencode/style-guide.md`
32
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
33
-**Confirm:** Presents a detailed summary of which files will be **created**, **updated**, or **protected** and waits for your approval.
34
34
-**Integrate:** Adds missing directory structures (`journal/`, `plans/`, etc.) if they don't exist.
@@ -40,7 +40,7 @@ To ensure full functionality, your environment should have:
40
40
41
41
-**Git:** Required for state management and change detection hooks.
42
42
-**Node.js:** Necessary for running the `gemini` CLI.
43
-
-**Python 3.12+:** Required for executing the project's automation hooks (`.gemini/hooks/`).
43
+
-**Python 3.12+:** Required for executing the project's automation scripts in `.opencode/tools/`.
44
44
-**uv:** The required Python package and project manager.
45
45
-**Make:** Used for project validation and health checks (runs `uv run pytest`).
46
46
@@ -52,7 +52,7 @@ After installation, you **must** link the framework's hooks to your git reposito
52
52
make install-hooks
53
53
```
54
54
55
-
This target creates a symbolic link from `.gemini/hooks/pre-commit.py` to `.git/hooks/pre-commit`, enabling the automated journal and validation checks.
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.
56
56
57
57
## 🚢 Getting Started
58
58
@@ -70,10 +70,6 @@ gemini /onboard
70
70
71
71
Check the current `TASKS.md` file and use the `/task` command to define your project's initial goals.
72
72
73
-
### 3. Codified Knowledge
74
-
75
-
Knowledge mastered via `/learn` is stored in `.gemini/skills/`. These are permanent project assets and **must** be tracked in version control to ensure the AI's long-term memory persists across environments.
76
-
77
73
### 3. Start a New Feature
78
74
79
75
For your first feature, follow the standard workflow:
0 commit comments