Skip to content

Commit 2f1d2ff

Browse files
committed
Docs: Add architecture diagram to README
- Introduced a Mermaid diagram to visually represent the agent's architecture. - The diagram illustrates the configuration precedence, CLI interaction, LLM planning cycle, tool execution, and response generation. - This will help users understand the internal workings of the agent more easily.
1 parent 9fb6487 commit 2f1d2ff

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,24 @@
22

33
A tiny, KISS-friendly command line agent that can talk to either OpenAI's ChatGPT API or Google's Gemini API. The agent supports a pluggable backend, a light tool loop, and environment-driven configuration.
44

5+
### Architecture
6+
7+
```mermaid
8+
flowchart TD
9+
subgraph ConfigChain[Configuration precedence]
10+
A1[CLI params] --> A2[.env values]
11+
A2 --> A3[Code defaults]
12+
end
13+
ConfigChain --> CLI
14+
CLI[CLI] --> Prompt[User prompt as task objective]
15+
Prompt --> SystemPrompt[System prompt + tool descriptions]
16+
SystemPrompt --> Loop{{LLM backend planning cycle}}
17+
Loop -->|tool call| Tools[Tool runner]
18+
Tools --> Loop
19+
Loop -->|≤ --max-turns default 5| Loop
20+
Loop --> Response[Final response to user]
21+
```
22+
523
### Examples
624

725
#### Disk space:

0 commit comments

Comments
 (0)