Skip to content

README_EN.md

Latest commit

 

History

History
313 lines (224 loc) · 9.27 KB

README_EN.md

File metadata and controls

313 lines (224 loc) · 9.27 KB

🚀 DeepV Code

AI-Powered Intelligent Software Engineering Assistant

License Node.js TypeScript VS Code

English | 简体中文

DeepV Code Demo

✨ Introduction

DeepV Code is a revolutionary AI-powered intelligent software engineering assistant that deeply integrates artificial intelligence technology to comprehensively enhance software development efficiency, quality, and innovation.

Unlike traditional code completion tools, DeepV Code is an intelligent agent capable of understanding the entire project context and autonomously orchestrating tools to complete complex tasks, freeing developers from tedious, repetitive work to focus on higher-level innovation and problem-solving.

🎯 Key Features

Feature Description
🧠 AI Code Generation Generate complete functions, classes, or modules from natural language descriptions
🔍 Intelligent Debugging Deeply analyze error logs, quickly locate root causes, and auto-fix issues
📦 MCP Context Management Build comprehensive awareness of project structure, dependencies, and code semantics
🛠️ Extensible Tool System Built-in Shell, File System, Web Fetch tools with custom extension support
🎨 Multi-Mode Interaction CLI command line + VS Code plugin for different use cases
🔄 Session Management Support session save, restore, and history compression
🪝 Hooks Mechanism Inject custom logic at key workflow nodes for automated task orchestration

📦 Quick Installation

Option 1: npm Global Install (Recommended)

npm install -g deepv-code

Or using yarn / pnpm:

yarn global add deepv-code
# or
pnpm add -g deepv-code

Option 2: Build from Source

# Clone repository
git clone https://github.com/OrionStarAI/DeepVCode.git
cd DeepVCode

# Install dependencies
npm install

# Build project
npm run build

# Run locally
npm run dev

### 🌐 Using Open Source Server (Self-hosted)

If you want to deploy the DeepV Code server locally or in a private environment, you can use our open-source version:

**Open Source Server:** [DeepVCode-Server-mini](https://github.com/OrionStarAI/DeepVCode-Server-mini)

To start the CLI and connect to your local server:

```bash
# Set server URL and start
cross-env DEEPX_SERVER_URL=http://localhost:8000 npm run start

🚀 Quick Start

After installation, start in any project directory:

dvcode

Basic Usage Examples

# Start interactive session
dvcode

# Use specific model
dvcode -m gemini-2.0-flash

# Execute single prompt (non-interactive mode)
dvcode -p "Explain the architecture of this project"

# Continue last session
dvcode -c

# Enable YOLO mode (auto-execute all operations)
dvcode -y

Slash Commands

Use slash commands in interactive mode for quick common tasks:

Command Description
/help Display help information
/model Switch AI model
/session Session management (list/new/select)
/mcp MCP server management
/plan Toggle plan mode (disable code modifications)
/yolo Toggle YOLO mode
/tools View available tools
/memory Long-term memory management
/compress Compress conversation history
/restore Restore file checkpoint
/quit Exit application

🏗️ Project Architecture

DeepVCode/
├── packages/
│   ├── cli/                    # Command Line Interface
│   │   ├── src/
│   │   │   ├── commands/       # Slash command implementations
│   │   │   ├── ui/             # Terminal UI components (React Ink)
│   │   │   ├── services/       # Service layer
│   │   │   └── utils/          # Utility functions
│   │   └── package.json
│   │
│   ├── core/                   # Core Library
│   │   ├── src/
│   │   │   ├── tools/          # AI tools (shell, file, web...)
│   │   │   ├── mcp/            # MCP engine
│   │   │   ├── prompts/        # Prompt template management
│   │   │   ├── auth/           # Authentication module
│   │   │   ├── hooks/          # Hooks system
│   │   │   └── skills/         # Skills extension system
│   │   └── package.json
│   │
│   ├── vscode-ide-companion/   # VS Code Lightweight Companion Extension
│   │   └── package.json
│   │
│   └── vscode-ui-plugin/       # VS Code Full UI Plugin
│       ├── src/                # Extension source code
│       ├── webview/            # Webview frontend
│       └── package.json
│
├── docs/                       # Documentation
├── scripts/                    # Build and utility scripts
├── package.json                # Root config (Monorepo)
└── README.md

Tech Stack

  • Language: TypeScript
  • Runtime: Node.js 20+
  • CLI UI: React (Ink)
  • Build Tool: esbuild
  • Testing: Vitest
  • Code Style: ESLint + Prettier

🔌 VS Code Extensions

DeepV Code provides two VS Code extensions for enhanced IDE integration:

IDE Companion

Connects VS Code with CLI running in the integrated terminal, sensing currently opened files and selected code.

cd packages/vscode-ide-companion
npm install
npm run build
npm run package  # Generate .vsix file

UI Plugin

Complete graphical AI coding assistant interface, supporting:

  • Sidebar AI conversation window
  • Context menu code actions (explain/optimize/generate tests)
  • Inline code completion suggestions
  • MCP server status management
cd packages/vscode-ui-plugin
npm install
cd webview && npm install && npm run build && cd ..
npm run build
npm run package  # Generate .vsix file

🛠️ Built-in Tools

DeepV Code's AI interacts with the external environment through an extensible tool system:

Tool Description
shell Execute shell commands
read_file Read file contents
write_file Create/write files
replace Precise file content replacement
delete_file Delete files
glob File pattern matching search
grep Content regex search
web_fetch Fetch web content
web_search Google search
task Launch code analysis sub-agent
mcp_tool Call MCP service tools

📖 Documentation

🧑‍💻 Development Guide

Common Commands

Command Description
npm install Install all dependencies
npm run build Build project
npm run start Start CLI (can be used with DEEPX_SERVER_URL)
npm run dev Run in development mode (with debugging, connects to official dev server)
npm run test Run tests
npm run lint Code linting
npm run pack:prod Production build
npm run clean Clean build artifacts

Development Workflow

  1. Run npm run build after code changes
  2. Run npm run dev to test changes
  3. Use npm run lint to ensure code standards
  4. Run npm run test before submitting PR

💡 Tip: We recommend using dvcode for self-development. The project's DEEPV.md provides development guidelines for the AI model.

🤝 Contributing

We welcome community contributions! Please follow these steps:

  1. Fork this repository
  2. Create a feature branch (git checkout -b feature/AmazingFeature)
  3. Commit changes (git commit -m 'Add some AmazingFeature')
  4. Push to branch (git push origin feature/AmazingFeature)
  5. Submit a Pull Request

Reporting Issues

If you find bugs or have feature suggestions, please create an Issue.

⭐ Star History

Star History Chart

📄 License

This project is open-sourced under the Apache License 2.0.

🔗 Links

💬 "AI is not just a tool, it's every developer's partner."

🪄 Happy Coding with DeepV Code! 💻✨