AI-powered CLI assistant with rich streaming interface
Project description
🚀 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:
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:
- Run
codemate-cli. - Follow the provided link to
https://identity.codemate.ai/. - Login and copy your Access Token.
- Paste the token back into the terminal.
3. Start Chatting
Once authenticated, you will enter the interactive mode. Simply type your question:
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:
- Type
/createkbin the interactive session. - Choose Codebase to index a local folder.
- Provide the absolute path to your project.
- The CLI will automatically respect your
.gitignoreand index relevant files.
- 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:
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file codemate_cli-1.0.1.tar.gz.
File metadata
- Download URL: codemate_cli-1.0.1.tar.gz
- Upload date:
- Size: 38.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
74db73dfbfd6886d0090f88a3bc58f78546da460657b4878f3283080bceecbf5
|
|
| MD5 |
05e9b5516804acd2a10db6d85eb67045
|
|
| BLAKE2b-256 |
88908ee2daad93cdd8ab6d5edb9ab0b62e83b4c1d03db259087b81033ecf6021
|
File details
Details for the file codemate_cli-1.0.1-py3-none-any.whl.
File metadata
- Download URL: codemate_cli-1.0.1-py3-none-any.whl
- Upload date:
- Size: 42.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b542df6afa9e05bbccf1d55398f6adc10d68b53b271a58695330219504e0af10
|
|
| MD5 |
3ac3df10a8978b92d78f8b37a386ce95
|
|
| BLAKE2b-256 |
b0709877a15b5c319923cb7d785dcbeafa4059cee073a3d2b78f73cd8e6595de
|