Documentation

Learn how to harness the full power of VxCode AI for your development workflow

Getting Started

Welcome to VxCode AI! This guide will help you get up and running with our AI-powered IDE in just a few minutes.

📥

1. Download

Download VxCode AI for your operating system. Available for Windows, macOS, and Linux.

⚙️

2. Install

Run the installer and follow the setup wizard. No complex configuration required.

🚀

3. Start Coding

Open your project and experience AI-powered development with intelligent assistance.

Installation

System Requirements

Windows

  • Windows 10 version 1903+
  • 8GB RAM minimum
  • 2GB free disk space

macOS

  • macOS 10.15+
  • 8GB RAM minimum
  • 2GB free disk space

Linux

  • Ubuntu 18.04+
  • 8GB RAM minimum
  • 2GB free disk space

Download Options

VxCode AI for Windows

vxcode-ai-setup.exe (125 MB)

VxCode AI for macOS

vxcode-ai.dmg (118 MB)

Core Features

AI-Powered Code Completion

VxCode AI provides intelligent code suggestions based on your context, coding patterns, and project structure. Our AI understands multiple programming languages and frameworks.

// Type: function calculateTotal
function
calculateTotal(items) {
// AI suggests: return items.reduce((sum, item) => sum + item.price, 0);
return items.reduce(...)
}

Real-time Error Detection

Get instant feedback on potential issues in your code with AI-powered error detection and suggested fixes.

Code Refactoring

Automatically improve your code structure with intelligent refactoring suggestions that maintain functionality while improving readability and performance.

AI Agents

AI Agents are specialized assistants that help you with specific development tasks. You can interact with them using natural language commands.

@Agent Command Syntax

@Agent
Create a React component for user authentication

Simply type @Agent followed by your request in natural language.

Builder Agent

Built-in agent for general development tasks, code generation, and project setup.

@Agent build a REST API endpoint

Debug Agent

Specialized in finding and fixing bugs, analyzing error logs, and optimization.

@Agent debug this memory leak

Cue Autocomplete

Cue is our advanced autocomplete system that predicts your next edit with incredible accuracy. Simply press Tab to accept suggestions or navigate through multiple options.

How Cue Works

  1. Cue analyzes your current code context and patterns
  2. It predicts the most likely next lines of code
  3. Suggestions appear as ghost text or inline popups
  4. Press Tab to accept, or use arrow keys to navigate options

💡 Pro Tip

Cue learns from your coding patterns. The more you use it, the better it becomes at predicting your specific coding style and preferences.

Context Management

Context is how VxCode AI understands your project structure, dependencies, and development environment to provide more accurate assistance.

Context Types

📁 Workspace

Entire project directory and file structure

📂 Folder

Specific directory and its contents

📄 Files

Individual files and their content

💻 Code

Specific code blocks or functions

🌐 Web

External documentation and resources

📄 Docs

Project documentation and README files

Using Context in Commands

@Agent
#Context
src/components/
Create a new component following the patterns in this folder

External Tools Integration

VxCode AI seamlessly integrates with your favorite development tools and services to enhance your workflow.

Git Integration

Built-in Git support with intelligent commit messages and branch management.

Package Managers

Support for npm, yarn, pip, cargo, and other package management systems.

Database Tools

Direct integration with databases for schema exploration and query assistance.

Keyboard Shortcuts

General Shortcuts

ActionWindows/LinuxmacOS
Open Command PaletteCtrl + Shift + PCmd + Shift + P
Quick File OpenCtrl + PCmd + P
Toggle TerminalCtrl + `Cmd + `

AI-Specific Shortcuts

ActionShortcut
Accept Cue suggestionTab
Restart VxCode AICtrl + Shift + A
Next suggestionAlt + ]
Previous suggestionAlt + [

Troubleshooting

Common Issues

AI suggestions are not appearing

Try the following solutions:

  • Check your internet connection
  • Restart VxCode AI
  • Verify that AI features are enabled in settings
  • Clear the cache and reload your project
Slow performance

Performance optimization tips:

  • Close unused files and projects
  • Reduce the number of active extensions
  • Check available system memory
  • Update to the latest version
Context not loading properly

Context loading issues:

  • Ensure project files are saved
  • Check file permissions
  • Reindex the project workspace
  • Verify supported file types

Need More Help?

If you're still experiencing issues, our support team is here to help.

Join Community →

API Reference

VxCode AI provides several APIs for extending functionality and integrating with external tools.

Extension API

Build custom extensions to enhance VxCode AI's capabilities for your specific workflow.

import
{ VxCodeAPI }
from
'@vxcode/api'


const
extension = new VxCodeAPI.Extension({
name: 'MyExtension',
version: '1.0.0'
})

Context API

Programmatically manage context for better AI assistance.

// Add files to context
VxCodeAPI
.context.addFiles(['src/utils.js'])

// Get current context
const
context =
await
VxCodeAPI.context.getCurrent()

Agent API

Create custom AI agents with specialized capabilities.

const
customAgent = new VxCodeAPI.Agent({
name: 'TestAgent',
description: 'Specialized in writing tests',
capabilities: ['testing', 'debugging']
})