Skip to content

Commit 1c9f6ac

Browse files
committed
Add documentation
1 parent c04f66f commit 1c9f6ac

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

docs/design.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Design
2+
3+
AgentFlowDesk is built around one opinion:
4+
5+
> AI-agent work should be structured like engineering work, not like disposable chat history.
6+
7+
## Pipeline
8+
9+
```text
10+
User Task
11+
12+
Task Brief
13+
14+
Context Pack Builder
15+
16+
Agent Export / Agent Command
17+
18+
Logs + Diff + Checks
19+
20+
Review Report
21+
22+
Reusable Skill
23+
```
24+
25+
## Non-goals
26+
27+
- It is not a model provider.
28+
- It is not a universal autonomous agent framework.
29+
- It is not a replacement for GitHub, Jira, Linear, or IDE tools.
30+
- It does not claim to judge code correctness by itself.
31+
32+
## MVP architecture
33+
34+
```text
35+
agentflow/
36+
cli.py argparse CLI entrypoint
37+
storage.py local .agentflow JSON store
38+
models.py Task and RunRecord models
39+
context_builder.py context-pack generation
40+
exporters.py AGENTS.md / CLAUDE.md / Cursor / Codex / Gemini exports
41+
runner.py run command wrapper and report generation
42+
review.py markdown review report renderer
43+
git_tools.py git status/diff helpers
44+
```
45+
46+
## Why local-first
47+
48+
AI-agent usage often touches private repositories and unfinished code. The MVP stores metadata, prompts, logs, and reports locally under `.agentflow/`. Users decide which agent CLI or external model gets called.

0 commit comments

Comments
 (0)