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
+17-14Lines changed: 17 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,20 +11,29 @@
11
11
12
12
*A cognitive partnership model that enforces rigorous engineering standards, strategic planning, and continuous validation.*
13
13
14
+
#### π [**Check out the launch blog post!**](https://blog.apiad.net/p/how-im-using-ai-today)
15
+
14
16
</div>
15
17
16
18
---
17
19
18
-
## π§ The Core Philosophy: AI as a Senior Partner
20
+
## π₯ Quick Start
21
+
22
+
This repository is meant to be used as a template for new projects.
23
+
24
+
1. Clone the repo or [create a new project directly](https://github.com/apiad/starter/generate).
25
+
2. Delete `README.md`, `CHANGELOG.md`, and `journal/*.md` to get a fresh history.
26
+
3. Run `gemini /scaffold` to start a new project.
27
+
4. Follow instructions and enjoy!
19
28
20
-
In this framework, the AI agent is not just a "code generator" or a "copilot". It is a **Senior Architect and Critical Thinking Partner**.
29
+
## π§ The Core Philosophy
30
+
31
+
This repository is a heavily customized and oppinionanted Gemini CLI agent, ready to be used in any situation. In this framework, the AI agent is not just a "code generator" or a "copilot". It is a **Senior Architect and Critical Thinking Partner**:
21
32
22
33
***π‘οΈ Critical Feedback First:** The agent is instructed to challenge unsafe, redundant, or poorly conceived ideas *before* writing a single line of code.
23
34
***π Research -> Plan -> Execute:** Every non-trivial change follows a strict lifecycle. The agent first researches context, proposes a detailed plan, waits for your explicit approval, and only then begins implementation.
24
35
***β Validation-Always:** The framework uses `make` as a source of truth. The agent is hooked into the `makefile` to ensure every change is validated (linted and tested) before being finalized.
25
36
26
-
---
27
-
28
37
## π οΈ The Project Lifecycle
29
38
30
39
The `.gemini/commands/` directory defines specialized workflows that automate every phase of the development lifecycle:
@@ -54,9 +63,7 @@ The `.gemini/commands/` directory defines specialized workflows that automate ev
54
63
***`/commit`**: Analyzes all uncommitted changes, groups them into logical features or fixes, and guides you through committing them individually using **Conventional Commits**.
55
64
***`/release`**: Automates the final shipping steps: running tests, determining the next version (semver), updating the `CHANGELOG.md`, and tagging the release.
56
65
57
-
---
58
-
59
-
## π Standard Operating Procedures (SOPs)
66
+
## π Common Use Cases
60
67
61
68
This framework shines when you combine these commands into cohesive workflows:
62
69
@@ -79,9 +86,7 @@ This framework shines when you combine these commands into cohesive workflows:
79
86
2.**Draft:** Run `/draft` to build an outline and expand it into a full article.
80
87
3.**Revise:** Use `/revise` for step-by-step style guide-driven audits and refinements.
81
88
82
-
---
83
-
84
-
## β The Hook System: Staying in Sync
89
+
## β The Hook System
85
90
86
91
The framework uses a robust hook system (`.gemini/hooks/`) that synchronizes the agent with your project state:
87
92
@@ -90,8 +95,6 @@ The framework uses a robust hook system (`.gemini/hooks/`) that synchronizes the
90
95
***`make.py`**: Automatically runs `make` after critical agent actions to prevent regressions.
91
96
***`cron.py`**: Synchronizes `cron.toml` tasks with **systemd user timers**.
92
97
93
-
---
94
-
95
-
## π License
98
+
## π License & Contribution
96
99
97
-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
100
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. All contributions are welcome!
0 commit comments