# CodeFlow CLI
A powerful, terminal-first AI coding assistant with **advanced agentic capabilities**. CodeFlow helps you read, explore, analyze, and improve your codebase with an enhanced chat UI, intelligent tools, and safe, confirmed edits.
## 🚀 Why CodeFlow?
- **Advanced Agent Mode**: Enhanced AI capabilities with intelligent tool orchestration
- **Stunning terminal UI** with rich colors, syntax-highlighting, and interactive panels
- **Three powerful modes** that fit any workflow:
- **Q&A Mode** (read-only): Ask questions about the codebase without making changes
- **Agent Mode** (write): Propose and apply changes with diff previews and confirmation
- **Advanced Agent** (enhanced): Smart tools, semantic search, code analysis, and intelligent automation
- **Smart codebase understanding**: Automatic project structure analysis and context awareness
- **Semantic search capabilities**: Find code by meaning, not just text matching
- **Advanced code analysis**: Structure analysis, complexity metrics, and issue detection
- **Tool execution tracking**: Monitor and manage all AI operations with full transparency
- **Enhanced file operations**: Read, edit, create, and delete files with intelligent assistance
- **Real-time collaboration**: Switch between modes seamlessly during chat sessions
## Install
```bash
pip install codeflow-cli
```
## Quick Start
```bash
codeflow
```
On start, pick a mode:
- **Q&A Mode** (`1` or `qna`) - Read-only questions about your codebase
- **Agent Mode** (`2` or `agent`) - Propose/apply improvements with confirmation
- **Advanced Agent** (`3` or `advanced`) - Enhanced AI with smart tools and analysis
Switch modes anytime during chat:
- `/qna` - Switch to Q&A mode
- `/agent` - Switch to Agent mode
- `/mode <mode_name>` - Switch to specified mode
## Configuration
Set your Groq API key one of the following ways:
```bash
# Recommended: environment variable
export GROQ_API_KEY="your-groq-api-key"
# Or interactively
codeflow configure
# Or via flag
codeflow --api-key "your-groq-api-key"
```
## 🛠️ Common Commands
### Universal Commands (All Modes)
- `/help` - Show mode-specific help and available commands
- `/model` - Change AI model with interactive selection
- `/clear` - Clear chat history
- `/exit` - Quit CodeFlow
### Q&A & Agent Mode Commands
- `/files` - List accessible files in workspace
- `/scan` - Rescan workspace for new files
- `/read <file>` - Read and preview a file with syntax highlighting
- `/workspace` - Show workspace information
### Agent Mode Commands
- `/edit <file1> [file2 ...]` - Propose/apply edits with diff preview and confirmation across multiple files
### 🚀 Advanced Agent Commands
- `/search <query>` - Semantic codebase search by meaning
- `/analyze <file>` - Analyze code structure, complexity, and quality
- `/read <file>` - Read file with enhanced analysis
- `/edit <file1> [file2 ...]` - Intelligent multi-file editing with AI assistance
- `/create <file1> [file2 ...]` - Create one or more files with AI assistance
- `/delete <file>` - Delete files with confirmation
- `/files` - List all accessible files with details
- `/scan` - Rescan workspace for new files
- `/workspace` - Show workspace information
- `/status` - Show comprehensive system status
- `/tools` - Display all available agentic tools
- `/context` - Show current workspace context
- `/history` - Show recent changes and operations
- `/shortcuts` - Show quick model switching shortcuts
### 🔄 Quick Model Switching
- `/fast`, `/balanced`, `/powerful`, `/ultra` - Quick model switches
- `/next`, `/prev` - Cycle through available models
### 🔀 Mode Switching (Available in all modes)
- `/qna` - Switch to Q&A mode (read-only analysis)
- `/agent` - Switch to Agent mode (file modifications)
- `/advanced` - Switch to Advanced Agent mode (enhanced AI capabilities)
## 📚 Examples
### Q&A Mode (Read-Only Analysis)
```bash
# Start CodeFlow and select Q&A mode
codeflow
> Select mode: 1 (Q&A Mode)
# Ask questions about your codebase
You: Where is the CLI entry point defined?
AI: The CLI entry point is defined in `groq_agent/cli.py`...
# Read and preview files
/read groq_agent/cli.py
# Switch to other modes anytime
/agent # Switch to Agent mode
/advanced # Switch to Advanced Agent mode
```
### Agent Mode (File Modifications)
```bash
# Switch to Agent mode
/agent
# Propose edits with diff preview
# Edit multiple files with shared context
/edit groq_agent/enhanced_chat.py groq_agent/agentic_chat.py
What changes? Improve the prompt styling and add a bottom toolbar.
# Shows diff, asks for confirmation before applying
# Switch to other modes anytime
/qna # Switch to Q&A mode
/advanced # Switch to Advanced Agent mode
```
### 🚀 Advanced Agent Mode
```bash
# Start with Advanced Agent mode
codeflow
> Select mode: 3 (Advanced Agent)
# Semantic search across codebase
/search "user authentication logic"
# Finds relevant code by meaning, not just keywords
# Analyze code structure and quality
/analyze groq_agent/api_client.py
# Shows metrics: complexity, structure, potential issues
# Get comprehensive system status
/status
# Shows workspace info, recent changes, tool usage
# Intelligent file editing with diff preview
/edit src/main.py tests/test_main.py
What changes? Add error handling for API calls and update tests accordingly
# AI shows diffs with green + for additions, red - for removals
# Natural language file modifications
"Add green color to website" → Modifies existing files with diff preview
"Change button style" → Shows changes with + and - indicators
# Intelligent minimal file creation
"Create a website for top schools in Delhi"
# AI automatically:
# 1. Determines ONLY the files needed (e.g., just index.html and styles.css)
# 2. Creates minimal file structure (no unnecessary README.md, etc.)
# 3. Generates content for each file
# 4. Shows preview of all files
# 5. Asks for your action (Accept/Reject/Review/Edit)
# Examples of intelligent file creation:
"Create a list of schools" → Creates only schools.json
"Make a simple website" → Creates only index.html
"Create a Python script" → Creates only main.py
# Command-line multi-file creation
/create src/main.py src/config.py src/utils.py
# AI automatically determines content for each file
# List and manage files
/files # List all accessible files
/scan # Rescan workspace for new files
/workspace # Show workspace information
# Switch to other modes anytime
/qna # Switch to Q&A mode
/agent # Switch to Agent mode
```
### Quick Model Switching
```bash
# Quick switches during any mode
/fast # Switch to fastest model
/powerful # Switch to most capable model
/next # Cycle to next model
/shortcuts # Show all quick commands
```
## Uninstall
```bash
pip uninstall codeflow-cli
```
## 🎯 Key Features
### 🤖 Advanced AI Capabilities
- **Semantic Understanding**: Search code by meaning, not just text
- **Context Awareness**: AI understands your project structure and recent changes
- **Smart File Creation**: Creates only the files you actually need (no unnecessary README.md, etc.)
- **Tool Orchestration**: Coordinate multiple operations intelligently
- **Change Tracking**: Monitor all modifications with full history
- **Quality Analysis**: Automated code structure and complexity analysis
### 🎨 Enhanced User Experience
- **Rich Terminal UI**: Beautiful panels, tables, and syntax highlighting
- **Interactive Model Selection**: Easy model switching with arrow key navigation
- **Command Auto-completion**: Intelligent slash command suggestions
- **Real-time Status**: Progress indicators and system status updates
- **Mode Flexibility**: Seamless switching between Q&A, Agent, and Agentic modes
### 🔧 Smart Development Tools
- **Project Structure Analysis**: Automatic detection of project type and architecture
- **File Operations**: Enhanced read, edit, create, and delete with AI assistance
- **Diff Previews**: Clear visualization of changes before applying
- **Workspace Awareness**: Intelligent file filtering and context building
- **Error Recovery**: Robust error handling with helpful suggestions
## 🚨 Troubleshooting
- **Command not found**: Ensure your Python scripts directory (e.g., `~/.local/bin` or `/opt/anaconda3/bin`) is on your PATH
- **API key issues**: Export `GROQ_API_KEY` or run `codeflow configure`
- **Model selection problems**: Try using arrow keys, Tab, or Enter in the model selector
- **Advanced Agent mode not available**: Update to the latest version with `pip install --upgrade codeflow-cli`
- **Publishing guidance** (maintainers): See `INSTALL.md`
## 📄 License
MIT License - Created by **TM NABEEL @tmnabeel30**
---
**CodeFlow CLI** - Bringing advanced AI capabilities to your terminal 🚀
Raw data
{
"_id": null,
"home_page": "https://github.com/your-username/codeflow-cli",
"name": "codeflow-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "ai, coding, assistant, cursor, agentic, semantic-search, code-analysis, terminal, cli, groq, llm, developer-tools",
"author": "Groq CLI Team",
"author_email": "TM NABEEL <tmnabeel30@example.com>",
"download_url": "https://files.pythonhosted.org/packages/de/68/307f6f9db52637cdf9a97f579e2d7042570caa52ccdabdded4fd577eb57d/codeflow-cli-0.1.5.tar.gz",
"platform": null,
"description": "# CodeFlow CLI\n\nA powerful, terminal-first AI coding assistant with **advanced agentic capabilities**. CodeFlow helps you read, explore, analyze, and improve your codebase with an enhanced chat UI, intelligent tools, and safe, confirmed edits.\n\n## \ud83d\ude80 Why CodeFlow?\n\n- **Advanced Agent Mode**: Enhanced AI capabilities with intelligent tool orchestration\n- **Stunning terminal UI** with rich colors, syntax-highlighting, and interactive panels\n- **Three powerful modes** that fit any workflow:\n - **Q&A Mode** (read-only): Ask questions about the codebase without making changes\n - **Agent Mode** (write): Propose and apply changes with diff previews and confirmation \n - **Advanced Agent** (enhanced): Smart tools, semantic search, code analysis, and intelligent automation\n- **Smart codebase understanding**: Automatic project structure analysis and context awareness\n- **Semantic search capabilities**: Find code by meaning, not just text matching\n- **Advanced code analysis**: Structure analysis, complexity metrics, and issue detection\n- **Tool execution tracking**: Monitor and manage all AI operations with full transparency\n- **Enhanced file operations**: Read, edit, create, and delete files with intelligent assistance\n- **Real-time collaboration**: Switch between modes seamlessly during chat sessions\n\n## Install\n\n```bash\npip install codeflow-cli\n```\n\n## Quick Start\n\n```bash\ncodeflow\n```\n\nOn start, pick a mode:\n- **Q&A Mode** (`1` or `qna`) - Read-only questions about your codebase\n- **Agent Mode** (`2` or `agent`) - Propose/apply improvements with confirmation\n- **Advanced Agent** (`3` or `advanced`) - Enhanced AI with smart tools and analysis\n\nSwitch modes anytime during chat:\n- `/qna` - Switch to Q&A mode\n- `/agent` - Switch to Agent mode\n- `/mode <mode_name>` - Switch to specified mode\n\n## Configuration\n\nSet your Groq API key one of the following ways:\n\n```bash\n# Recommended: environment variable\nexport GROQ_API_KEY=\"your-groq-api-key\"\n\n# Or interactively\ncodeflow configure\n\n# Or via flag\ncodeflow --api-key \"your-groq-api-key\"\n```\n\n## \ud83d\udee0\ufe0f Common Commands\n\n### Universal Commands (All Modes)\n- `/help` - Show mode-specific help and available commands\n- `/model` - Change AI model with interactive selection\n- `/clear` - Clear chat history\n- `/exit` - Quit CodeFlow\n\n### Q&A & Agent Mode Commands\n- `/files` - List accessible files in workspace\n- `/scan` - Rescan workspace for new files\n- `/read <file>` - Read and preview a file with syntax highlighting\n- `/workspace` - Show workspace information\n\n### Agent Mode Commands\n- `/edit <file1> [file2 ...]` - Propose/apply edits with diff preview and confirmation across multiple files\n\n### \ud83d\ude80 Advanced Agent Commands\n- `/search <query>` - Semantic codebase search by meaning\n- `/analyze <file>` - Analyze code structure, complexity, and quality\n- `/read <file>` - Read file with enhanced analysis\n- `/edit <file1> [file2 ...]` - Intelligent multi-file editing with AI assistance\n- `/create <file1> [file2 ...]` - Create one or more files with AI assistance\n- `/delete <file>` - Delete files with confirmation\n- `/files` - List all accessible files with details\n- `/scan` - Rescan workspace for new files\n- `/workspace` - Show workspace information\n- `/status` - Show comprehensive system status\n- `/tools` - Display all available agentic tools\n- `/context` - Show current workspace context\n- `/history` - Show recent changes and operations\n- `/shortcuts` - Show quick model switching shortcuts\n\n### \ud83d\udd04 Quick Model Switching\n- `/fast`, `/balanced`, `/powerful`, `/ultra` - Quick model switches\n- `/next`, `/prev` - Cycle through available models\n\n### \ud83d\udd00 Mode Switching (Available in all modes)\n- `/qna` - Switch to Q&A mode (read-only analysis)\n- `/agent` - Switch to Agent mode (file modifications)\n- `/advanced` - Switch to Advanced Agent mode (enhanced AI capabilities)\n\n## \ud83d\udcda Examples\n\n### Q&A Mode (Read-Only Analysis)\n```bash\n# Start CodeFlow and select Q&A mode\ncodeflow\n> Select mode: 1 (Q&A Mode)\n\n# Ask questions about your codebase\nYou: Where is the CLI entry point defined?\nAI: The CLI entry point is defined in `groq_agent/cli.py`...\n\n# Read and preview files\n/read groq_agent/cli.py\n\n# Switch to other modes anytime\n/agent # Switch to Agent mode\n/advanced # Switch to Advanced Agent mode\n```\n\n### Agent Mode (File Modifications)\n```bash\n# Switch to Agent mode\n/agent\n\n# Propose edits with diff preview\n# Edit multiple files with shared context\n/edit groq_agent/enhanced_chat.py groq_agent/agentic_chat.py\nWhat changes? Improve the prompt styling and add a bottom toolbar.\n# Shows diff, asks for confirmation before applying\n\n# Switch to other modes anytime\n/qna # Switch to Q&A mode\n/advanced # Switch to Advanced Agent mode\n```\n\n### \ud83d\ude80 Advanced Agent Mode\n```bash\n# Start with Advanced Agent mode\ncodeflow\n> Select mode: 3 (Advanced Agent)\n\n# Semantic search across codebase\n/search \"user authentication logic\"\n# Finds relevant code by meaning, not just keywords\n\n# Analyze code structure and quality\n/analyze groq_agent/api_client.py\n# Shows metrics: complexity, structure, potential issues\n\n# Get comprehensive system status\n/status\n# Shows workspace info, recent changes, tool usage\n\n# Intelligent file editing with diff preview\n/edit src/main.py tests/test_main.py\nWhat changes? Add error handling for API calls and update tests accordingly\n# AI shows diffs with green + for additions, red - for removals\n\n# Natural language file modifications\n\"Add green color to website\" \u2192 Modifies existing files with diff preview\n\"Change button style\" \u2192 Shows changes with + and - indicators\n\n# Intelligent minimal file creation\n\"Create a website for top schools in Delhi\"\n# AI automatically:\n# 1. Determines ONLY the files needed (e.g., just index.html and styles.css)\n# 2. Creates minimal file structure (no unnecessary README.md, etc.)\n# 3. Generates content for each file\n# 4. Shows preview of all files\n# 5. Asks for your action (Accept/Reject/Review/Edit)\n\n# Examples of intelligent file creation:\n\"Create a list of schools\" \u2192 Creates only schools.json\n\"Make a simple website\" \u2192 Creates only index.html\n\"Create a Python script\" \u2192 Creates only main.py\n\n# Command-line multi-file creation\n/create src/main.py src/config.py src/utils.py\n# AI automatically determines content for each file\n\n# List and manage files\n/files # List all accessible files\n/scan # Rescan workspace for new files\n/workspace # Show workspace information\n\n# Switch to other modes anytime\n/qna # Switch to Q&A mode\n/agent # Switch to Agent mode\n```\n\n### Quick Model Switching\n```bash\n# Quick switches during any mode\n/fast # Switch to fastest model\n/powerful # Switch to most capable model\n/next # Cycle to next model\n/shortcuts # Show all quick commands\n```\n\n## Uninstall\n\n```bash\npip uninstall codeflow-cli\n```\n\n## \ud83c\udfaf Key Features\n\n### \ud83e\udd16 Advanced AI Capabilities\n- **Semantic Understanding**: Search code by meaning, not just text\n- **Context Awareness**: AI understands your project structure and recent changes\n- **Smart File Creation**: Creates only the files you actually need (no unnecessary README.md, etc.)\n- **Tool Orchestration**: Coordinate multiple operations intelligently\n- **Change Tracking**: Monitor all modifications with full history\n- **Quality Analysis**: Automated code structure and complexity analysis\n\n### \ud83c\udfa8 Enhanced User Experience\n- **Rich Terminal UI**: Beautiful panels, tables, and syntax highlighting\n- **Interactive Model Selection**: Easy model switching with arrow key navigation\n- **Command Auto-completion**: Intelligent slash command suggestions\n- **Real-time Status**: Progress indicators and system status updates\n- **Mode Flexibility**: Seamless switching between Q&A, Agent, and Agentic modes\n\n### \ud83d\udd27 Smart Development Tools\n- **Project Structure Analysis**: Automatic detection of project type and architecture\n- **File Operations**: Enhanced read, edit, create, and delete with AI assistance\n- **Diff Previews**: Clear visualization of changes before applying\n- **Workspace Awareness**: Intelligent file filtering and context building\n- **Error Recovery**: Robust error handling with helpful suggestions\n\n## \ud83d\udea8 Troubleshooting\n\n- **Command not found**: Ensure your Python scripts directory (e.g., `~/.local/bin` or `/opt/anaconda3/bin`) is on your PATH\n- **API key issues**: Export `GROQ_API_KEY` or run `codeflow configure`\n- **Model selection problems**: Try using arrow keys, Tab, or Enter in the model selector\n- **Advanced Agent mode not available**: Update to the latest version with `pip install --upgrade codeflow-cli`\n- **Publishing guidance** (maintainers): See `INSTALL.md`\n\n## \ud83d\udcc4 License\n\nMIT License - Created by **TM NABEEL @tmnabeel30**\n\n---\n\n**CodeFlow CLI** - Bringing advanced AI capabilities to your terminal \ud83d\ude80\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Advanced AI coding assistant with Cursor AI-style agentic capabilities, semantic search, and intelligent code operations",
"version": "0.1.5",
"project_urls": {
"Homepage": "https://github.com/your-username/codeflow-cli"
},
"split_keywords": [
"ai",
" coding",
" assistant",
" cursor",
" agentic",
" semantic-search",
" code-analysis",
" terminal",
" cli",
" groq",
" llm",
" developer-tools"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ef4f9b40af16e34a27a60d01e328d7d4b9c4ea97f46d9309ae5cfc1af020e17a",
"md5": "a8fe1e961f48cd3c029146138791865b",
"sha256": "fa45fa437773e45969c66575a3e2f7024f4e4272539af0f6bac4638a65ce30e6"
},
"downloads": -1,
"filename": "codeflow_cli-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a8fe1e961f48cd3c029146138791865b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 84507,
"upload_time": "2025-08-21T10:43:57",
"upload_time_iso_8601": "2025-08-21T10:43:57.782017Z",
"url": "https://files.pythonhosted.org/packages/ef/4f/9b40af16e34a27a60d01e328d7d4b9c4ea97f46d9309ae5cfc1af020e17a/codeflow_cli-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "de68307f6f9db52637cdf9a97f579e2d7042570caa52ccdabdded4fd577eb57d",
"md5": "9b792a55aabdab83dba983fa3f57b18e",
"sha256": "c3a385183a7b806da15531c11339ab5ff257011798d9f167a26405e757e5776f"
},
"downloads": -1,
"filename": "codeflow-cli-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "9b792a55aabdab83dba983fa3f57b18e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 78102,
"upload_time": "2025-08-21T10:44:00",
"upload_time_iso_8601": "2025-08-21T10:44:00.069457Z",
"url": "https://files.pythonhosted.org/packages/de/68/307f6f9db52637cdf9a97f579e2d7042570caa52ccdabdded4fd577eb57d/codeflow-cli-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-21 10:44:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "your-username",
"github_project": "codeflow-cli",
"github_not_found": true,
"lcname": "codeflow-cli"
}
JSON
