docs: add AGENTS.md with project conventions and architecture
This commit is contained in:
parent
32bb3acb09
commit
f50280364d
1 changed files with 29 additions and 0 deletions
29
AGENTS.md
Normal file
29
AGENTS.md
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
# aicl
|
||||
|
||||
Bun CLI tool for streaming LLM chat with inline markdown rendering.
|
||||
|
||||
## Commands
|
||||
|
||||
```
|
||||
bun run dev # dev run
|
||||
bun run prod # run bundled output
|
||||
bun run check # biome lint + format + organize imports
|
||||
```
|
||||
|
||||
## Architecture
|
||||
|
||||
- `index.ts` — CLI entry point, orchestration
|
||||
- `src/render/index.ts` — `Renderer` class: streams LLM response, buffers markdown, renders to stdout/stderr
|
||||
- `src/render/markdown.ts` — `renderMarkdown()`: syntax-highlighted markdown via `@comark/ansi` + Shiki
|
||||
|
||||
## Gotchas
|
||||
|
||||
- **Bun only** — not Node. Use `Bun.file()`, `Bun.argv`, `Bun.sleep()`.
|
||||
- **No tests** — none exist.
|
||||
- **Biome config**: double quotes, space indent, auto-import-organize on. Run `bun run check` before committing.
|
||||
|
||||
## Style
|
||||
|
||||
- Double quotes (enforced by biome).
|
||||
- Preserve `verbatimModuleSyntax` — imports must be used or type-imported.
|
||||
- `strict: true` in tsconfig.
|
||||
Loading…
Add table
Add a link
Reference in a new issue