Learning VibeX: Tutorials
Welcome to the VibeX learning path! This comprehensive guide will take you from your first AI agent workspace to building complex multi-agent systems. Each tutorial builds on the previous ones, teaching you core concepts through hands-on TypeScript examples.
🎯 Learning Path Overview
Core Tutorial Sequence:
- Tutorial 1: Your First Agent (15 minutes)
- Tutorial 2: Multi-Agent Teams (30 minutes)
- Tutorial 3: Custom Tools (45 minutes)
- Tutorial 4: Configuration Deep Dive (30 minutes)
Advanced Examples:
- Comprehensive Systems (60 minutes) — Putting it all together
📚 Tutorial Series
Tutorial 1: Your First Agent
⏱️ Time: 15 minutes | 🎯 Goal: Create a persistent workspace
Learn the fundamentals by creating your first VibeX workspace with XAgent. This tutorial covers:
- Setting up a TypeScript project with VibeX
- Creating a Space and XAgent
- Streaming responses from the agent
- Persisting and resuming workspaces
Perfect for: Complete beginners to VibeX
Tutorial 2: Multi-Agent Collaboration
⏱️ Time: 30 minutes | 🎯 Goal: Build a writer-researcher team
Create a team of specialized agents that work together! Build a system where researchers gather information and writers create content. Learn:
- Multi-agent orchestration with XAgent
- Specialist agents and their roles
- How agents coordinate within a Space
- Building collaborative workflows
Perfect for: Developers ready to explore multi-agent systems
Tutorial 3: Custom Tools
⏱️ Time: 45 minutes | 🎯 Goal: Create agents with custom capabilities
Give your agents superpowers by creating custom tools that extend their capabilities. This tutorial covers:
- Custom tool development in TypeScript
- Tool integration with agents
- External API usage
- Advanced agent capabilities
Perfect for: Developers wanting to extend agent functionality
Tutorial 4: Configuration Deep Dive
⏱️ Time: 30 minutes | 🎯 Goal: Master Space and Agent configuration
Learn how to configure every aspect of your VibeX workspace. This tutorial covers:
- Agent configuration with YAML
- LLM provider settings
- Tool permissions and security
- Production deployment patterns
Perfect for: Developers preparing for production
Advanced: Comprehensive Systems
⏱️ Time: 60 minutes | 🎯 Goal: Build a scalable, production-ready system
Build something serious! Create a comprehensive research system with multiple specialized agents and production features:
- Advanced multi-agent architectures
- Persistent storage with Supabase
- Error handling and resilience
- Production deployment patterns
Perfect for: Developers who want to see how all VibeX concepts work together
🚀 Getting Started
Prerequisites
Before starting the tutorials, make sure you have:
- Node.js 18+ installed
- pnpm installed (
npm install -g pnpm) - API Key — OpenAI, Anthropic, or DeepSeek
- Basic TypeScript knowledge — understanding of async/await is helpful
Quick Setup
# Create a new project
mkdir my-vibex-project
cd my-vibex-project
pnpm init
# Install dependencies
pnpm add vibex dotenv
# Install dev dependencies
pnpm add -D typescript tsx @types/node
# Create tsconfig.json
echo '{
"compilerOptions": {
"target": "ES2022",
"module": "ESNext",
"moduleResolution": "bundler",
"esModuleInterop": true,
"strict": true,
"skipLibCheck": true
}
}' > tsconfig.json
# Create .env file
echo "OPENAI_API_KEY=your-key-here" > .envRecommended Learning Path
- Start with Tutorial 1 — Even if you’re experienced, this establishes the VibeX patterns
- Progress sequentially — Each tutorial builds on the previous concepts
- Run the examples — Hands-on practice is essential
- Experiment — Modify the examples to explore different approaches
Time Investment
- Quick learner: 2-3 hours total
- Thorough learner: 4-5 hours with experimentation
- Production focus: Add 2-3 hours for deployment exploration
💡 What You’ll Build
By the end of this tutorial series, you’ll have built:
- ✅ A persistent workspace with XAgent
- ✅ A multi-agent research and writing team
- ✅ An agent with custom tools
- ✅ A production-ready configuration
- ✅ A comprehensive research system
🎯 Learning Outcomes
After completing all tutorials, you’ll understand:
- Core Concepts: Spaces, XAgent, Artifacts, and tools
- TypeScript API: Complete VibeX SDK usage
- Development Patterns: Best practices for VibeX applications
- Production Deployment: Scalable, maintainable agent systems
- Custom Extensions: Building tools and integrations
📖 Additional Resources
Quick References
- SDK Reference — Complete API documentation
- Configuration Guide — Detailed configuration options
- Design Principles — Architecture deep dive
Example Projects
Check out these complete examples in the VibeX repository:
| Example | Description |
|---|---|
| Quick Start | Get started in 5 minutes |
| Thesis Writer | Multi-session document evolution |
| Research Assistant | Knowledge accumulation |
| Code Review | Collaborative code review |
Community & Support
- GitHub Repository — Source code and issues
- GitHub Discussions — Community support
Ready to start building? Begin with Tutorial 1: Your First Agent! 🚀