Skip to content

docs: update project structure diagram to match codebase #224

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
404-Page-Found merged 2 commits into from
Sep 7, 2026
+28 −8
Merged

docs: update project structure diagram to match codebase #224

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b3bb587
docs: update project structure diagram to match codebase
leonrxy Jul 13, 2026
0b82601
Update CONTRIBUTING.md
404-Page-Found Sep 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 28 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,34 @@

```
src/
├── index.ts # CLI entry point (Commander)
├── types.ts # Shared types
├── commands/ # Command implementations (init, suggest, history, completion, batch)
├── config/ # Config persistence
├── git/ # Git operations (diff)
├── history/ # History JSONL + style learner
├── llm/ # Prompt builder + API client
└── providers/ # LLM provider adapters
├── index.ts # CLI entry point (Commander) — registers all commands
├── types.ts # Shared TypeScript interfaces (Config, Provider, Suggestion, etc.)
├── commands/
│ ├── init.ts # Interactive setup wizard (clack/prompts) — provider, model, API key
│ ├── suggest.ts # Core suggestion flow: diff → LLM → display → optional commit
│ ├── history.ts # View learned style profile and recent commit history
│ ├── config.ts # View and set current config
│ ├── batch.ts # Process multiple git repos in batch mode
│ └── completion.ts # Generate shell completion scripts (bash, zsh, fish)
├── providers/
│ ├── index.ts # Provider factory: createProvider(), complete(), completeStream(), fetchModels()
│ ├── registry.ts # BUILTIN_PROVIDERS array (OpenAI, Anthropic, Google, Mistral, etc.)
│ ├── openai-compatible.ts # Default adapter for OpenAI-compatible APIs (most providers)
│ ├── anthropic.ts # Anthropic-specific adapter (Messages API)
│ ├── cohere.ts # Cohere-specific adapter
│ ├── example.ts # No-op example provider for testing
│ ├── request.ts # Shared HTTP request helpers
│ └── sse.ts # Server-Sent Events streaming parser
├── llm/
│ ├── client.ts # generateSuggestions() — orchestrates config → prompt → LLM → parse
│ └── prompt.ts # buildSystemPrompt(), buildUserPrompt(), template vars, diff truncation
├── git/
│ ├── diff.ts # Git ops: getStagedDiff(), getUnstagedDiff(), commit(), checkGitRepo()
│ └── hook.ts # Git hook management: prepare-commit-msg, post-commit
├── history/
│ └── store.ts # JSONL history: loadEntries(), appendEntry(), buildProfile(), formatProfile()
└── config/
└── store.ts # Config persistence: loadConfig(), saveConfig(), env var overrides
```

## Code Conventions
Expand Down