Quick Start
Get Forgexa running in under 5 minutes.
Prerequisites
- Docker & Docker Compose
- Git
- One of: Claude Code CLI, Codex CLI, or OpenCode CLI installed
1. Clone and Start
bash
git clone <your-repo-url> forgexa
cd forgexa
# Start all services (API, Web, PostgreSQL, Redis, MinIO)
docker compose up -dThe web UI will be available at http://localhost:3000 and the API at http://localhost:8000.
2. Login
Default admin credentials:
- Email:
admin@example.com - Password:
admin123
bash
# Via Forgexa CLI (recommended)
forgexa login --server http://localhost:8000 --email admin@example.com --password admin1233. Create an Organization
After logging in, create an organization to manage your team:
- Click the organization selector (top-left)
- Click Create Organization
- Enter an organization name (e.g., "My Team")
- You're now the organization Owner
TIP
An organization is the top-level container. You'll create workspaces inside it to organize projects.
4. Start a Daemon
The daemon runs on your host machine and executes AI agent tasks:
bash
# Set environment variables
export DAEMON_SERVER_URL=http://localhost:8000
export DAEMON_API_TOKEN=<your-token>
# Start the daemon
forgexa daemon startThe daemon will:
- Discover installed agent CLIs (claude, codex, opencode, gemini)
- Register with the API server
- Start polling for tasks
5. Create a Project
- Open the Web UI → select your workspace → Projects → New Project
- Fill in project details:
- Name, project key
- Tech stack (e.g.,
["python", "fastapi"]) - Git repository URL (optional)
- Save
6. Submit a Requirement
- Navigate to your project → Requirements → New Requirement
- Enter a natural language requirement:
"Create a REST API endpoint for user registration with email validation and password hashing"
- Click Analyze — AI will generate a structured specification
- Review and Approve the requirement
7. Generate and Run a Plan
- After requirement approval, click Generate Plan
- Review the generated plan (work items, execution nodes)
- Click Approve Plan — this confirms the plan for execution
- The execution will start automatically if a daemon is online
8. Monitor Execution
- Executions page — watch the pipeline progress (design → coding → testing → review)
- Board page — track work items across Kanban columns
- Gates page — review and approve quality gates when prompted
What's Next
- Organization Management — manage teams, invitations, budgets
- Installation Guide — detailed deployment options
- Basic Workflow — deep dive into the development lifecycle
- WORKFLOW.md Configuration — customize agent behavior