Quick Start Guide

npm install -g dispersl
# or
pnpm add -g dispersl

npm install dispersl
# or
pnpm add dispersl

npm install dispersl-mcp

# Add to your shell profile (.bashrc, .zshrc, etc.)
export DISPERSL_API_KEY="your_api_key_here"
 
# Or create a .env file in your project
echo "DISPERSL_API_KEY=your_api_key_here" > .env

dispersl auth login
# Follow the prompts to enter your credentials

# Create and navigate to your project directory
mkdir my-dispersl-project
cd my-dispersl-project
 
# Initialize Dispersl in your project
dispersl init
 
# Follow the interactive setup

module.exports = {
  // Project settings
  name: "my-dispersl-project",
  description: "My first multi-agent project",
  
  // Agent configuration
  agents: {
    coding: {
      model: "anthropic/claude-3-sonnet",
      temperature: 0.1,
      maxTokens: 4000
    },
    testing: {
      model: "openai/gpt-4",
      temperature: 0.2,
      maxTokens: 3000
    },
    docs: {
      model: "google/gemini-pro",
      temperature: 0.3,
      maxTokens: 2000
    }
  },
  
  // Integration settings
  integrations: {
    github: {
      enabled: true,
      repository: "your-username/your-repo"
    },
    deployment: {
      platform: "vercel", // or "netlify", "aws", etc.
      autoDeployPR: true
    }
  }
}

dispersl start

dispersl task create "Build a React todo app with authentication"

dispersl chat
> Build a React todo app with authentication and a REST API backend

# View active tasks
dispersl tasks list
 
# Monitor a specific task
dispersl task watch <task-id>
 
# View agent logs
dispersl logs --agent coding

{
  "mcpServers": {
    "dispersl": {
      "url": "https://dispersl.com/mcp/YOUR_DISPERSL_MCP_KEY"
    }
  }
}

dispersl mcp key

Ask Cursor: "List my Dispersl integrations"

# Create a complete web application
dispersl task create "Build a full-stack e-commerce site with:
- React frontend with TypeScript
- Node.js/Express backend
- PostgreSQL database
- Stripe payment integration
- User authentication
- Admin dashboard
- Deployment to AWS"

# Generate a REST API
dispersl task create "Create a RESTful API for a blog platform with:
- User management and authentication
- CRUD operations for posts and comments
- File upload for images
- Rate limiting and security
- OpenAPI documentation
- Docker containerization"

# Add comprehensive testing
dispersl task create "Add testing to my existing project:
- Unit tests with Jest
- Integration tests for API endpoints
- E2E tests with Playwright
- Code coverage reporting
- CI/CD pipeline setup"

# Initialize new project
dispersl init [project-name]
 
# Start agent team
dispersl start
 
# Stop agent team
dispersl stop
 
# Project status
dispersl status

# Create new task
dispersl task create "description"
 
# List all tasks
dispersl tasks list
 
# View task details
dispersl task show <task-id>
 
# Cancel task
dispersl task cancel <task-id>

# List available agents
dispersl agents list
 
# View agent status
dispersl agent status <agent-name>
 
# Configure agent
dispersl agent config <agent-name>
 
# View agent logs
dispersl logs --agent <agent-name>

# Connect GitHub repository
dispersl github connect <repo-url>
 
# Deploy to platform
dispersl deploy <platform>
 
# Manage MCP connections
dispersl mcp list
dispersl mcp connect <tool-name>

// In dispersl.config.js
agents: {
  coding: {
    model: "anthropic/claude-3-sonnet",    // Anthropic
    // model: "openai/gpt-4",              // OpenAI
    // model: "google/gemini-pro",         // Google
    // model: "deepseek/deepseek-r1",      // DeepSeek
  }
}

// Optimize for your use case
performance: {
  maxConcurrentTasks: 3,
  agentTimeout: 300, // seconds
  retryAttempts: 2,
  cacheEnabled: true
}

security: {
  encryptLocalData: true,
  requireMFA: false,
  allowedDomains: ["your-domain.com"],
  rateLimiting: {
    enabled: true,
    requestsPerMinute: 100
  }
}

# Verify your API key
dispersl auth status
 
# Re-authenticate
dispersl auth login

# Check agent status
dispersl agent status coding
 
# Restart specific agent
dispersl agent restart coding
 
# View detailed logs
dispersl logs --agent coding --verbose

# View task details
dispersl task show <task-id>
 
# Retry failed task
dispersl task retry <task-id>
 
# Cancel and recreate
dispersl task cancel <task-id>
dispersl task create "updated description"

# Enable debug mode
export DISPERSL_DEBUG=true
 
# Or use the debug flag
dispersl --debug task create "description"