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
+10-5Lines changed: 10 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,8 @@
11
11
12
12
## Overview
13
13
14
-
`grepo` automates the heavy lifting of repository maintenance. By integrating with LLM providers like Google Gemini, it intelligently analyzes your codebase to generate professional READMEs, suggest relevant repository topics, craft repository descriptions, summarize technologies, and recommend improvements.
14
+
`grepo` automates the heavy lifting of repository maintenance.
15
+
By integrating with LLM providers like Google Gemini, it intelligently analyzes your codebase to generate professional READMEs, suggest relevant repository topics, craft repository descriptions, summarize technologies, and recommend improvements.
15
16
16
17
### High-Level Flow
17
18
@@ -30,7 +31,8 @@ flowchart LR
30
31
31
32
## Architecture
32
33
33
-
`grepo` is built on top of the [Effect](https://effect.website/) ecosystem, providing typed errors, composable services, and structured concurrency. The CLI is decomposed into **commands**, **services**, and **utilities**.
34
+
`grepo` is built on top of the [Effect](https://effect.website/) ecosystem, providing typed errors, composable services, and structured concurrency.
35
+
The CLI is decomposed into **commands**, **services**, and **utilities**.
34
36
35
37
### Module Layout
36
38
@@ -108,7 +110,8 @@ flowchart TB
108
110
109
111
## Command Pipeline
110
112
111
-
Every command follows the same shape: **parse → fetch context → prompt → act**. The `readme` command adds analysis, generation, and mermaid validation phases.
113
+
Every command follows the same shape: **parse → fetch context → prompt → act**.
114
+
The `readme` command adds analysis, generation, and mermaid validation phases.
112
115
113
116
### Generic Command Flow
114
117
@@ -267,7 +270,8 @@ flowchart TD
267
270
268
271
## Error Model
269
272
270
-
Errors are tagged data classes from `errors.ts`. Each command declares its possible failures in the type so `Effect.catchTags` can route them to user-friendly messages.
273
+
Errors are tagged data classes from `errors.ts`.
274
+
Each command declares its possible failures in the type so `Effect.catchTags` can route them to user-friendly messages.
`grepo` requires authentication for repository access and AI analysis. Configure these via environment variables, a `.env` file, or `~/.grepo/config.json`:
350
+
`grepo` requires authentication for repository access and AI analysis.
351
+
Configure these via environment variables, a `.env` file, or `~/.grepo/config.json`:
0 commit comments