Metadata-Version: 2.4
Name: codemate-cli
Version: 1.0.1
Summary: AI-powered CLI assistant with rich streaming interface
Home-page: https://codemate.ai/
Author: Codemate.ai
Author-email: "Codemate.ai" <developers.codemate@gmail.com>
Project-URL: Homepage, https://codemate.ai/
Project-URL: Documentation, https://docs.codemate.ai/
Keywords: cli,ai,assistant,llm
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: rich>=13.7.0
Requires-Dist: click>=8.1.0
Requires-Dist: httpx>=0.25.0
Requires-Dist: pydantic>=2.5.0
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: prompt-toolkit>=3.0.43
Requires-Dist: pygments>=2.17.0
Requires-Dist: python-socketio>=5.8.0
Requires-Dist: aiohttp>=3.8.0
Provides-Extra: dev
Requires-Dist: pytest>=7.4.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
Requires-Dist: black>=23.0.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# 🚀 CodeMate CLI

CodeMate CLI is a premium AI-powered command-line assistant designed to provide high-performance, context-aware coding assistance directly in your terminal. It features a beautiful streaming interface, rich markdown rendering, and a powerful Knowledge Base system to index your codebase or documentation.

## ✨ Key Features

- 🧠 **Context-Aware AI** - Chat with an AI that understands your specific codebase and documentation.
- 📚 **Knowledge Base Management** - Create, index, and manage local codebase or web-based knowledge bases.
- 🎨 **Premium Terminal UI** - Enjoy a sleek interface with real-time markdown rendering and syntax highlighting.
- 🌊 **Streaming Responses** - Experience zero-latency with real-time response streaming.
- 🔐 **Secure Authentication** - Seamless web-based login with local session management.
- 🔧 **Automatic Service Handling** - Self-managing background services for optimal performance.

---

## 📦 Installation

Install the latest version of CodeMate CLI directly from PyPI:

```bash
pip install codemate-cli
```

---

## 🚀 Getting Started

### 1. Initial Setup
CodeMate CLI requires a one-time setup of its internal environment. 

### 2. Authentication
On your first run, the CLI will prompt you to authenticate:

1.  Run `codemate-cli`.
2.  Follow the provided link to `https://identity.codemate.ai/`.
3.  Login and copy your **Access Token**.
4.  Paste the token back into the terminal.

### 3. Start Chatting
Once authenticated, you will enter the interactive mode. Simply type your question:
```text
You ❯ Explain the authentication flow in this project.
```

---

## 📚 Knowledge Base (KB) Usage

The most powerful feature of CodeMate is its ability to understand your files.

### Creating a Knowledge Base
You can index a local directory or a set of documentation URLs:

1.  Type `/createkb` in the interactive session.
2.  Choose **Codebase** to index a local folder.
    - Provide the absolute path to your project.
    - The CLI will automatically respect your `.gitignore` and index relevant files.
3.  Choose **Docs** to index web-based documentation (provide URLs).

### Referencing a KB in Chat
Once a KB is created (e.g., named "my-api"), you can reference it using the `@` symbol:

```text
You ❯ How do I add a new route in @my-api?
```
The AI will use the indexed files from `my-api` as context to provide a precise answer.

---

## 🛠️ Command Reference

### Special Commands (Inside Interactive Mode)
| Command | Description |
| :--- | :--- |
| `/help` | Show the help menu with all available commands |
| `/listkb` | See all your indexed Knowledge Bases and their status |
| `/createkb` | Start the workflow to index a new codebase or documentation |
| `/deletekb` | Remove an existing Knowledge Base |
| `/clear` | Clear the current conversation history |
| `/logout` | Remove your session and log out |
| `exit` | Safely exit the CodeMate environment |




© 2026 CodeMate.AI. All rights reserved.
