Getting Started

Welcome to Codemus! This guide will help you get up and running quickly.

⚠️ Before You Start: Claude Subscription Required

Codemus requires Claude Code CLI and an active Claude subscription. Make sure you have:

Without these, Codemus will not be able to function.

First Launch

When you first launch Codemus, you'll see the Welcome Wizard — a 5-page onboarding flow:

  1. Welcome Page: Introduction to Codemus
  2. Core Concepts: Learn about agents, sprints, and artifacts
  3. Setup CLI: Configure the path to Claude Code CLI (requires active subscription)
  4. Create First Project: Quick-start project creation
  5. Ready to Go: Tips and keyboard shortcuts

Creating Your First Project

Step 1: Click "New Project"

From the sidebar or welcome screen, click the "New Project" button.

Step 2: Enter Project Details

Fill in the project creation form:

  • Name: A descriptive name for your project
  • Description: Brief overview of what the project is about
  • Working Directory: The folder where project files will be stored

Step 3: Project Created

Your project is now created in Draft state. You'll see it in the project list.

Understanding the Project Lifecycle

Every project follows a strict lifecycle enforced by the Agile State Machine:

DRAFT → BACKLOG_READY → SPRINT_PLANNING → SPRINT_ACTIVE
                                                      ↓
                                    SPRINT_REVIEW → SPRINT_RETRO
                                                      ↓
                                                 COMPLETED → ARCHIVED

You cannot skip states — each transition has guard conditions that must be met.