Skip to content

Commit ed8804d

Browse files
committed
Rename project from ContextCraft to CodeBrief, update all references
1 parent 025deee commit ed8804d

33 files changed

Lines changed: 638 additions & 893 deletions

.gitignore

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,41 @@
1+
# Package managers
12
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
*.so
6+
.Python
7+
build/
8+
develop-eggs/
9+
dist/
10+
downloads/
11+
eggs/
12+
.eggs/
13+
lib/
14+
lib64/
15+
parts/
16+
sdist/
17+
var/
18+
wheels/
19+
20+
# Virtual environments
21+
.venv/
22+
env/
23+
venv/
24+
ENV/
25+
26+
# IDE
27+
.vscode/
28+
.idea/
29+
30+
# OS
31+
.DS_Store
32+
Thumbs.db
33+
34+
# Project-specific
35+
rename-report/
236
.pytest_cache/
337
.ruff_cache/
438
.mypy_cache/
5-
.DS_Store
639
*.log
740
*.tmp
841
*.swp

docs/community.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
# Community & Discussions
1+
# Community
22

3-
Welcome to the ContextCraft community! We're building a vibrant ecosystem of developers who believe in making AI collaboration seamless and efficient.
3+
Welcome to the CodeBrief community! We're building a vibrant ecosystem of developers who believe in making AI collaboration seamless and efficient.
44

55
## 🗣️ Join the Conversation
66

77
### GitHub Discussions *(Coming Soon)*
88
We're setting up GitHub Discussions to provide a dedicated space for:
9-
- **💡 Ideas & Feature Requests** - Share your vision for ContextCraft's future
9+
- **💡 Ideas & Feature Requests** - Share your vision for CodeBrief's future
1010
- **❓ Q&A** - Get help from the community and maintainers
11-
- **🎉 Show & Tell** - Share your ContextCraft workflows and success stories
12-
- **💬 General Discussion** - Connect with other developers using ContextCraft
11+
- **🎉 Show & Tell** - Share your CodeBrief workflows and success stories
12+
- **💬 General Discussion** - Connect with other developers using CodeBrief
1313

1414
*In the meantime, please use [GitHub Issues](https://github.com/Shorzinator/ContextCraft/issues) for bug reports and feature requests.*
1515

1616
## 🤝 How to Get Involved
1717

1818
### Share Your Experience
19-
Have you used ContextCraft to solve a tricky problem? We'd love to hear about it! Your stories help other developers understand the real-world impact of the tool.
19+
Have you used CodeBrief to solve a tricky problem? We'd love to hear about it! Your stories help other developers understand the real-world impact of the tool.
2020

2121
### Contribute Ideas
2222
- What features would make your workflow even smoother?
@@ -68,7 +68,7 @@ To keep our community welcoming and productive:
6868
- Assume positive intent in all interactions
6969

7070
### Stay On Topic
71-
- Keep discussions relevant to ContextCraft and AI development workflows
71+
- Keep discussions relevant to CodeBrief and AI development workflows
7272
- Use appropriate channels for different types of conversations
7373
- Search existing discussions before starting new ones
7474

@@ -97,7 +97,7 @@ We're actively working on:
9797

9898
## 💡 Have Ideas?
9999

100-
The best features come from real developer needs. If you have ideas for improving ContextCraft:
100+
The best features come from real developer needs. If you have ideas for improving CodeBrief:
101101

102102
1. Check existing [issues](https://github.com/Shorzinator/ContextCraft/issues) to see if it's already been suggested
103103
2. Open a new issue with the `enhancement` label
@@ -107,7 +107,7 @@ The best features come from real developer needs. If you have ideas for improvin
107107
---
108108

109109
<div align="center">
110-
<p><strong>Ready to contribute to the ContextCraft community?</strong></p>
110+
<p><strong>Ready to contribute to the CodeBrief community?</strong></p>
111111
<p><a href="https://github.com/Shorzinator/ContextCraft" class="md-button md-button--primary">🌟 Star on GitHub</a></p>
112-
<p><em>Every star helps more developers discover ContextCraft!</em></p>
112+
<p><em>Every star helps more developers discover CodeBrief!</em></p>
113113
</div>

docs/index.md

Lines changed: 81 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
1-
# Welcome to ContextCraft
1+
# Welcome to CodeBrief
22

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).
75

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.
99

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.
1113

1214
## Core Problem Solved
1315

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.
1517

1618
## Essential Features
1719

@@ -41,57 +43,85 @@ Copy output directly to clipboard with `--to-clipboard` or `-c` flag on all comm
4143

4244
## Quick Start
4345

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+
```
83113

84114
### Advanced Workflow
85115

86116
```bash
87117
# Create comprehensive project context with bundle
88-
contextcraft bundle \
118+
codebrief bundle \
89119
--output complete-context.md \
90120
--git-log-count 15 \
91121
--flatten src/ tests/
92122

93123
# Focused code review bundle
94-
contextcraft bundle \
124+
codebrief bundle \
95125
--exclude-deps \
96126
--git-full-diff \
97127
--flatten src/ tests/ \
@@ -145,7 +175,7 @@ echo "*.log\n__pycache__/\n.venv/" > .llmignore
145175

146176
## Architecture
147177

148-
ContextCraft is built with modern Python best practices:
178+
CodeBrief is built with modern Python best practices:
149179

150180
- **CLI Framework**: [Typer](https://typer.tiangolo.com/) for intuitive command-line interfaces
151181
- **Rich Output**: [Rich](https://rich.readthedocs.io/) for clean terminal output
@@ -269,7 +299,7 @@ ContextCraft is built with modern Python best practices:
269299

270300
---
271301

272-
Help improve ContextCraft! Read our comprehensive contribution guidelines.
302+
Help improve CodeBrief! Read our comprehensive contribution guidelines.
273303

274304
[:octicons-arrow-right-24: Contribute](development/contributing.md)
275305

docs/reference/config_manager.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Config Manager
22

3-
::: contextcraft.utils.config_manager
3+
::: codebrief.utils.config_manager
44

5-
The config manager module provides configuration management functionality for ContextCraft, handling default settings and user-defined configurations.
5+
The config manager module provides configuration management functionality for CodeBrief, handling default settings and user-defined configurations.
66

77
## Overview
88

@@ -15,7 +15,7 @@ The config manager is responsible for:
1515

1616
## Configuration Files
1717

18-
ContextCraft supports configuration through:
18+
CodeBrief supports configuration through:
1919

2020
- Project-level configuration files
2121
- User-level configuration files
@@ -24,7 +24,7 @@ ContextCraft supports configuration through:
2424

2525
## Default Configuration
2626

27-
The config manager provides sensible defaults for all configuration options, ensuring that ContextCraft works out of the box without requiring extensive configuration.
27+
The config manager provides sensible defaults for all configuration options, ensuring that CodeBrief works out of the box without requiring extensive configuration.
2828

2929
## Related Modules
3030

docs/reference/flattener.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Flattener (`contextcraft.tools.flattener`)
1+
# Flattener (`codebrief.tools.flattener`)
22

3-
This module contains the logic for flattening code and text files from a directory.
3+
Documentation for the flattener module.
44

5-
::: contextcraft.tools.flattener
5+
::: codebrief.tools.flattener
66
handler: python
77
options:
88
show_root_heading: true

docs/reference/main.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Main CLI (`contextcraft.main`)
1+
# Main CLI (`codebrief.main`)
22

3-
This section provides an API reference for the main CLI application and its commands, generated from the source code docstrings.
3+
Documentation for the main CLI module.
44

5-
::: contextcraft.main
5+
::: codebrief.main
66
handler: python
77
options:
88
show_root_heading: true

docs/reference/tools/bundler.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Bundler API Reference
1+
# Bundler
22

3-
::: contextcraft.tools.bundler
3+
::: codebrief.tools.bundler
44

55
## Overview
66

docs/reference/tools/dependency_lister.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Dependency Lister API Reference
22

3-
::: contextcraft.tools.dependency_lister
3+
::: codebrief.tools.dependency_lister
44
handler: python
55
options:
66
show_root_heading: true

docs/reference/tools/git_provider.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Git Provider API Reference
1+
# Git Provider
22

3-
::: contextcraft.tools.git_provider
3+
::: codebrief.tools.git_provider
44

55
## Overview
66

docs/reference/tree_generator.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Tree Generator (`contextcraft.tools.tree_generator`)
1+
# Tree Generator (`codebrief.tools.tree_generator`)
22

3-
This module provides the core logic for generating directory tree structures.
3+
Documentation for the tree generator module.
44

5-
::: contextcraft.tools.tree_generator
5+
::: codebrief.tools.tree_generator
66
handler: python
77
options:
88
show_root_heading: true

0 commit comments

Comments
 (0)