Tutorial 0: Bootstrap Your First Project

# Clone the VibeX repository
git clone https://github.com/tiwater/vibex.git
cd vibex/examples/quick-start
 
# Install dependencies
pnpm install
 
# Set up your environment
cp env.example .env
# Edit .env with your API key
 
# Run the example
pnpm start

mkdir my-vibex-project
cd my-vibex-project
pnpm init

# Install VibeX and dotenv for environment variables
pnpm add vibex dotenv
 
# Install TypeScript development dependencies
pnpm add -D typescript tsx @types/node

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "ESNext",
    "moduleResolution": "bundler",
    "esModuleInterop": true,
    "strict": true,
    "skipLibCheck": true,
    "outDir": "dist"
  },
  "include": ["src/**/*"]
}

# Choose your LLM provider
 
# OpenAI
OPENAI_API_KEY=sk-your-openai-key
 
# Or Anthropic
ANTHROPIC_API_KEY=your-anthropic-key
 
# Or DeepSeek
DEEPSEEK_API_KEY=your-deepseek-key

import "dotenv/config";
import { XAgent } from "vibex";
 
async function main() {
  console.log("🚀 Starting VibeX...\n");
 
  // Create a new workspace
  const xAgent = await XAgent.start("My first VibeX project");
  const space = xAgent.getSpace();
 
  console.log(`✨ Created Space: ${space.spaceId}`);
  console.log(`📋 Goal: ${space.goal}\n`);
 
  // Chat with XAgent
  console.log("🤖 XAgent: ");
  const stream = await xAgent.streamText({
    messages: [
      { role: "user", content: "Hello! What can you help me with?" }
    ],
    metadata: { mode: "agent", requestedAgent: "X" },
  });
 
  for await (const chunk of stream.textStream) {
    process.stdout.write(chunk);
  }
 
  console.log("\n");
 
  // Save the workspace
  await space.persistState();
  console.log(`💾 Workspace saved! Space ID: ${space.spaceId}`);
}
 
main().catch(console.error);

{
  "name": "my-vibex-project",
  "type": "module",
  "scripts": {
    "start": "tsx src/index.ts",
    "dev": "tsx watch src/index.ts"
  }
}

pnpm start

🚀 Starting VibeX...

✨ Created Space: space_abc123xyz
📋 Goal: My first VibeX project

🤖 XAgent: Hello! I'm XAgent, your AI assistant...

💾 Workspace saved! Space ID: space_abc123xyz

my-vibex-project/
├── src/
│   └── index.ts        # Your main application
├── .env                # API keys (don't commit this!)
├── .gitignore          # Git ignore file
├── package.json        # Project configuration
└── tsconfig.json       # TypeScript configuration

node_modules/
dist/
.env
*.log