|
1 | | -# Welcome to ContextCraft |
| 1 | +# Welcome to CodeBrief |
2 | 2 |
|
3 | | -<div align="center" class="hero-section"> |
4 | | - <h2 class="hero-title">The Missing Link Between Your Codebase and AI Assistants</h2> |
5 | | - <p class="hero-subtitle"><em>Stop copying files. Start solving problems.</em></p> |
6 | | -</div> |
| 3 | +!!! tip "Quick Start" |
| 4 | + Ready to streamline your LLM workflows? Jump to [Quick Start](getting-started/quick-start.md) or [Installation](getting-started/installation.md). |
7 | 5 |
|
8 | | ---- |
| 6 | +## The Missing Link Between Your Codebase and AI Assistants |
| 7 | + |
| 8 | +**CodeBrief** is a production-ready Command Line Interface (CLI) toolkit designed to solve the core problem developers face when working with AI assistants: manually preparing context from their projects. Whether you're debugging with ChatGPT, explaining your codebase to Claude, or preparing documentation for any LLM, CodeBrief provides the essential tools to create rich, contextual project summaries in seconds, not minutes. |
9 | 9 |
|
10 | | -**ContextCraft** is a production-ready Command Line Interface (CLI) toolkit designed to solve the core problem developers face when working with AI assistants: manually preparing context from their projects. Whether you're debugging with ChatGPT, explaining your codebase to Claude, or preparing documentation for any LLM, ContextCraft provides the essential tools to create rich, contextual project summaries in seconds, not minutes. |
| 10 | +## Stop Copying Files. Start Solving Problems. |
| 11 | + |
| 12 | +Developers waste 10+ minutes per day copying and pasting project files, directory structures, and configuration details to provide context every time they need AI assistance. CodeBrief reduces this to a single command that takes seconds. |
11 | 13 |
|
12 | 14 | ## Core Problem Solved |
13 | 15 |
|
14 | | -Developers waste 5-10 minutes manually copying files, explaining project structure, and gathering context every time they need AI assistance. ContextCraft reduces this to a single command that takes seconds. |
| 16 | +Developers waste 5-10 minutes manually copying files, explaining project structure, and gathering context every time they need AI assistance. CodeBrief reduces this to a single command that takes seconds. |
15 | 17 |
|
16 | 18 | ## Essential Features |
17 | 19 |
|
@@ -41,57 +43,85 @@ Copy output directly to clipboard with `--to-clipboard` or `-c` flag on all comm |
41 | 43 |
|
42 | 44 | ## Quick Start |
43 | 45 |
|
44 | | -Get started with ContextCraft in minutes: |
45 | | - |
46 | | -### Installation |
47 | | - |
48 | | -```bash |
49 | | -# Install from PyPI |
50 | | -pip install contextcraft |
51 | | - |
52 | | -# Or install with Poetry |
53 | | -poetry add contextcraft |
54 | | -``` |
55 | | - |
56 | | -### Basic Usage |
57 | | - |
58 | | -```bash |
59 | | -# Generate a directory tree |
60 | | -contextcraft tree |
61 | | - |
62 | | -# Copy tree to clipboard |
63 | | -contextcraft tree --to-clipboard |
64 | | - |
65 | | -# Flatten your Python code |
66 | | -contextcraft flatten . --include "*.py" --output context.md |
67 | | - |
68 | | -# Copy flattened code to clipboard |
69 | | -contextcraft flatten . --include "*.py" -c |
70 | | - |
71 | | -# Analyze dependencies |
72 | | -contextcraft deps --output deps.md |
73 | | - |
74 | | -# Extract Git context |
75 | | -contextcraft git-info --output git-context.md |
76 | | - |
77 | | -# Create comprehensive bundle |
78 | | -contextcraft bundle --output project-bundle.md |
79 | | - |
80 | | -# Copy bundle to clipboard |
81 | | -contextcraft bundle -c |
82 | | -``` |
| 46 | +Get started with CodeBrief in minutes: |
| 47 | + |
| 48 | +=== "pip" |
| 49 | + ```bash |
| 50 | + pip install codebrief |
| 51 | + ``` |
| 52 | + |
| 53 | +=== "poetry" |
| 54 | + ```bash |
| 55 | + poetry add codebrief |
| 56 | + ``` |
| 57 | + |
| 58 | +=== "Basic tree generation" |
| 59 | + ```bash |
| 60 | + codebrief tree |
| 61 | + ``` |
| 62 | + |
| 63 | +=== "Copy tree to clipboard" |
| 64 | + ```bash |
| 65 | + codebrief tree --to-clipboard |
| 66 | + ``` |
| 67 | + |
| 68 | +=== "Flatten Python files to a single output" |
| 69 | + ```bash |
| 70 | + codebrief flatten . --include "*.py" --output context.md |
| 71 | + ``` |
| 72 | + |
| 73 | +=== "Flatten Python files to clipboard" |
| 74 | + ```bash |
| 75 | + codebrief flatten . --include "*.py" -c |
| 76 | + ``` |
| 77 | + |
| 78 | +=== "Extract dependencies" |
| 79 | + ```bash |
| 80 | + codebrief deps --output deps.md |
| 81 | + ``` |
| 82 | + |
| 83 | +=== "Git context extraction" |
| 84 | + ```bash |
| 85 | + codebrief git-info --output git-context.md |
| 86 | + ``` |
| 87 | + |
| 88 | +=== "Bundle everything" |
| 89 | + ```bash |
| 90 | + codebrief bundle --output project-bundle.md |
| 91 | + ``` |
| 92 | + |
| 93 | +=== "Bundle to clipboard" |
| 94 | + ```bash |
| 95 | + codebrief bundle -c |
| 96 | + ``` |
| 97 | + |
| 98 | +=== "Complex bundle with specific paths" |
| 99 | + ```bash |
| 100 | + codebrief bundle \ |
| 101 | + --output comprehensive-context.md \ |
| 102 | + --flatten src/ --flatten tests/ \ |
| 103 | + --git-log-count 10 --git-full-diff |
| 104 | + ``` |
| 105 | + |
| 106 | +=== "Bundle selective sections" |
| 107 | + ```bash |
| 108 | + codebrief bundle \ |
| 109 | + --exclude-deps --exclude-git \ |
| 110 | + --flatten src/core/ \ |
| 111 | + --output focused-context.md |
| 112 | + ``` |
83 | 113 |
|
84 | 114 | ### Advanced Workflow |
85 | 115 |
|
86 | 116 | ```bash |
87 | 117 | # Create comprehensive project context with bundle |
88 | | -contextcraft bundle \ |
| 118 | +codebrief bundle \ |
89 | 119 | --output complete-context.md \ |
90 | 120 | --git-log-count 15 \ |
91 | 121 | --flatten src/ tests/ |
92 | 122 |
|
93 | 123 | # Focused code review bundle |
94 | | -contextcraft bundle \ |
| 124 | +codebrief bundle \ |
95 | 125 | --exclude-deps \ |
96 | 126 | --git-full-diff \ |
97 | 127 | --flatten src/ tests/ \ |
@@ -145,7 +175,7 @@ echo "*.log\n__pycache__/\n.venv/" > .llmignore |
145 | 175 |
|
146 | 176 | ## Architecture |
147 | 177 |
|
148 | | -ContextCraft is built with modern Python best practices: |
| 178 | +CodeBrief is built with modern Python best practices: |
149 | 179 |
|
150 | 180 | - **CLI Framework**: [Typer](https://typer.tiangolo.com/) for intuitive command-line interfaces |
151 | 181 | - **Rich Output**: [Rich](https://rich.readthedocs.io/) for clean terminal output |
@@ -269,7 +299,7 @@ ContextCraft is built with modern Python best practices: |
269 | 299 |
|
270 | 300 | --- |
271 | 301 |
|
272 | | - Help improve ContextCraft! Read our comprehensive contribution guidelines. |
| 302 | + Help improve CodeBrief! Read our comprehensive contribution guidelines. |
273 | 303 |
|
274 | 304 | [:octicons-arrow-right-24: Contribute](development/contributing.md) |
275 | 305 |
|
|
0 commit comments