What needs to be documented?
New contributors have to read all the source files
to understand how the project fits together. There
is no high-level architecture document.
Where is the issue?
Missing file: ARCHITECTURE.md in the repo root.
Suggested fix
Create ARCHITECTURE.md that explains the flow:
index.js → entry point, readline loop
agent.js → decides if tool needed, runs the loop
llm.js → talks to Gemini API
tools.js → tool registry (name, description, func)
functions.js → actual tool implementations
help.js → --help flag output
colors.js → shared ANSI color constants (planned)
Include a simple Mermaid diagram showing the flow.
References
src/ folder
What needs to be documented?
New contributors have to read all the source files
to understand how the project fits together. There
is no high-level architecture document.
Where is the issue?
Missing file: ARCHITECTURE.md in the repo root.
Suggested fix
Create ARCHITECTURE.md that explains the flow:
index.js → entry point, readline loop
agent.js → decides if tool needed, runs the loop
llm.js → talks to Gemini API
tools.js → tool registry (name, description, func)
functions.js → actual tool implementations
help.js → --help flag output
colors.js → shared ANSI color constants (planned)
Include a simple Mermaid diagram showing the flow.
References
src/ folder