vcode-ai-cli
v1.0.5
Published
VCODE - High-fidelity Freebuff reimplementation powered by Poolside AI
Maintainers
Readme
VCODE 🧡
High-fidelity Freebuff Reimplementation powered by Poolside AI
VCODE is an autonomous terminal coding agent that reproduces the Freebuff CLI experience with maximum behavioral parity. It uses Poolside AI as the inference provider and features a distinctive white & orange theme.
✨ Features
- 🎨 Authentic Freebuff Experience - High-fidelity reimplementation of CLI behavior
- 🤖 Multi-Agent System - Specialized agents for different tasks
- 🖼️ Image Support - Analyze images from clipboard or files
- 📁 File Operations - Read, write, edit, search files
- ⚡ Real-time Actions - See what the agent is doing
- 🔄 Streaming Responses - Real-time AI responses
- 🎯 Context Gathering - Smart project understanding
- 💾 History Persistence - Remember conversations
- 🌓 Theme Toggle - Dark and light modes
🚀 Quick Start
Prerequisites
- Node.js 18+
- npm or yarn
Installation
# Navigate to project
cd "Projetos e Desenvolvimento/vcode"
# Install dependencies
npm install
# Link globally (optional)
npm link
# Run VCODE
vcodeConfiguration
- Copy
.env.exampleto.env - Add your Poolside API key:
POOLSIDE_API_KEY=your_poolside_api_key📖 Usage
Basic Commands
# Start in current directory
vcode
# Start in specific directory
vcode /path/to/project
# With specific model
vcode -m poolside/laguna-xs-2.1Slash Commands
| Command | Description |
|---------|-------------|
| /help | Show all commands |
| /clear | Clear context |
| /new | New conversation |
| /history | View history |
| /init | Generate knowledge.md |
| /model | Show current model |
| /theme | Toggle theme |
| /bash | Enter bash mode |
| /exit | Exit VCODE |
File Mentions
› analise @src/auth.ts
› corrija o erro em @package.json
› leia @README.md e expliqueAgent Mentions
› @Reviewer revise essa implementação
› @Planner crie um plano para migrar a API
› @Tester rode os testesBash Mode
› !npm test
› !git status
› !cargo buildImage Analysis
› /image screenshot.png
› por que isso está acontecendo?
# Or paste from clipboard
› /image🏗️ Architecture
vcode/
├── src/
│ ├── index.ts # Entry point
│ ├── cli/
│ │ └── app.ts # Main application
│ ├── tui/
│ │ └── terminal.ts # Terminal UI
│ ├── agents/
│ │ ├── router.ts # Agent routing
│ │ ├── base.ts # Base agent
│ │ ├── coder.ts # Main coder
│ │ ├── editor.ts # File editor
│ │ ├── reviewer.ts # Code reviewer
│ │ ├── tester.ts # Test runner
│ │ ├── researcher.ts # Documentation
│ │ ├── planner.ts # Planning
│ │ └── filepicker.ts # File finder
│ ├── tools/
│ │ └── registry.ts # Tool management
│ ├── providers/
│ │ └── poolside.ts # Poolside AI
│ ├── config/
│ │ └── config.ts # Configuration
│ ├── history/
│ │ └── manager.ts # History persistence
│ └── utils/
│ ├── scanner.ts # Project scanner
│ ├── context.ts # Context manager
│ ├── mentions.ts # File mentions
│ ├── images.ts # Image handling
│ ├── logger.ts # Logging
│ └── version.ts # Version info
├── package.json
├── tsconfig.json
├── .env.example
├── .gitignore
├── .vcodeignore
└── README.md🎨 Theming
VCODE supports dark and light themes:
# Toggle theme
/theme
# Or set explicitly
/theme dark
/theme lightDark Theme (Default)
- Background: Black
- Text: White
- Accent: Orange (#FF8C00)
Light Theme
- Background: White
- Text: Black
- Accent: Orange (#FF8C00)
🔧 Configuration Files
Global Config
Location: ~/.vcode/config.json
Project Config
Location: vcode.config.json in project root
Knowledge Files
knowledge.md- Project knowledgeVCODE.md- VCODE-specific knowledge.vcode/knowledge.md- Alternative location
📚 How It Works
- Startup: Scans project structure, loads knowledge
- Input: Parses commands, mentions, and queries
- Routing: Routes to appropriate agent
- Execution: Uses tools to read/write/execute
- Response: Streams formatted response
🛠️ Available Tools
| Tool | Description |
|------|-------------|
| read_file | Read file contents |
| write_file | Create/overwrite file |
| edit_file | Precise file edits |
| delete_file | Delete a file |
| move_file | Move/rename file |
| list_directory | List directory contents |
| search_files | Search by pattern |
| find_text | Search text in files |
| execute_command | Run shell commands |
| project_tree | Get project tree |
🤖 Agents
| Agent | Trigger | Purpose |
|-------|---------|---------|
| coder | Default | General coding |
| editor | Edit requests | Precise edits |
| reviewer | @Reviewer, "revise" | Code review |
| tester | @Tester, "teste" | Run tests |
| researcher | @Researcher, "pesquise" | Documentation |
| planner | @Planner, "planeje" | Planning |
| filepicker | @FilePicker, "encontre" | Find files |
📝 License
MIT License
🙏 Credits
- Inspired by Freebuff
- Powered by Poolside AI
- Built with ❤️
Made with 🧡 by Victor
