breadcrumb-cli 0.1.0__py3-none-any.whl

breadcrumb_cli-0.1.0.dist-info/METADATA

@@ -0,0 +1,342 @@
+Metadata-Version: 2.4
+Name: breadcrumb-cli
+Version: 0.1.0
+Summary: Chat with your codebase. Understand everything.
+Project-URL: Homepage, https://github.com/yourusername/breadcrumb
+Project-URL: Repository, https://github.com/yourusername/breadcrumb
+Project-URL: Changelog, https://github.com/yourusername/breadcrumb/blob/main/CHANGELOG.md
+License: MIT
+License-File: LICENSE
+Keywords: ai,cli,codebase,developer-tools,llm
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Requires-Dist: anthropic>=0.28
+Requires-Dist: click>=8.1
+Requires-Dist: gitpython>=3.1
+Requires-Dist: google-generativeai>=0.7
+Requires-Dist: ollama>=0.2
+Requires-Dist: openai>=1.30
+Requires-Dist: pathspec>=0.12
+Requires-Dist: pydantic>=2.7
+Requires-Dist: rich>=13.7
+Description-Content-Type: text/markdown
+
+# 🍞 Bread Crumb
+
+**Chat with your codebase from the terminal.**
+
+Bread Crumb lets you ask questions about any code repository, get security audits, review diffs, and understand your codebase in seconds. Supports Anthropic, OpenAI, Gemini, and Ollama — bring your own API key.
+
+[Demo Recording](https://asciinema.org/a/XXXXX) • [Features](#features) • [Installation](#installation) • [Documentation](#docs) • [Contributing](CONTRIBUTING.md)
+
+---
+
+## ⚡ Quick Start
+
+```bash
+# 1. Install
+pip install breadcrumb-cli
+
+# 2. Set your AI provider
+breadcrumb config set-key --provider anthropic
+breadcrumb config set-key --key anthropic_key --value "sk-ant-..."
+
+# 3. Ask questions
+breadcrumb ask "What does the auth module do?"
+breadcrumb ask "Are there any security issues?" --format markdown
+
+# 4. Start interactive chat
+breadcrumb chat .
+
+# 5. Get a security audit
+breadcrumb audit .
+
+# 6. Review a PR
+breadcrumb diff HEAD~1
+```
+
+---
+
+## 🎯 Features
+
+### 🔴 Critical Features
+
+- **Multi-provider AI support** — Anthropic, OpenAI, Gemini, Ollama
+- **One-shot mode** (`breadcrumb ask`) — Perfect for CI/CD pipelines
+- **Pipe mode** — Use in shell scripts and tools: `echo "question" | breadcrumb ask --pipe`
+- **.breadcrumbignore support** — Skip generated files, vendor directories, etc.
+- **Token usage tracking** — See exactly what you're spending
+- **Session management** — Named conversations per repository
+
+### 🟠 High-Value Features
+
+- **`breadcrumb diff`** — AI-powered code review of PRs and commits
+- **`breadcrumb audit`** — Security and architecture audits
+- **`breadcrumb init`** — Generate `.breadcrumb.yaml` for repo-level config
+- **Smart context compression** — Large files get AI summaries instead of truncation
+- **`breadcrumb commit`** — Auto-generate conventional commit messages
+- **Multi-session chat** — Multiple independent conversations per repo
+
+### 🟡 Viral Features
+
+- **`breadcrumb explain-error`** — Pipe any error and get a fix: `npm run build 2>&1 | breadcrumb explain-error`
+- **`breadcrumb share`** — Export chat as beautiful shareable HTML
+- **`breadcrumb digest`** — Daily summary of git commits
+
+---
+
+## 📦 Installation
+
+### Option A: pip (Recommended for developers)
+```bash
+pip install breadcrumb-cli
+breadcrumb ask "How does this work?"
+```
+
+### Option B: pipx (Isolated, recommended for CLI tools)
+```bash
+pipx install breadcrumb-cli
+breadcrumb ask "How does this work?"
+```
+
+### Option C: Download Binary (No Python needed)
+Download the standalone executable from [GitHub Releases](https://github.com/yourusername/breadcrumb/releases):
+- `breadcrumb-linux` for Linux
+- `breadcrumb-macos` for macOS
+- `breadcrumb-windows.exe` for Windows
+
+Then run:
+```bash
+./breadcrumb ask "How does this work?"
+```
+
+### TestPyPI Publishing
+
+Use TestPyPI when you want to validate packaging before a real release.
+
+1. Create a `TEST_PYPI_API_TOKEN` on [TestPyPI](https://test.pypi.org).
+2. Add it to GitHub as a repository secret named `TEST_PYPI_API_TOKEN`.
+3. Run the **Publish to TestPyPI** workflow from the Actions tab, or push a tag like `testpypi-v0.1.0`.
+
+This publishes to `https://test.pypi.org/legacy/` and does not create a GitHub Release.
+
+### Option D: Docker
+```bash
+docker run --rm \
+  -v $(pwd):/repo \
+  -e ANTHROPIC_API_KEY=$ANTHROPIC_API_KEY \
+  breadcrumb/breadcrumb audit
+```
+
+---
+
+## 🔑 Configuration
+
+### Set Your API Key
+
+```bash
+# Anthropic (Claude)
+breadcrumb config set-key --provider anthropic
+breadcrumb config set-key --key anthropic_key --value "sk-ant-..."
+
+# OpenAI
+breadcrumb config set-key --provider openai
+breadcrumb config set-key --key openai_key --value "sk-..."
+
+# Google Gemini
+breadcrumb config set-key --provider gemini
+breadcrumb config set-key --key gemini_key --value "..."
+
+# Ollama (local)
+breadcrumb config set-key --provider ollama
+breadcrumb config set-key --key ollama_url --value "http://localhost:11434"
+```
+
+### Repository Config
+
+Create `.breadcrumb.yaml` in your repo:
+
+```yaml
+# AI Provider to use for this repo
+provider: anthropic
+model: claude-3-5-sonnet-20241022
+
+# Files to ignore (like .gitignore)
+ignore_patterns:
+  - "*.min.js"
+  - "node_modules/"
+  - "vendor/"
+
+# Custom system prompt for this project
+system_prompt: |
+  This is a fintech application. Always flag PCI-DSS compliance issues.
+  The main database is PostgreSQL. Never suggest breaking changes.
+
+temperature: 0.7
+max_tokens: 4096
+```
+
+Then generate this file automatically:
+```bash
+breadcrumb init
+```
+
+---
+
+## 📖 Commands
+
+### Interactive Chat
+```bash
+breadcrumb chat .              # Start interactive session
+breadcrumb chat . --session "security-review"  # Named session
+```
+
+### One-Shot Queries
+```bash
+breadcrumb ask "What does auth.ts do?"
+breadcrumb ask "Security issues?" --format markdown
+```
+
+### Code Review
+```bash
+breadcrumb diff HEAD~1         # Review last commit
+breadcrumb diff main..feature/new-auth  # Review PR branch
+```
+
+### Security & Architecture Audit
+```bash
+breadcrumb audit .             # Full audit
+breadcrumb audit . --model gpt-4o  # Use different model
+```
+
+### Generate Commit Messages
+```bash
+git add .
+breadcrumb commit              # Suggests: "feat(auth): add JWT refresh"
+
+# Or use in scripts:
+git commit -m "$(breadcrumb commit --silent)"
+```
+
+### Explain Errors
+```bash
+npm run build 2>&1 | breadcrumb explain-error
+python script.py 2>&1 | breadcrumb explain-error
+cat error.log | breadcrumb explain-error
+```
+
+### Daily Digest
+```bash
+breadcrumb digest              # Summary of today's commits
+breadcrumb digest --hours 48   # Last 48 hours
+```
+
+### Export & Share
+```bash
+breadcrumb share session.json  # Export as HTML
+```
+
+---
+
+## 🚀 Use Cases
+
+### For Teams
+```bash
+# Security review before merge
+breadcrumb diff feature-branch --format json > audit.json
+
+# Onboarding: new dev understands the codebase
+breadcrumb ask "Give me a 5-minute overview of this project"
+
+# Daily standup digest
+breadcrumb digest | pbcopy  # Copy to Slack
+```
+
+### In CI/CD Pipelines
+```bash
+# .github/workflows/security.yml
+- name: Bread Crumb Audit
+  run: |
+    breadcrumb audit . --format json > audit-report.json
+    if grep -q "critical" audit-report.json; then exit 1; fi
+
+# Pre-commit hook
+breadcrumb commit --silent  # Auto-generate commit message
+```
+
+### Local Development
+```bash
+# Ask questions while coding
+breadcrumb ask "How do I add error handling to this module?"
+
+# Quick error debugging
+npm run test 2>&1 | breadcrumb explain-error
+
+# Understand what you changed
+breadcrumb diff
+```
+
+---
+
+## 🏗️ Architecture
+
+```
+breadcrumb/
+├── cli.py              # Click entry point
+├── config.py           # Configuration management
+├── ingest.py           # File walking & .breadcrumbignore
+├── history.py          # Session management
+├── ai/
+│   ├── router.py       # Provider routing (Anthropic/OpenAI/Gemini/Ollama)
+│   └── prompts.py      # System prompts
+├── commands/
+│   ├── chat.py         # Interactive TUI
+│   ├── ask.py          # One-shot queries
+│   ├── audit.py        # Security audit
+│   ├── diff.py         # Diff review
+│   ├── commit.py       # Commit generation
+│   ├── explain_error.py
+│   ├── digest.py       # Commit digest
+│   ├── init.py         # Config initialization
+│   └── share.py        # HTML export
+```
+
+---
+
+## 🤝 Contributing
+
+We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
+
+### Development Setup
+```bash
+git clone https://github.com/yourusername/breadcrumb
+cd breadcrumb
+pip install -e .
+
+# Run tests
+pytest tests/
+
+# Run linting
+ruff check .
+```
+
+---
+
+## 📝 License
+
+MIT License — see [LICENSE](LICENSE) for details.
+
+---
+
+## 🌟 Show Your Support
+
+If Bread Crumb helps you, please give it a star on GitHub! It helps us reach more developers.
+
+Questions? Issues? [Create an issue](https://github.com/yourusername/breadcrumb/issues) or start a [discussion](https://github.com/yourusername/breadcrumb/discussions).
+
+---
+
+**Made with 🍞 by developers who love their codebases**

breadcrumb_cli-0.1.0.dist-info/RECORD

@@ -0,0 +1,23 @@
+breadcrumb/__init__.py,sha256=UI0sLdMavIdlY9vrjEtk03HMQbZAMSl1ZjHqzaJwbKI,136
+breadcrumb/cli.py,sha256=npov60XTzIyd48UM3wQtv_gIph5C5ibUJSUSfYzWddQ,4285
+breadcrumb/config.py,sha256=YnK1SV6xE4QqPP6V6cwa9g54KFUePqphl0qCxY8DaiE,2719
+breadcrumb/history.py,sha256=KsIQ09b7IAEKcbFneoCSCzYwK7HRhKMJ9bl7D6jnryk,3717
+breadcrumb/ingest.py,sha256=i54Cs5p0QyUyZHGQshPIP1bSV42CtmHkmKa1nU62zlM,4326
+breadcrumb/ai/__init__.py,sha256=JRodfLUx39p-YMxjCzHUN9NujP0qu0kFQOEu-qVmcIU,33
+breadcrumb/ai/prompts.py,sha256=JPrY_KR4pFaL6NOQkmBI0Y8SRi2sVbsbRx9ifEeQvBs,2105
+breadcrumb/ai/router.py,sha256=nLu17fCJ7DZF2hNeElBaFDZcXnbLu8oxvc_7KYkvqwU,8269
+breadcrumb/commands/__init__.py,sha256=SZm8l7LPsmbWw7NISn910pm05iNimY1IjlrzrWhFj58,39
+breadcrumb/commands/ask.py,sha256=GkBC5YuNcix8NZwbBOMmwB9M4zJNFb8sUsGZpQeNHMk,2509
+breadcrumb/commands/audit.py,sha256=73ndAzmUmSuBASo1D8x09AtEsHmQE1P8HzxJpUQEamY,2070
+breadcrumb/commands/chat.py,sha256=AgeUTGBgOONfAQH6Mq6lNKFOQxs9wJ_JFS4wwNzarlA,3689
+breadcrumb/commands/commit.py,sha256=AGVf16soZTdR3xeYPKZMrwGPjxJSaYPkkIdTPACSnUs,2241
+breadcrumb/commands/diff.py,sha256=KcA3dEYUu2Yf8w9B6JCIODF9s3KPcX2B4ZIig39VGWw,2244
+breadcrumb/commands/digest.py,sha256=rTSEoMeFZAHImaJqPSJod_--DfsGMfokxwxSuw3dF8w,2069
+breadcrumb/commands/explain_error.py,sha256=Qvn9nYHPsxzohAOayFLimBuYfCXs9eiCvdVkrrqGxc4,1449
+breadcrumb/commands/init.py,sha256=VcXr0Cyp6l7ndFxzLQfsGoNUneHL_ePnl46NGsWP7oU,1655
+breadcrumb/commands/share.py,sha256=8X48xjVuJtdGkeOHrfCmtLPtA_OMm0O3vzfugksc-LM,5326
+breadcrumb_cli-0.1.0.dist-info/METADATA,sha256=L1Ap7JcXz2KOAQw4D5aZt8n83uSQ-KxFqYjDeZryADA,9084
+breadcrumb_cli-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+breadcrumb_cli-0.1.0.dist-info/entry_points.txt,sha256=Jd4w4jxX0rx6xEJ5NpHbrNFtx3xsWEHeRYL0wb5zzz8,51
+breadcrumb_cli-0.1.0.dist-info/licenses/LICENSE,sha256=-AK-cTA2DYHGRwxJhKPPFKCxY7XrNe_NmJRY1vk1rXI,1099
+breadcrumb_cli-0.1.0.dist-info/RECORD,,

breadcrumb_cli-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

breadcrumb_cli-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+breadcrumb = breadcrumb.cli:main

breadcrumb_cli-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,23 @@
+"""
+LICENSE - MIT License
+
+Copyright (c) 2024 Bread Crumb Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""