cognautic-cli 1.0.0__tar.gz

cognautic_cli-1.0.0/LICENSE

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

cognautic_cli-1.0.0/PKG-INFO

@@ -0,0 +1,560 @@
+Metadata-Version: 2.4
+Name: cognautic-cli
+Version: 1.0.0
+Summary: A Python-based CLI AI coding agent that provides agentic development capabilities with multi-provider AI support and real-time interaction
+Home-page: https://github.com/cognautic/cli
+Author: Cognautic
+Author-email: Cognautic <cognautic@gmail.com>
+Maintainer-email: Cognautic <cognautic@gmail.com>
+License: Proprietary - All Rights Reserved
+Project-URL: Homepage, https://github.com/cognautic/cli
+Project-URL: Documentation, https://cognautic.vercel.app/cognautic-cli.html
+Project-URL: Repository, https://github.com/cognautic/cli.git
+Project-URL: Issues, https://github.com/cognautic/cli/issues
+Project-URL: Changelog, https://github.com/cognautic/cognautic-cli/blob/main/CHANGELOG.md
+Keywords: ai,cli,coding,assistant,development,automation
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+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
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0.0
+Requires-Dist: websockets>=10.0
+Requires-Dist: aiohttp>=3.8.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: requests>=2.28.0
+Requires-Dist: beautifulsoup4>=4.11.0
+Requires-Dist: psutil>=5.9.0
+Requires-Dist: cryptography>=3.4.0
+Requires-Dist: keyring>=23.0.0
+Requires-Dist: openai>=1.0.0
+Requires-Dist: anthropic>=0.7.0
+Requires-Dist: google-generativeai>=0.3.0
+Requires-Dist: together>=0.2.0
+Requires-Dist: nest-asyncio>=1.5.0
+Provides-Extra: tools
+Requires-Dist: gitpython>=3.1.0; extra == "tools"
+Requires-Dist: pyyaml>=6.0; extra == "tools"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: flake8>=5.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: coverage>=6.0.0; extra == "dev"
+Provides-Extra: all
+Requires-Dist: cognautic-cli[dev,tools]; extra == "all"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# 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](https://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
+- **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:
+
+```bash
+python --version
+```
+
+### Download the Wheel File
+
+Download the latest `.whl` file from the official repository:
+
+```bash
+# 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:
+
+```bash
+# 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:
+
+```bash
+# 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:
+
+```bash
+cognautic --version
+```
+
+### Updating Cognautic CLI
+
+To update to a newer version, download the new wheel file and:
+
+```bash
+# 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.2.0, 2.1.5)._
+
+### Uninstallation
+
+To remove Cognautic CLI:
+
+```bash
+# With pip
+pip uninstall cognautic-cli
+
+# With pipx
+pipx uninstall cognautic-cli
+```
+
+---
+
+## Quick Start
+
+### Step 1: Install Cognautic CLI
+
+```bash
+pip install cognautic_cli-x.x.x-py3-none-any.whl
+```
+
+### Step 2: Run Setup
+
+```bash
+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
+
+```bash
+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
+
+```bash
+/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
+
+```bash
+/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
+
+```bash
+/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
+
+```bash
+/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
+
+```bash
+cognautic setup --interactive           # Interactive setup wizard
+cognautic setup --provider openai       # Quick provider setup
+```
+
+### Chat Command
+
+```bash
+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
+
+```bash
+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
+
+```bash
+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` |
+| **Google** | 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:
+
+```bash
+# 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 →](LOCAL_MODELS.md)**
+
+---
+
+## Configuration
+
+Configuration files are stored in `~/.cognautic/`:
+
+- `config.json`: General settings and preferences
+- `api_keys.json`: Encrypted API keys for AI providers
+- `sessions/`: Chat session history and context
+- `cache/`: Temporary files and model cache
+
+---
+
+## Command Usage
+
+All Cognautic CLI functionality is accessed through the single `cognautic` command. The general syntax is:
+
+```bash
+cognautic <subcommand> [options] [arguments]
+```
+
+### Getting Help
+
+```bash
+# Show general help
+cognautic --help
+
+# Show help for specific command
+cognautic chat --help
+```
+
+### Version Information
+
+```bash
+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:
+
+```bash
+# 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:**
+```bash
+python examples/websocket_client_example.py
+
+# Interactive mode
+python examples/websocket_client_example.py interactive
+```
+
+**Web Browser:**
+```bash
+# Open in your browser
+open examples/websocket_client.html
+```
+
+### Basic Usage Example
+
+```python
+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](WEBSOCKET_API.md)**.
+
+---
+
+## Examples
+
+### Simple Chat Session
+
+Start chatting with AI:
+
+```bash
+$ 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
+
+```bash
+$ 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:
+
+```bash
+$ 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:
+
+```bash
+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
+MIT