This documentation provides a comprehensive guide to installing, using, and developing DeepV Code. DeepV Code is an AI-powered coding assistant that brings advanced AI capabilities to your development workflow through both a command-line interface and VS Code extension.
DeepV Code is a monorepo project consisting of:
packages/cli: Command-line interface with interactive REPL environmentpackages/core: Core functionality library (AI client, tools, MCP, hooks, skills)packages/vscode-ui-plugin: Full-featured VS Code extension with webview UIpackages/vscode-ide-companion: Lightweight VS Code integration companion
The CLI and VS Code extension communicate with AI models through the core library, which manages requests, tool execution, context handling, and extensibility features.
- Deployment Guide - Installation, setup, and running DeepV Code
- Architecture Overview - High-level system design and component interactions
- Troubleshooting Guide - Common problems and solutions
- Uninstall Guide - How to remove DeepV Code
- CLI Introduction - Overview of the command-line interface
- Commands Reference - Available CLI commands
- Configuration - CLI configuration options
- Authentication - Authentication setup and management
- Themes - Terminal UI theming
- Tutorials - Step-by-step CLI guides
- Init Command - Project initialization
- MCP Add Command - Adding MCP servers
- Extensions Command - Managing CLI extensions
- Working Directory Paths - Handling paths with spaces
- Token Caching - Authentication token management
- Core Introduction - Overview of the core package
- Tools API - Tool system architecture and APIs
- Memport - Memory management port
- Tools Overview - Available tools and their purposes
- File System Tools -
read_file,write_fileoperations - Multi-File Read Tool -
read_many_filesfunctionality - Shell Tool -
run_shell_commandusage - Web Fetch Tool -
web_fetchfor HTTP requests - Web Search Tool -
google_web_searchintegration - Memory Tool -
save_memoryfor context persistence - MCP Server Tool - Model Context Protocol integration
- Refine Command - Code refinement utilities
- 🎯 START HERE: Hooks Overview - Main entry point for Hooks system
- Hooks Index - Complete Hooks documentation index
- Hooks User Guide - How to create and use hooks
- Hooks Examples - Ready-to-use hook scripts
- Hooks Implementation - Technical implementation details
- Hooks Architecture - System architecture and design
- Hooks Delivery Summary - Project delivery overview
- Hooks Implementation Summary - Implementation milestones
- Hooks Final Summary - Complete feature summary
- Hook Setup Instructions - End-user setup guide
- Skills Usage Guide - How to use and create skills
- MCP Async Loading - Asynchronous server loading
- MCP Sequential Startup - Server startup ordering
- MCP Status Display - Server status monitoring
- MCP Tools Sync Fix - Tool synchronization fixes
- MCP Response Guard - Response validation system
- MCP Response Guard Integration - Integration guide
- MCP Improvements Summary - Recent MCP enhancements
- Cloud Mode MCP Fix - Cloud deployment fixes
- LSP Usage Guide - LSP integration and usage
- Build Workflow - Build process and scripts
- NPM Workspaces - Monorepo package management
- NPM Publish Guide - Publishing packages to npm
- GitHub Actions Release - CI/CD release automation
- Integration Tests - End-to-end testing
- Environment Configuration - Environment setup
- Inline Completion Feature - AI-powered code suggestions
- Input Performance Optimization - Input handling improvements
- Input Width Optimization - Responsive input sizing
- Input Height Auto-Resize - Dynamic textarea resizing
- Footer Responsive Optimization - Footer layout improvements
- Small Window Optimization - Small screen adaptations
- Theme Dialog Optimization - Theme selector for small windows
- Long Text Display Optimization - Text rendering improvements
- Horizontal Confirmation Layout - Confirmation dialog layout
- Terminal Interaction Optimization - Terminal UX improvements
- Paste Text Handling - Clipboard integration
- VS Code Hotkey Conflicts - Hotkey conflict resolution
- Auth Lazy Refresh - Optimized token refresh strategy
- Token Refresh Threshold - Token refresh timing
- Custom Proxy Server Priority - Enterprise proxy configuration
- Cross-Platform Binary Fix - Multi-platform binary support
- SSH/WSL Compatibility - Remote development support
- Ubuntu Clipboard Support - Linux clipboard integration
- TSX/JSX File Type Support - React file handling
- Supported File Types - Complete file format support
- DTS Robust Detection - TypeScript declaration detection
- Background Tasks Quick Reference - Async task management
- Telemetry - Usage analytics and monitoring
- Startup Performance Summary - Performance metrics
- Checkpointing - Session state saving/restoration
- Extensions System - CLI extensibility framework
- Custom Rules Management - User-defined coding rules
- Empty Session Cleanup - Session lifecycle management
- Plan Mode Exit Notification - Plan mode UX
- Remote Server Analysis - Remote deployment analysis
- Sandbox - Sandboxed execution environment
- Terms of Service & Privacy - Legal terms and privacy policy
- Quota and Pricing - Usage limits and pricing
- Contributing Guide - How to contribute to DeepV Code
- Project Knowledge Base - Core project information for AI assistants
- Proxy Script Example - Custom proxy configuration example
- Rules Examples - Custom rules examples
This documentation is structured into logical sections:
- Getting Started - For new users and installation
- CLI - Command-line interface specifics
- Core - Core library internals
- Tools - Individual tool documentation
- Hooks - Enterprise hooks system (security & extensibility)
- Skills - Reusable AI workflows
- MCP - Model Context Protocol integration
- LSP - Language Server Protocol features
- Build - Development and deployment
- UI/UX - User interface optimizations
- Security - Authentication and security features
- Platform - Cross-platform compatibility
- Advanced - Advanced features and customization
- New to DeepV Code? Start with Deployment Guide
- CLI User? Check CLI Introduction and Commands
- VS Code User? See VS Code Extension Documentation
- Enterprise Admin? Read Hooks START HERE
- Developer/Contributor? See Contributing Guide and Architecture
- Need MCP Integration? Check MCP Documentation
- Troubleshooting? Visit Troubleshooting Guide
We hope this documentation helps you make the most of DeepV Code! 🚀