agentchanti 0.1.0__tar.gz

agentchanti-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Uday Kanth
+
+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.

agentchanti-0.1.0/PKG-INFO

@@ -0,0 +1,361 @@
+Metadata-Version: 2.4
+Name: agentchanti
+Version: 0.1.0
+Summary: A multi-agent AI coding system with built-in RAG — local or cloud, CLI or API.
+Author: Uday Kanth
+License: MIT License
+        
+        Copyright (c) 2026 Uday Kanth
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/udaykanth/agentchanti
+Project-URL: Repository, https://github.com/udaykanth/agentchanti
+Project-URL: Issues, https://github.com/udaykanth/agentchanti/issues
+Keywords: ai,agent,llm,coding-assistant,ollama,lm-studio,openai,anthropic,gemini,rag,code-generation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: pyyaml
+Requires-Dist: rich>=13.0
+Requires-Dist: textual
+Requires-Dist: networkx>=3.0
+Requires-Dist: syntax_checker
+Requires-Dist: tree-sitter>=0.22
+Requires-Dist: tree-sitter-python
+Requires-Dist: tree-sitter-javascript
+Requires-Dist: tree-sitter-typescript
+Requires-Dist: tree-sitter-java
+Requires-Dist: tree-sitter-c
+Requires-Dist: tree-sitter-cpp
+Requires-Dist: tree-sitter-go
+Requires-Dist: tree-sitter-rust
+Requires-Dist: tree-sitter-ruby
+Requires-Dist: tree-sitter-php
+Requires-Dist: tree-sitter-c-sharp
+Requires-Dist: watchdog>=3.0
+Requires-Dist: tqdm>=4.60
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+<pre>
+     _                    _      ____ _                 _   _
+    / \   __ _  ___ _ __ | |_   / ___| |__   __ _ _ __ | |_(_)
+   / _ \ / _` |/ _ \ '_ \| __| | |   | '_ \ / _` | '_ \| __| |
+  / ___ \ (_| |  __/ | | | |_  | |___| | | | (_| | | | | |_| |
+ /_/   \_\__, |\___|_| |_|\__|  \____|_| |_|\__,_|_| |_|\__|_|
+         |___/
+                  ━━  A u t o n o m o u s   C o d e r  ━━
+</pre>
+</p>
+
+<p align="center">
+  <b>A multi-agent AI coding system with built-in RAG — local or cloud, CLI or API.</b><br>
+  Plans. Codes. Reviews. Tests. Understands your codebase.
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/badge/python-3.10%2B-blue" alt="Python 3.10+">
+  <img src="https://img.shields.io/badge/license-MIT-green" alt="MIT License">
+  <img src="https://img.shields.io/badge/LLM-Local%20%2B%20Cloud-orange" alt="Local + Cloud">
+  <img src="https://img.shields.io/badge/providers-Ollama%20%7C%20LM%20Studio%20%7C%20OpenAI%20%7C%20Gemini%20%7C%20Claude-blueviolet" alt="Multiple Providers">
+</p>
+
+## What is AgentChanti?
+
+AgentChanti ships with a built-in RAG system. Before any agent writes code, it automatically retrieves the most relevant functions, classes, and docs from your codebase and injects them as context — so even a local 7B model running in Ollama understands your project structure and coding conventions. Teams can add internal docs, architecture decisions, and coding standards to the Global KB, and every agent on every run picks them up automatically.
+
+AgentChanti is a **command-line tool and Python library** that takes a plain English description of a coding task and autonomously builds the software for you using a team of specialized AI agents:
+
+| Agent | Role |
+|-------|------|
+| **Planner** | Breaks your task into numbered, actionable steps |
+| **Coder** | Writes clean, idiomatic code for each step |
+| **Reviewer** | Checks code for bugs, style issues, and correctness |
+| **Tester** | Generates and runs unit tests to verify everything works |
+
+Supports local LLMs ([Ollama](https://ollama.com), [LM Studio](https://lmstudio.ai)) and cloud providers (OpenAI, Google Gemini, Anthropic Claude).
+
+### Beyond the CLI — Use It as a Service
+
+AgentChanti ships as both a CLI and a **Python library**, so it can be embedded directly into any service:
+
+```python
+# Inside a Flask endpoint — trigger the full agent pipeline on a PR event
+from agentchanti import run_task
+
+@app.route("/pr-review", methods=["POST"])
+def on_pull_request():
+    result = run_task(task="Generate unit tests for the changed files", auto=True)
+    return {"status": result.status, "files": result.files_written}
+```
+
+The **plugin system** (`StepPlugin` base class) lets teams extend the pipeline with custom steps beyond code generation:
+
+| Example Plugin | What It Does |
+|----------------|--------------|
+| PR test generator | Auto-generates tests when a PR is opened |
+| Image validator | Validates assets against design specs using a vision model |
+| Deployment gate | Runs lint, security scan, or compliance checks before deploy |
+| Custom linter | Enforces team-specific coding standards as a pipeline step |
+
+Plugins are discovered automatically from your config or via setuptools entry points — no changes to the core pipeline needed.
+
+### Built-in RAG — Any LLM Understands Your Codebase
+
+AgentChanti includes a **4-phase RAG system** that automatically indexes your project and injects relevant context into every agent prompt — so even a small local model running offline has deep awareness of your internal code and docs:
+
+- **Code graph** — tree-sitter parses your codebase into a symbol graph (functions, classes, imports, call edges) across 11 languages
+- **Semantic search** — every function and class is embedded into a local SQLite vector store; agents retrieve the most relevant symbols before writing any code
+- **Global KB** — add your internal docs, ADRs, and coding standards; every agent picks them up automatically
+- **Error dictionary** — maps known error patterns to fixes so agents self-correct without extra LLM calls
+
+All storage is local SQLite — no cloud vector database required. Works fully offline with local LLMs.
+
+---
+
+## RAG Architecture
+
+AgentChanti uses a **4-phase Retrieval-Augmented Generation (RAG)** system to give every agent deep awareness of your codebase. Before any code is written, the system automatically indexes your project and injects the most relevant context into each LLM prompt.
+
+```
+┌──────────────────────────────────────────────────────────────┐
+│                     Your Coding Task                         │
+└──────────────────┬───────────────────────────────────────────┘
+                   ▼
+┌──────────────────────────────────────────────────────────────┐
+│  Phase 1: Code Graph        Tree-sitter AST parsing          │
+│  ───────────────────        Classes, functions, imports,      │
+│                             call edges → NetworkX graph       │
+├──────────────────────────────────────────────────────────────┤
+│  Phase 2: Semantic KB       Embed symbols → SQLite vectors   │
+│  ────────────────────       Cosine similarity search          │
+│                             Graph-enriched results            │
+├──────────────────────────────────────────────────────────────┤
+│  Phase 3: Global KB         Error-fix dictionary (regex)     │
+│  ──────────────────         Coding patterns, ADRs             │
+│                             Behavioral instructions           │
+├──────────────────────────────────────────────────────────────┤
+│  Phase 4: Context Builder   Intent detection (error/review)  │
+│  ────────────────────────   Retrieve → rank → budget (4000t) │
+│                             Inject into agent prompt          │
+└──────────────────┬───────────────────────────────────────────┘
+                   ▼
+┌──────────────────────────────────────────────────────────────┐
+│              Planner / Coder / Reviewer / Tester             │
+└──────────────────────────────────────────────────────────────┘
+```
+
+| Phase | What It Does | Storage |
+|-------|-------------|---------|
+| **Code Graph** | Parses AST with tree-sitter (11 languages), builds a directed graph of symbols and call edges | `graph.pkl` + `index.db` |
+| **Semantic KB** | Embeds functions/classes into vectors, enables natural-language search over your code | `vectors.db` (SQLite) |
+| **Global KB** | Maps error patterns to fixes, stores coding best practices and behavioral rules | `global_kb.db` (SQLite) |
+| **Context Builder** | Assembles retrieved context per-step with token budgeting and priority ranking | In-memory |
+
+Additional capabilities:
+- **Project Orientation** -- auto-detects language, framework, test runner, and directory structure; injects as a grounding block in every prompt
+- **Runtime Watcher** -- monitors file changes during execution and triggers incremental re-indexing in the background
+- **Smart Startup** -- < 10ms for unchanged projects; incremental or full re-index only when needed
+
+All storage is local SQLite -- no external vector database required. See [documentation.md](documentation.md#rag-architecture) for the full technical deep-dive.
+
+---
+
+## Getting Started
+
+### Prerequisites
+
+- **Python 3.10+** ([python.org](https://www.python.org/downloads/))
+- **Git** ([git-scm.com](https://git-scm.com/))
+
+- A local LLM server **or** a cloud API key
+
+### Installation
+
+**Option 1: pipx (recommended for end users)**
+
+`pipx` installs CLI tools into isolated environments and puts them on
+your `PATH` — no virtualenv to activate, no `pip install` polluting
+your global site-packages.
+
+```bash
+pipx install agentchanti
+agentchanti --help
+```
+
+To upgrade later: `pipx upgrade agentchanti`. To install pre-release
+builds straight from `main`: `pipx install
+git+https://github.com/udaykanth/agentchanti.git`.
+
+> **Note:** The package will be on PyPI once the first tagged release
+> is cut. Until then, use Option 2 or 3 below.
+
+**Option 2: Clone and install (for contributors / latest code)**
+
+```bash
+git clone https://github.com/udaykanth/agentchanti.git
+cd agentchanti
+
+python3 -m venv .venv
+source .venv/bin/activate        # Linux/macOS
+.venv\Scripts\activate           # Windows
+
+python -m pip install -e ".[dev]"   # includes pytest + ruff for tests
+agentchanti --help
+```
+
+**Option 3: Convenience scripts**
+
+If you'd rather not type the venv steps yourself, the repo ships
+helper scripts that do the same thing:
+
+```bash
+git clone https://github.com/udaykanth/agentchanti.git
+cd agentchanti
+
+# Linux / macOS
+chmod +x install.sh && ./install.sh
+
+# Windows
+./install.bat
+
+source .venv/bin/activate        # Linux/macOS
+.venv\Scripts\activate           # Windows
+```
+
+> **Why no `curl | bash` installer?** AgentChanti is a Python package,
+> not a single static binary. The standard Python tooling (`pipx`,
+> `pip`) already handles isolated installs, version pinning, and
+> upgrades — wrapping that in a shell script downloaded over HTTPS
+> would add an attack surface without adding any value.
+
+---
+
+## Usage
+
+```bash
+agentchanti "<task description>" [options]
+```
+
+### Quick Examples
+
+```bash
+# With Ollama
+agentchanti "Create a Flask REST API with CRUD" --provider ollama --model deepseek-coder-v2:16b
+
+# With OpenAI
+OPENAI_API_KEY="sk-..." agentchanti "Build a CLI tool" --provider openai --model gpt-4o-mini
+
+# With Gemini
+GEMINI_API_KEY="..." agentchanti "Build a REST API" --provider gemini --model gemini-2.5-flash
+
+# With Claude
+ANTHROPIC_API_KEY="sk-ant-..." agentchanti "Build a CLI tool" --provider anthropic --model claude-sonnet-4
+
+# Non-interactive (CI/scripts)
+agentchanti "Generate unit tests" --auto --no-git --no-report
+```
+
+### All Options
+
+| Flag | Description | Default |
+|------|-------------|---------|
+| `"task"` | The coding task to perform (required) | — |
+| `--prompt-from-file` | Read task description from a file | — |
+| `--provider` | `ollama`, `lm_studio`, `openai`, `gemini`, `anthropic` | `lm_studio` |
+| `--model` | Model name | `deepseek-coder-v2-lite-instruct` |
+| `--embed-model` | Embedding model name | `nomic-embed-text` |
+| `--language` | Override auto-detected language | auto-detect |
+| `--config` | Path to `.agentchanti.yaml` config file | auto-discover |
+| `--auto` | Non-interactive mode (auto-approve plan) | off |
+| `--no-embeddings` | Disable semantic embeddings | off |
+| `--no-stream` | Disable streaming responses | off |
+| `--no-git` | Disable git checkpoint/rollback | off |
+| `--no-diff` | Disable diff preview before writing | off |
+| `--no-cache` | Disable step-level caching | off |
+| `--clear-cache` | Clear step cache before running | off |
+| `--no-knowledge` | Disable project knowledge base | off |
+| `--no-search` | Disable web search agent | off |
+| `--no-kb` | Disable KB context injection | off |
+| `--report` / `--no-report` | Enable/disable HTML report | on |
+| `--resume` | Force resume from checkpoint | off |
+| `--fresh` | Ignore checkpoint, start fresh | off |
+| `--generate-yaml` | Generate `.agentchanti.yaml` and exit | off |
+
+### Knowledge Base Commands
+
+Manage the project knowledge base via `agentchanti kb`:
+
+```bash
+agentchanti kb embed                 # Embed symbols into the vector store
+agentchanti kb search "query"        # Semantic search over KB
+agentchanti kb query find-callers X  # Find all callers of a function
+agentchanti kb error-lookup "msg"    # Look up error fixes
+agentchanti kb health                # Show KB health report
+agentchanti kb update                # Pull global KB updates
+```
+
+See [documentation.md](documentation.md) for the full list of KB commands.
+
+---
+
+## Documentation
+
+For full documentation including architecture details, configuration reference, library API, plugin system, and troubleshooting, see **[documentation.md](documentation.md)**.
+
+---
+
+## Contributing
+
+Contributions are welcome! Feel free to open issues or submit pull requests.
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/my-feature`)
+3. Run the tests: `python -m pytest tests/ -v`
+4. Commit and push
+5. Open a pull request
+
+---
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.
+
+---
+
+## Disclaimer
+
+> **This is a personal project by [Uday Kanth](https://github.com/udaykanthr).** It is not affiliated with, endorsed by, sponsored by, or in any way officially connected with my current or past employer(s), or any of their subsidiaries, clients, or affiliates. All opinions, code, and design decisions in this project are my own and do not represent the views or intellectual property of any organization I am or have been associated with. This project was built entirely on my own time using my own resources.

agentchanti-0.1.0/README.md

@@ -0,0 +1,290 @@
+<p align="center">
+<pre>
+     _                    _      ____ _                 _   _
+    / \   __ _  ___ _ __ | |_   / ___| |__   __ _ _ __ | |_(_)
+   / _ \ / _` |/ _ \ '_ \| __| | |   | '_ \ / _` | '_ \| __| |
+  / ___ \ (_| |  __/ | | | |_  | |___| | | | (_| | | | | |_| |
+ /_/   \_\__, |\___|_| |_|\__|  \____|_| |_|\__,_|_| |_|\__|_|
+         |___/
+                  ━━  A u t o n o m o u s   C o d e r  ━━
+</pre>
+</p>
+
+<p align="center">
+  <b>A multi-agent AI coding system with built-in RAG — local or cloud, CLI or API.</b><br>
+  Plans. Codes. Reviews. Tests. Understands your codebase.
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/badge/python-3.10%2B-blue" alt="Python 3.10+">
+  <img src="https://img.shields.io/badge/license-MIT-green" alt="MIT License">
+  <img src="https://img.shields.io/badge/LLM-Local%20%2B%20Cloud-orange" alt="Local + Cloud">
+  <img src="https://img.shields.io/badge/providers-Ollama%20%7C%20LM%20Studio%20%7C%20OpenAI%20%7C%20Gemini%20%7C%20Claude-blueviolet" alt="Multiple Providers">
+</p>
+
+## What is AgentChanti?
+
+AgentChanti ships with a built-in RAG system. Before any agent writes code, it automatically retrieves the most relevant functions, classes, and docs from your codebase and injects them as context — so even a local 7B model running in Ollama understands your project structure and coding conventions. Teams can add internal docs, architecture decisions, and coding standards to the Global KB, and every agent on every run picks them up automatically.
+
+AgentChanti is a **command-line tool and Python library** that takes a plain English description of a coding task and autonomously builds the software for you using a team of specialized AI agents:
+
+| Agent | Role |
+|-------|------|
+| **Planner** | Breaks your task into numbered, actionable steps |
+| **Coder** | Writes clean, idiomatic code for each step |
+| **Reviewer** | Checks code for bugs, style issues, and correctness |
+| **Tester** | Generates and runs unit tests to verify everything works |
+
+Supports local LLMs ([Ollama](https://ollama.com), [LM Studio](https://lmstudio.ai)) and cloud providers (OpenAI, Google Gemini, Anthropic Claude).
+
+### Beyond the CLI — Use It as a Service
+
+AgentChanti ships as both a CLI and a **Python library**, so it can be embedded directly into any service:
+
+```python
+# Inside a Flask endpoint — trigger the full agent pipeline on a PR event
+from agentchanti import run_task
+
+@app.route("/pr-review", methods=["POST"])
+def on_pull_request():
+    result = run_task(task="Generate unit tests for the changed files", auto=True)
+    return {"status": result.status, "files": result.files_written}
+```
+
+The **plugin system** (`StepPlugin` base class) lets teams extend the pipeline with custom steps beyond code generation:
+
+| Example Plugin | What It Does |
+|----------------|--------------|
+| PR test generator | Auto-generates tests when a PR is opened |
+| Image validator | Validates assets against design specs using a vision model |
+| Deployment gate | Runs lint, security scan, or compliance checks before deploy |
+| Custom linter | Enforces team-specific coding standards as a pipeline step |
+
+Plugins are discovered automatically from your config or via setuptools entry points — no changes to the core pipeline needed.
+
+### Built-in RAG — Any LLM Understands Your Codebase
+
+AgentChanti includes a **4-phase RAG system** that automatically indexes your project and injects relevant context into every agent prompt — so even a small local model running offline has deep awareness of your internal code and docs:
+
+- **Code graph** — tree-sitter parses your codebase into a symbol graph (functions, classes, imports, call edges) across 11 languages
+- **Semantic search** — every function and class is embedded into a local SQLite vector store; agents retrieve the most relevant symbols before writing any code
+- **Global KB** — add your internal docs, ADRs, and coding standards; every agent picks them up automatically
+- **Error dictionary** — maps known error patterns to fixes so agents self-correct without extra LLM calls
+
+All storage is local SQLite — no cloud vector database required. Works fully offline with local LLMs.
+
+---
+
+## RAG Architecture
+
+AgentChanti uses a **4-phase Retrieval-Augmented Generation (RAG)** system to give every agent deep awareness of your codebase. Before any code is written, the system automatically indexes your project and injects the most relevant context into each LLM prompt.
+
+```
+┌──────────────────────────────────────────────────────────────┐
+│                     Your Coding Task                         │
+└──────────────────┬───────────────────────────────────────────┘
+                   ▼
+┌──────────────────────────────────────────────────────────────┐
+│  Phase 1: Code Graph        Tree-sitter AST parsing          │
+│  ───────────────────        Classes, functions, imports,      │
+│                             call edges → NetworkX graph       │
+├──────────────────────────────────────────────────────────────┤
+│  Phase 2: Semantic KB       Embed symbols → SQLite vectors   │
+│  ────────────────────       Cosine similarity search          │
+│                             Graph-enriched results            │
+├──────────────────────────────────────────────────────────────┤
+│  Phase 3: Global KB         Error-fix dictionary (regex)     │
+│  ──────────────────         Coding patterns, ADRs             │
+│                             Behavioral instructions           │
+├──────────────────────────────────────────────────────────────┤
+│  Phase 4: Context Builder   Intent detection (error/review)  │
+│  ────────────────────────   Retrieve → rank → budget (4000t) │
+│                             Inject into agent prompt          │
+└──────────────────┬───────────────────────────────────────────┘
+                   ▼
+┌──────────────────────────────────────────────────────────────┐
+│              Planner / Coder / Reviewer / Tester             │
+└──────────────────────────────────────────────────────────────┘
+```
+
+| Phase | What It Does | Storage |
+|-------|-------------|---------|
+| **Code Graph** | Parses AST with tree-sitter (11 languages), builds a directed graph of symbols and call edges | `graph.pkl` + `index.db` |
+| **Semantic KB** | Embeds functions/classes into vectors, enables natural-language search over your code | `vectors.db` (SQLite) |
+| **Global KB** | Maps error patterns to fixes, stores coding best practices and behavioral rules | `global_kb.db` (SQLite) |
+| **Context Builder** | Assembles retrieved context per-step with token budgeting and priority ranking | In-memory |
+
+Additional capabilities:
+- **Project Orientation** -- auto-detects language, framework, test runner, and directory structure; injects as a grounding block in every prompt
+- **Runtime Watcher** -- monitors file changes during execution and triggers incremental re-indexing in the background
+- **Smart Startup** -- < 10ms for unchanged projects; incremental or full re-index only when needed
+
+All storage is local SQLite -- no external vector database required. See [documentation.md](documentation.md#rag-architecture) for the full technical deep-dive.
+
+---
+
+## Getting Started
+
+### Prerequisites
+
+- **Python 3.10+** ([python.org](https://www.python.org/downloads/))
+- **Git** ([git-scm.com](https://git-scm.com/))
+
+- A local LLM server **or** a cloud API key
+
+### Installation
+
+**Option 1: pipx (recommended for end users)**
+
+`pipx` installs CLI tools into isolated environments and puts them on
+your `PATH` — no virtualenv to activate, no `pip install` polluting
+your global site-packages.
+
+```bash
+pipx install agentchanti
+agentchanti --help
+```
+
+To upgrade later: `pipx upgrade agentchanti`. To install pre-release
+builds straight from `main`: `pipx install
+git+https://github.com/udaykanth/agentchanti.git`.
+
+> **Note:** The package will be on PyPI once the first tagged release
+> is cut. Until then, use Option 2 or 3 below.
+
+**Option 2: Clone and install (for contributors / latest code)**
+
+```bash
+git clone https://github.com/udaykanth/agentchanti.git
+cd agentchanti
+
+python3 -m venv .venv
+source .venv/bin/activate        # Linux/macOS
+.venv\Scripts\activate           # Windows
+
+python -m pip install -e ".[dev]"   # includes pytest + ruff for tests
+agentchanti --help
+```
+
+**Option 3: Convenience scripts**
+
+If you'd rather not type the venv steps yourself, the repo ships
+helper scripts that do the same thing:
+
+```bash
+git clone https://github.com/udaykanth/agentchanti.git
+cd agentchanti
+
+# Linux / macOS
+chmod +x install.sh && ./install.sh
+
+# Windows
+./install.bat
+
+source .venv/bin/activate        # Linux/macOS
+.venv\Scripts\activate           # Windows
+```
+
+> **Why no `curl | bash` installer?** AgentChanti is a Python package,
+> not a single static binary. The standard Python tooling (`pipx`,
+> `pip`) already handles isolated installs, version pinning, and
+> upgrades — wrapping that in a shell script downloaded over HTTPS
+> would add an attack surface without adding any value.
+
+---
+
+## Usage
+
+```bash
+agentchanti "<task description>" [options]
+```
+
+### Quick Examples
+
+```bash
+# With Ollama
+agentchanti "Create a Flask REST API with CRUD" --provider ollama --model deepseek-coder-v2:16b
+
+# With OpenAI
+OPENAI_API_KEY="sk-..." agentchanti "Build a CLI tool" --provider openai --model gpt-4o-mini
+
+# With Gemini
+GEMINI_API_KEY="..." agentchanti "Build a REST API" --provider gemini --model gemini-2.5-flash
+
+# With Claude
+ANTHROPIC_API_KEY="sk-ant-..." agentchanti "Build a CLI tool" --provider anthropic --model claude-sonnet-4
+
+# Non-interactive (CI/scripts)
+agentchanti "Generate unit tests" --auto --no-git --no-report
+```
+
+### All Options
+
+| Flag | Description | Default |
+|------|-------------|---------|
+| `"task"` | The coding task to perform (required) | — |
+| `--prompt-from-file` | Read task description from a file | — |
+| `--provider` | `ollama`, `lm_studio`, `openai`, `gemini`, `anthropic` | `lm_studio` |
+| `--model` | Model name | `deepseek-coder-v2-lite-instruct` |
+| `--embed-model` | Embedding model name | `nomic-embed-text` |
+| `--language` | Override auto-detected language | auto-detect |
+| `--config` | Path to `.agentchanti.yaml` config file | auto-discover |
+| `--auto` | Non-interactive mode (auto-approve plan) | off |
+| `--no-embeddings` | Disable semantic embeddings | off |
+| `--no-stream` | Disable streaming responses | off |
+| `--no-git` | Disable git checkpoint/rollback | off |
+| `--no-diff` | Disable diff preview before writing | off |
+| `--no-cache` | Disable step-level caching | off |
+| `--clear-cache` | Clear step cache before running | off |
+| `--no-knowledge` | Disable project knowledge base | off |
+| `--no-search` | Disable web search agent | off |
+| `--no-kb` | Disable KB context injection | off |
+| `--report` / `--no-report` | Enable/disable HTML report | on |
+| `--resume` | Force resume from checkpoint | off |
+| `--fresh` | Ignore checkpoint, start fresh | off |
+| `--generate-yaml` | Generate `.agentchanti.yaml` and exit | off |
+
+### Knowledge Base Commands
+
+Manage the project knowledge base via `agentchanti kb`:
+
+```bash
+agentchanti kb embed                 # Embed symbols into the vector store
+agentchanti kb search "query"        # Semantic search over KB
+agentchanti kb query find-callers X  # Find all callers of a function
+agentchanti kb error-lookup "msg"    # Look up error fixes
+agentchanti kb health                # Show KB health report
+agentchanti kb update                # Pull global KB updates
+```
+
+See [documentation.md](documentation.md) for the full list of KB commands.
+
+---
+
+## Documentation
+
+For full documentation including architecture details, configuration reference, library API, plugin system, and troubleshooting, see **[documentation.md](documentation.md)**.
+
+---
+
+## Contributing
+
+Contributions are welcome! Feel free to open issues or submit pull requests.
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/my-feature`)
+3. Run the tests: `python -m pytest tests/ -v`
+4. Commit and push
+5. Open a pull request
+
+---
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.
+
+---
+
+## Disclaimer
+
+> **This is a personal project by [Uday Kanth](https://github.com/udaykanthr).** It is not affiliated with, endorsed by, sponsored by, or in any way officially connected with my current or past employer(s), or any of their subsidiaries, clients, or affiliates. All opinions, code, and design decisions in this project are my own and do not represent the views or intellectual property of any organization I am or have been associated with. This project was built entirely on my own time using my own resources.