codemate-cli 1.0.0__py3-none-any.whl

codemate/commands/help.py

@@ -0,0 +1,298 @@
+"""
+Help command implementation
+"""
+
+from rich.console import Console
+from rich.table import Table
+from rich.panel import Panel
+from rich.markdown import Markdown
+
+
+class HelpCommand:
+    """Handler for help commands"""
+    
+    def __init__(self, console: Console):
+        self.console = console
+    
+    def show_welcome(self):
+        """Display welcome message"""
+        welcome_text = """
+# Welcome to CodeMate CLI! 🎉
+
+Your intelligent coding assistant powered by advanced AI.
+
+## Quick Start
+
+1. **Configure your API key:**
+   ```bash
+   codemate config set-key YOUR_API_KEY
+   ```
+
+2. **Start chatting:**
+   ```bash
+   codemate chat "How do I create a REST API?"
+   ```
+
+3. **Interactive mode:**
+   ```bash
+   codemate interactive
+   ```
+
+Type `codemate --help` to see all available commands.
+        """
+        self.console.print(Markdown(welcome_text))
+    
+    def show_commands_table(self):
+        """Display commands in a table"""
+        table = Table(
+            title="Available Commands",
+            show_header=True,
+            header_style="bold magenta"
+        )
+        table.add_column("Command", style="cyan", width=20)
+        table.add_column("Description", style="white")
+        
+        commands = [
+            ("chat", "Send a one-off message to the AI"),
+            ("interactive", "Start an interactive chat session"),
+            ("config", "Manage configuration settings"),
+            ("models", "List available AI models"),
+            ("history", "View conversation history"),
+            ("clear", "Clear conversation history"),
+            ("--help", "Show help message"),
+            ("--version", "Show version information"),
+        ]
+        
+        for cmd, desc in commands:
+            table.add_row(cmd, desc)
+        
+        self.console.print(table)
+    
+    def show_chat_help(self):
+        """Show help for chat command"""
+        help_text = """
+## Chat Command
+
+Send a message to the AI assistant.
+
+### Usage
+
+```bash
+codemate chat "Your message here"
+```
+
+### Options
+
+- `--model, -m`: Specify the AI model to use
+- `--stream / --no-stream`: Enable/disable streaming responses
+
+### Examples
+
+**Basic chat:**
+```bash
+codemate chat "Explain async/await in Python"
+```
+
+**With specific model:**
+```bash
+codemate chat --model openai/gpt-4 "Write a binary search algorithm"
+```
+
+**Disable streaming:**
+```bash
+codemate chat --no-stream "Your question"
+```
+        """
+        self.console.print(Markdown(help_text))
+    
+    def show_interactive_help(self):
+        """Show help for interactive mode"""
+        help_text = """
+## Interactive Mode
+
+Start a persistent conversation with the AI.
+
+### Usage
+
+```bash
+codemate interactive
+```
+
+### Options
+
+- `--model, -m`: Specify the AI model to use
+
+### Special Commands
+
+While in interactive mode, you can use these commands:
+
+- `/exit` or `/quit`: Exit interactive mode
+- `/clear`: Clear conversation history
+- `/help`: Show this help message
+- `Ctrl+C`: Exit interactive mode
+
+### Example Session
+
+```bash
+$ codemate interactive
+
+[You] ❯ Write a function to calculate fibonacci numbers
+
+[AI] Here's a function to calculate fibonacci numbers...
+
+[You] ❯ Now add memoization
+
+[AI] Here's the optimized version with memoization...
+
+[You] ❯ /exit
+Goodbye! 👋
+```
+        """
+        self.console.print(Markdown(help_text))
+    
+    def show_config_help(self):
+        """Show help for config commands"""
+        help_text = """
+## Configuration Commands
+
+Manage CodeMate CLI settings.
+
+### Commands
+
+**Set API key:**
+```bash
+codemate config set-key YOUR_API_KEY
+```
+
+**View masked API key:**
+```bash
+codemate config get-key
+```
+
+**Set custom endpoint:**
+```bash
+codemate config set-endpoint http://localhost:45223
+```
+
+**View endpoint:**
+```bash
+codemate config get-endpoint
+```
+
+**Show all settings:**
+```bash
+codemate config show
+```
+
+**Reset to defaults:**
+```bash
+codemate config reset
+```
+
+### Configuration File
+
+Settings are stored in:
+- **macOS/Linux:** `~/.config/codemate/config.json`
+- **Windows:** `%APPDATA%\\CodeMate\\config.json`
+
+### Environment Variables
+
+You can also configure via environment variables:
+```bash
+export CODEMATE_API_KEY="your-api-key"
+export CODEMATE_ENDPOINT="http://localhost:45223"
+```
+        """
+        self.console.print(Markdown(help_text))
+    
+    def show_examples(self):
+        """Show usage examples"""
+        examples_text = """
+## Usage Examples
+
+### Code Generation
+
+```bash
+codemate chat "Write a Python function to calculate fibonacci numbers"
+```
+
+### Code Explanation
+
+```bash
+codemate chat "Explain this code: $(cat script.py)"
+```
+
+### Debugging Help
+
+```bash
+codemate chat "I'm getting this error: ImportError: No module named 'requests'"
+```
+
+### Interactive Coding Session
+
+```bash
+codemate interactive
+```
+
+Then ask follow-up questions:
+- "Now add error handling"
+- "How do I test this?"
+- "Refactor this to be more efficient"
+
+### Using Different Models
+
+```bash
+codemate chat -m openai/gpt-4 "Complex question requiring advanced reasoning"
+```
+        """
+        self.console.print(Markdown(examples_text))
+    
+    def show_troubleshooting(self):
+        """Show troubleshooting guide"""
+        troubleshooting_text = """
+## Troubleshooting
+
+### Connection Issues
+
+**Problem:** Cannot connect to API server
+
+**Solution:**
+1. Check if server is running: `curl http://localhost:45223`
+2. Verify endpoint: `codemate config show`
+3. Check network connectivity
+
+### Authentication Issues
+
+**Problem:** API key not working
+
+**Solution:**
+1. Verify key is set: `codemate config get-key`
+2. Check key is valid
+3. Try setting it again: `codemate config set-key YOUR_KEY`
+
+### Installation Issues
+
+**Problem:** Command not found
+
+**Solution:**
+1. Check installation: `pip show codemate-cli`
+2. Reinstall: `pip install --force-reinstall codemate-cli`
+3. Check PATH includes pip install location
+
+### Display Issues
+
+**Problem:** Colors or formatting not working
+
+**Solution:**
+1. Check terminal supports colors
+2. Try a different terminal
+3. Test rich: `python -m rich`
+
+### Getting Help
+
+If issues persist:
+1. Check GitHub issues
+2. Run with verbose mode: `codemate -v chat "test"`
+3. Report bugs with error details
+        """
+        self.console.print(Markdown(troubleshooting_text))