Skip to main content

Architecture Overview

CLEO is a production-grade task management system designed specifically for AI coding agents. This document covers the core architecture and design principles.

Design Principles

CLEO is built on three foundational pillars:

Anti-Hallucination First

Multi-layer validation prevents AI-generated errors from corrupting task data

Atomic Operations

Every file modification uses atomic write patterns - no partial writes, no corruption

Session Continuity

Complete audit trails and automatic backups enable seamless work across sessions

System Invariants

These properties must ALWAYS be true:
InvariantDescription
Single Source of Truthtodo.json is authoritative for active tasks
Immutable HistoryLog entries never modified or deleted
Fail-Safe OperationsAtomic file operations with validation
Schema-FirstJSON Schema validation prevents corruption
Idempotent ScriptsSafe to run multiple times
Zero-Config DefaultsSensible defaults, optional customization

Directory Structure

~/.cleo/                    # Global installation
├── schemas/                # JSON Schema definitions
├── templates/              # Template files
├── scripts/                # Executable scripts
├── lib/                    # Shared libraries
├── docs/                   # Documentation
└── completions/            # Shell completions

.cleo/                      # Project-level data
├── todo.json              # Active tasks
├── todo-archive.json      # Completed tasks
├── config.json            # Configuration
├── todo-log.json          # Audit trail
├── sessions.json          # Session state
└── .backups/              # Automatic backups

Data Files

Purpose: Active task storage (source of truth)Structure:
{
  "_meta": {
    "schemaVersion": "2.6.0",
    "lastModified": "2025-01-19T12:00:00Z",
    "checksum": "sha256..."
  },
  "project": {
    "currentPhase": "core"
  },
  "focus": {
    "taskId": "T001",
    "sessionNote": "Working on auth"
  },
  "tasks": [...]
}
Purpose: Completed task storageContains: Tasks moved after completion via cleo archive
Purpose: Immutable audit trailContains: Append-only log of all operations with timestamps
Purpose: Project configurationContains: Archive settings, validation rules, defaults

Core Components

Validation Pipeline

1

Schema Validation

JSON Schema validation on every write operation
2

Semantic Validation

Cross-file integrity checks, valid status transitions
3

Anti-Hallucination Checks

Duplicate detection, timestamp validation, ID uniqueness
4

Atomic Write

temp file → validate → backup → rename

Atomic Write Pattern

All file modifications follow this pattern:
1. Write to temporary file
2. Validate against JSON Schema
3. Create backup of original
4. Atomic rename to replace original
5. Log operation to audit trail
This pattern ensures no partial writes - either the entire operation succeeds or the original file is preserved.

Backup System

CLEO implements a two-tier backup system:
TierPurposeLocation
Tier 1Atomic write safety.cleo/.backups/todo.json.1-10
Tier 2Point-in-time recovery.cleo/backups/{type}/
Tier 1 backups are automatic on every write operation with numbered rotation (last 10). Tier 2 backups are manual or pre-destructive operation snapshots with metadata and checksums.

Anti-Hallucination Mechanisms

CLEO implements four layers of protection:
JSON Schema EnforcementEvery task must conform to todo.schema.json:
  • Required fields: id, title, status
  • Status enum: pending, active, blocked, done
  • Valid timestamp formats
  • Correct data types

Extension Points

CLEO provides several extension mechanisms:
ExtensionPurposeLocation
HooksPre/post operation callbackshooks/
ValidatorsCustom validation ruleslib/validators/
FormattersCustom output formatslib/formatters/
CommandsNew CLI commandsscripts/

Performance Considerations

CLEO is optimized for 1000+ tasks:
  • File locking prevents race conditions
  • Indexed operations for fast lookups
  • Lazy loading for archive access
  • Efficient JSON parsing with jq streaming

Next Steps