A Python-based CLI AI coding agent that provides agentic development capabilities with multi-provider AI support and real-time interaction
Project description
Cognautic CLI
A Python-based CLI AI coding agent that provides agentic development capabilities with multi-provider AI support and real-time interaction.
⚠️ Under Development - Some features may be unavailable
Overview
Cognautic CLI is a Python-based command-line interface that brings AI-powered development capabilities directly to your terminal. It provides agentic tools for file operations, command execution, web search, and code analysis with support for multiple AI providers. The tool is accessed through a single cognautic command with various subcommands.
⚠️ Development Notice: Cognautic CLI is currently under development. Some features may be unavailable or subject to change.
Project Information
| Property | Value |
|---|---|
| Developer | cognautic |
| Written in | Python |
| Operating system | Cross-platform |
| Type | AI Development Tool |
| Status | Under Development |
| Repository | github.com/cognautic/cli |
Features
- Multi-Provider AI Support: Integrate with OpenAI, Anthropic, Google, Together AI, OpenRouter, and 15+ other AI providers
- Local Model Support: Run free open-source Hugging Face models locally without API keys (NEW! 🎉)
- Agentic Tools: File operations, command execution, web search, and code analysis
- Intelligent Web Search: Automatically searches the web when implementing features requiring current/external information (NEW! 🔍)
- Real-time Communication: WebSocket server for live AI responses and tool execution
- Secure Configuration: Encrypted API key storage and permission management
- Interactive CLI: Rich terminal interface with progress indicators, colored output, and command history
Installation
Prerequisites
Ensure you have Python 3.8 or higher installed:
python --version
Download the Wheel File
Download the latest .whl file from the official repository:
# Visit https://github.com/cognautic/cli/releases
# Download the latest cognautic_cli-z.z.z-py3-none-any.whl file
Installation with pip
Install the downloaded wheel file using pip:
# Navigate to your downloads folder
cd ~/Downloads
# Install the wheel file
pip install cognautic_cli-z.z.z-py3-none-any.whl
Installation with pipx (Recommended)
For isolated installation, use pipx:
# Install pipx if you don't have it
pip install pipx
pipx ensurepath
# Install Cognautic CLI with pipx
pipx install cognautic_cli-z.z.z-py3-none-any.whl
Verify Installation
Check that Cognautic CLI is installed correctly:
cognautic --version
Updating Cognautic CLI
To update to a newer version, download the new wheel file and:
# With pip (force reinstall)
pip install cognautic_cli-y.y.y-py3-none-any.whl --force-reinstall
# With pipx
pipx upgrade cognautic-cli
# Or force reinstall with pipx
pipx install cognautic_cli-y.y.y-py3-none-any.whl --force
Note: Replace y.y.y and z.z.z with actual version numbers (e.g., 1.0.0, 1.1.0).
Uninstallation
To remove Cognautic CLI:
# With pip
pip uninstall cognautic-cli
# With pipx
pipx uninstall cognautic-cli
Quick Start
Step 1: Install Cognautic CLI
pip install cognautic_cli-x.x.x-py3-none-any.whl
Step 2: Run Setup
cognautic setup --interactive
This will guide you through:
- Configuring API keys for your preferred AI providers
- Setting default provider and model
- Basic preferences
Step 3: Start Chatting
cognautic chat
Now you can chat with AI and use slash commands like:
/help- Show available commands/provider openai- Switch AI provider/model gpt-4- Change model/workspace ~/myproject- Set working directory/lmodel microsoft/phi-2- Load local model
That's it! Start chatting and let the AI help you code.
Available Slash Commands
Once you're in chat mode (cognautic chat), use these commands:
Workspace & Configuration
/workspace <path> # Change working directory (alias: /ws)
/setup # Run interactive setup wizard
/config list # Show current configuration
/config set <key> <value> # Set configuration value
/help # Show all available commands
AI Provider & Model Management
/provider [name] # Switch AI provider (openai, anthropic, google, etc.)
/model [model_id] # Switch AI model
/model list # Fetch available models from provider's API
/lmodel <path> # Load local Hugging Face model
/lmodel unload # Unload current local model
Session Management
/session # Show current session info
/session list # List all sessions
/session new # Create new session
/session load <id> # Load existing session
/session delete <id> # Delete session
/session title <text> # Update session title
Display & Interface
/speed [instant|fast|normal|slow] # Set typing speed
/clear # Clear chat screen
/exit or /quit # Exit chat session
Command-Line Usage
Cognautic CLI provides these main commands:
Setup Command
cognautic setup --interactive # Interactive setup wizard
cognautic setup --provider openai # Quick provider setup
Chat Command
cognautic chat # Start interactive chat
cognautic chat --provider anthropic # Chat with specific provider
cognautic chat --model claude-3-sonnet # Chat with specific model
cognautic chat --project-path ./my_project # Set workspace
cognautic chat --session <id> # Continue existing session
Config Command
cognautic config list # Show all configuration
cognautic config set <key> <value> # Set configuration value
cognautic config get <key> # Get configuration value
cognautic config delete <key> # Delete configuration key
cognautic config reset # Reset to defaults
Providers Command
cognautic providers # List all AI providers and endpoints
Supported AI Providers
| Provider | Models | API Key Required |
|---|---|---|
| OpenAI | GPT models (GPT-4, GPT-3.5) | OPENAI_API_KEY |
| Anthropic | Claude models (Claude-3 Sonnet, Haiku) | ANTHROPIC_API_KEY |
| Gemini models | GOOGLE_API_KEY |
|
| Together AI | Various open-source models | TOGETHER_API_KEY |
| OpenRouter | Access to multiple providers | OPENROUTER_API_KEY |
| Local Models | Hugging Face models (Llama, Mistral, Phi, etc.) | ❌ No API key needed! |
Using Local Models (NEW! 🎉)
Run free open-source AI models locally without any API keys:
# Install dependencies
pip install transformers torch accelerate
# Start chat and load a local model
cognautic chat
/lmodel microsoft/phi-2
/provider local
# Now chat with your local model!
Popular local models:
microsoft/phi-2- Small and fast (2.7B)TinyLlama/TinyLlama-1.1B-Chat-v1.0- Ultra lightweight (1.1B)meta-llama/Llama-2-7b-chat-hf- High quality (7B)mistralai/Mistral-7B-Instruct-v0.2- Excellent performance (7B)
Benefits:
- ✅ Complete privacy - no data sent externally
- ✅ No API costs
- ✅ Works offline
- ✅ Full control over model behavior
📖 Read the full Local Models Guide →
Intelligent Web Search (NEW! 🔍)
Cognautic CLI now features intelligent web search that automatically researches information when needed. The AI will search the web when:
- Implementing APIs: "Implement Stripe payment integration"
- Using Latest Libraries: "Create a React app with TailwindCSS"
- Research Requests: "What's the best way to implement real-time chat?"
- Current Best Practices: "Build a modern authentication system"
Example Usage
You: Implement OpenAI API in my Python project
AI: 🔍 Searching for latest OpenAI API documentation...
✅ Found: OpenAI API Reference
📝 Creating implementation with current best practices...
[Creates files with up-to-date API usage]
When Web Search is Used
✅ Automatically triggered for:
- Latest API documentation
- Current framework/library versions
- Modern best practices
- Technologies requiring external information
❌ Not used for:
- Basic programming concepts
- Simple file operations
- General coding tasks
📖 Read the full Web Search Guide → | Quick Reference →
Configuration
Configuration files are stored in ~/.cognautic/:
config.json: General settings and preferencesapi_keys.json: Encrypted API keys for AI providerssessions/: Chat session history and contextcache/: Temporary files and model cache
Command Usage
All Cognautic CLI functionality is accessed through the single cognautic command. The general syntax is:
cognautic <subcommand> [options] [arguments]
Getting Help
# Show general help
cognautic --help
# Show help for specific command
cognautic chat --help
Version Information
cognautic --version
WebSocket Server & Real-time Streaming
Cognautic CLI includes a powerful WebSocket server that enables real-time, streaming AI responses. Instead of waiting for the complete response, you receive AI-generated content as it's being produced, providing a much more interactive experience.
Starting the WebSocket Server
The WebSocket server starts automatically when you run chat mode:
# Start with default settings (port 8765)
cognautic chat
# Specify custom port
cognautic chat --websocket-port 9000
# With specific provider and model
cognautic chat --provider openai --model gpt-4o-mini --websocket-port 8765
Key Features
- ✨ Real-time Streaming: AI responses stream chunk-by-chunk as they're generated
- 🔄 Bi-directional: Full duplex WebSocket communication
- 🔐 Session Management: Automatic session creation and context preservation
- 🤖 Multi-provider: Works with all supported AI providers
- 🛠️ Tool Execution: Execute tools and file operations via WebSocket
Client Examples
Python Client:
python examples/websocket_client_example.py
# Interactive mode
python examples/websocket_client_example.py interactive
Web Browser:
# Open in your browser
open examples/websocket_client.html
Basic Usage Example
import asyncio
import json
import websockets
async def chat():
uri = "ws://localhost:8765"
async with websockets.connect(uri) as ws:
# Receive welcome message
welcome = json.loads(await ws.recv())
print(f"Connected! Session: {welcome['session_id']}")
# Send chat message with streaming enabled
await ws.send(json.dumps({
"type": "chat",
"message": "Explain Python async/await",
"stream": true
}))
# Receive streaming response in real-time
while True:
response = json.loads(await ws.recv())
if response['type'] == 'stream_chunk':
print(response['chunk'], end='', flush=True)
elif response['type'] == 'stream_end':
break
asyncio.run(chat())
API Documentation
For complete WebSocket API documentation, see WEBSOCKET_API.md.
Examples
Simple Chat Session
Start chatting with AI:
$ cognautic chat
██████╗ ██████╗ ██████╗ ███╗ ██╗ █████╗ ██╗ ██╗████████╗██╗ ██████╗
██╔════╝██╔═══██╗██╔════╝ ████╗ ██║██╔══██╗██║ ██║╚══██╔══╝██║██╔════╝
██║ ██║ ██║██║ ███╗██╔██╗ ██║███████║██║ ██║ ██║ ██║██║
██║ ██║ ██║██║ ██║██║╚██╗██║██╔══██║██║ ██║ ██║ ██║██║
╚██████╗╚██████╔╝╚██████╔╝██║ ╚████║██║ ██║╚██████╔╝ ██║ ██║╚██████╗
╚═════╝ ╚═════╝ ╚═════╝ ╚═╝ ╚═══╝╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝
💡 Type '/help' for commands, 'exit' to quit
🌐 WebSocket server: ws://localhost:8765
📁 Workspace: /home/user/projects
--------------------------------------------------
You [projects]: Can you help me create a Python function?
AI: Of course! I'd be happy to help you create a Python function...
You [projects]: /workspace ~/myproject
✅ Workspace changed to: /home/user/myproject
You [myproject]: Create a file called utils.py with helper functions
AI: I'll create that file for you...
First-Time Setup
$ cognautic
🎉 Welcome to Cognautic! Let's get you set up.
🔑 No API keys found. Let's configure them.
Which AI provider would you like to use?
1. OpenAI (GPT-4, GPT-3.5)
2. Anthropic (Claude)
3. Google (Gemini)
4. Other providers...
Choice [1-4]: 2
🔐 Please enter your Anthropic API key: sk-ant-...
✅ API key saved securely!
🚀 Setup complete! You're ready to go.
Using Local Models
Run AI models locally without API keys:
$ cognautic chat
You: /lmodel microsoft/phi-2
🔄 Loading local model from: microsoft/phi-2
⏳ This may take a few minutes depending on model size...
Loading local model from microsoft/phi-2 on cuda...
✅ Model loaded successfully on cuda
✅ Local model loaded successfully!
💡 Use: /provider local - to switch to the local model
You: /provider local
✅ Switched to provider: local
You: Hello! Can you help me code?
AI: Hello! Yes, I'd be happy to help you with coding...
Working with Multiple Providers
Switch between different AI providers:
You: /provider openai
✅ Switched to provider: openai
You: /model gpt-4o
✅ Switched to model: gpt-4o
You: Write a Python function to sort a list
AI: Here's a Python function...
You: /provider anthropic
✅ Switched to provider: anthropic
You: /model claude-3-sonnet-20240229
✅ Switched to model: claude-3-sonnet-20240229
License
Proprietary - All Rights Reserved
© 2024 cognautic
For licensing inquiries, contact: cognautic@gmail.com
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 cognautic_cli-1.1.0.tar.gz.
File metadata
- Download URL: cognautic_cli-1.1.0.tar.gz
- Upload date:
- Size: 72.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8c29d886abaf0bb725dd99f9ea2ffd1891551eab1b672ee36fb347574da15acd
|
|
| MD5 |
6a39837f6c03472903e2c120f752f396
|
|
| BLAKE2b-256 |
baafc83f3bdf1ee77c0c4b878ebd65abdc8b23d88d0b23dc8d22d46b91f05c4a
|
File details
Details for the file cognautic_cli-1.1.0-py3-none-any.whl.
File metadata
- Download URL: cognautic_cli-1.1.0-py3-none-any.whl
- Upload date:
- Size: 72.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8eca3ae07930594ca3f4779bfede727f020a1e9d0e03f5983dbe95d164225955
|
|
| MD5 |
3ed4cbe0a2ddd877df575270599b290d
|
|
| BLAKE2b-256 |
17c92d250595b9fa86aaec6f1a8a21bf3c7677b7a9ee07d90fb10ae2b2a1e451
|