Skip to main content

Quick Start

Get CLEO installed and managing your first task in under 5 minutes.

TL;DR - Just Install It

curl -fsSL https://github.com/kryptobaseddev/cleo/releases/latest/download/install.sh | bash
Reinstalling over existing installation? Use --force:
curl -fsSL https://github.com/kryptobaseddev/cleo/releases/latest/download/install.sh | bash -s -- --force
The installer automatically detects missing dependencies (jq, flock) and offers to install them. On macOS, it auto-detects Homebrew Bash if your system Bash is below version 4.

Initialize Your Project

cd /path/to/your/project
cleo init
This creates .cleo/ directory with task files and auto-injects instructions into CLAUDE.md.

Verify Installation

cleo version
cleo validate

Your First Task

cleo add "Fix login bug" --priority high --labels bug,auth

Essential Commands

CommandDescriptionExample
cleo addCreate a taskcleo add "Task title"
cleo listView taskscleo list --status pending
cleo completeMark donecleo complete T001
cleo focus setSet active taskcleo focus set T001
cleo dashProject overviewcleo dash

Daily Workflow

# Morning: Start your session
cleo session start
cleo list --status pending
cleo focus set T001

# During work: Track progress
cleo update T001 --notes "Fixed validation logic"
cleo complete T001
cleo focus set T002

# Evening: Clean up
cleo archive
cleo session end
Use ct as a shorthand alias for cleo. Install shell aliases with source ~/.cleo/completions/bash-completion.sh.

Next Steps