Comprehensive Quick Start Guide

# Check your versions
node --version    # Should be v23.3.0+
bun --version     # Should be 1.2.15+
git --version     # Any recent version

# Install globally
npm install -g @elizaos/cli

# Verify installation
elizaos --version

# Create a new agent project
elizaos create -t project my-first-agent
cd my-first-agent

# The CLI will automatically:
# - Create project structure
# - Install dependencies
# - Generate basic configuration

# Open your agent's character file
code src/character.ts

// src/character.ts
export const character = {
  name: "Alex",
  bio: "A helpful AI assistant that loves to chat and help users with their questions.",

  // Basic personality traits
  personality: [
    "helpful and friendly",
    "curious about the world",
    "patient and understanding",
    "loves to learn new things",
  ],

  // How the agent should behave
  behavior: [
    "Always be polite and respectful",
    "Ask clarifying questions when needed",
    "Provide helpful and accurate information",
    "Maintain a positive attitude",
  ],

  // Example conversations
  knowledge: [
    "I can help with general questions and conversations",
    "I enjoy discussing technology, books, and current events",
    "I'm here to assist and make your day better",
  ],
};

# Copy environment template
cp .env.example .env

# Edit with your API keys
code .env

# .env
# Required: Choose your AI model provider
OPENAI_API_KEY=your_openai_key_here
# OR
ANTHROPIC_API_KEY=your_anthropic_key_here

# Optional: Add platform integrations
DISCORD_TOKEN=your_discord_token
TWITTER_API_KEY=your_twitter_key

# Start development mode (with hot reload)
elizaos dev

# OR start production mode
elizaos start

# Test with CLI
elizaos test

# Or interact directly (if using terminal client)
# Your agent will respond to messages based on its character

# Create a new plugin
elizaos create -t plugin weather-bot
cd plugin-weather-bot

// src/plugin.ts
import { Plugin } from "@elizaos/core";

import { weatherAction } from "./actions/weather";

export const weatherPlugin: Plugin = {
  name: "weather",
  version: "1.0.0",
  description: "Provides weather information",

  actions: [weatherAction],
  providers: [],
  evaluators: [],
};

export default weatherPlugin;

// src/actions/weather.ts
import { Action, IAgentRuntime, Memory, State } from "@elizaos/core";

export const weatherAction: Action = {
  name: "GET_WEATHER",
  similes: ["weather", "forecast", "temperature"],
  description: "Get weather information for a location",

  validate: async (runtime: IAgentRuntime, message: Memory) => {
    const text = message.content.text.toLowerCase();
    return text.includes("weather") || text.includes("forecast");
  },

  handler: async (runtime: IAgentRuntime, message: Memory, state: State) => {
    // Simple weather response (integrate with real API)
    const location = extractLocation(message.content.text);

    return {
      text: `The weather in ${location} is sunny and 72°F. Perfect day to go outside!`,
      content: {
        weather: {
          location,
          temperature: 72,
          condition: "sunny",
        },
      },
    };
  },

  examples: [
    [
      {
        user: "user",
        content: { text: "What's the weather like in New York?" },
      },
      {
        user: "agent",
        content: { text: "The weather in New York is sunny and 72°F. Perfect day to go outside!" },
      },
    ],
  ],
};

function extractLocation(text: string): string {
  // Simple location extraction logic
  const match = text.match(/weather.*in\s+([A-Za-z\s]+)/i);
  return match ? match[1].trim() : "your area";
}

# Start development
elizaos dev

# Run tests
elizaos test

# Clone ElizaOS repository
git clone https://github.com/elizaos/eliza.git
cd eliza

# Install dependencies
bun install

# Build all packages
bun run build

# Create a new plugin in the monorepo
cp -r packages/plugin-starter packages/plugin-myservice
cd packages/plugin-myservice

// package.json
{
  "name": "@elizaos/plugin-myservice",
  "description": "My custom service plugin",
  "version": "1.0.16",
  "dependencies": {
    "@elizaos/core": "workspace:*"
  }
}

# Start full development environment
bun run dev

# Test your changes
bun test --filter=./packages/plugin-myservice

# Fix: Install with proper permissions
sudo npm install -g @elizaos/cli

# Or use alternative installation
npx @elizaos/cli create -t project my-agent

# Clean and rebuild
bun run clean
bun install
bun run build

# Check Node.js version
node --version

# Update if needed
# Visit https://nodejs.org for latest version

# Reinstall dependencies
rm -rf node_modules bun.lockb
bun install

# Check environment variables
echo $OPENAI_API_KEY

# Verify .env file exists and has correct format
cat .env

elizaos dev      # Development with hot reload
elizaos start    # Production start
elizaos test     # Run tests

# Build for production
bun run build

# Start with PM2 (process manager)
pm2 start dist/index.js --name "my-agent"

# Or use Docker
docker build -t my-agent .
docker run -d --name my-agent my-agent