Introduction

Copal Docs

Copal is a powerful, modular AI Agent Swarm framework written in Luau, designed to run on the Lune runtime. It orchestrates hierarchies of AI models—from low-cost worker swarms to high-intelligence directors—to solve complex tasks autonomously.

New to Copal? Start with the Installation Guide and then explore the Quick Start tutorial.

Features

  • Hierarchy of Intelligence:

    • Swarm Mode: A group of cost-effective agents executing subtasks in parallel
    • Director Mode: A supervisor agent that plans, delegates, reviews, and retries work
    • Company Mode: Top-level CEO orchestration for massive multi-swarm operations

  • Interactive TUI: Beautiful terminal interface with ANSI graphics and live status updates

  • Smart Setup Wizard: Auto-fetches available models, search & filter, secure API key storage

  • Robust Tooling: File system operations, terminal commands, inter-agent communication

  • Provider Agnostic: Works with OpenRouter, OpenCode, OpenAI, or any custom OpenAI-compatible endpoint

Quick Start

# Install Lune runtime
scoop bucket add lune https://github.com/CompeyDev/lune-packaging.git
scoop install lune
 
# Clone and run Copal
git clone https://github.com/Naymmmm/copal.git
cd copal
lune run src/main.luau
InstallationCore ConceptsAPI ReferenceConfiguration
Installation