Skip to main content
Type contracts exported by this package: interfaces, type aliases, and enums.

AdapterCapabilities

Adapter capability declarations for CLEO provider adapters. T5240

AdapterContextMonitorProvider

Context monitor provider interface for CLEO provider adapters. Allows providers to implement context window tracking and statusline integration. T5240

AdapterHookProvider

Hook provider interface for CLEO provider adapters. Maps provider-specific events to CAAMP hook events. T5240

AdapterInstallProvider

Install provider interface for CLEO provider adapters. Handles registration with the provider and instruction file references. T5240

InstallOptions

InstallResult

AdapterPathProvider

Path provider interface for CLEO provider adapters. Allows providers to declare their OS-specific directory locations. T5240

AdapterSpawnProvider

Spawn provider interface for CLEO provider adapters. T5240

SpawnContext

SpawnResult

ExternalTaskStatus

Normalized status for tasks coming from an external provider.

ExternalTask

A task as reported by an external provider, normalized to a common shape. Provider-specific adapters translate their native format into this.

ExternalLinkType

How an external task link was established.

SyncDirection

Direction of the sync that established the link.
A link between a CLEO task and an external provider task. Stored in the external_task_links table in tasks.db.

ConflictPolicy

Policy for resolving conflicts between CLEO and provider state. - cleo-wins: CLEO state takes precedence (default). - provider-wins: Provider state takes precedence. - latest-wins: Most recently modified value wins. - report-only: Report conflicts without applying changes.

ReconcileOptions

Options for the reconciliation engine.

ReconcileActionType

The type of action the reconciliation engine will take.

ReconcileAction

A single reconciliation action (planned or applied).

ReconcileResult

Result of a full reconciliation run.

ExternalTaskProvider

Interface that provider adapters implement to expose their external task system to the reconciliation engine. Provider-specific parsing lives in the adapter — core never sees native formats. Consumers implement this interface to integrate their issue tracker with CLEO.

AdapterTransportProvider

Transport provider interface for CLEO provider adapters. Allows providers to supply custom inter-agent transport mechanisms. T5240

CLEOProviderAdapter

AdapterHealthStatus

TaskStatus

SessionStatus

PipelineStatus

StageStatus

AdrStatus

GateStatus

ManifestStatus

EntityType

TaskPriority

Task priority levels.

TaskType

Task type in hierarchy.

TaskSize

Task size (scope, NOT time).

EpicLifecycle

Epic lifecycle states.

TaskOrigin

Task origin (provenance).

VerificationAgent

Verification agent types.

VerificationGate

Verification gate names.

VerificationFailure

Verification failure log entry.

TaskVerification

Task verification state.

TaskProvenance

Task provenance tracking.

TaskRelation

A single task relation entry.

Task

A single CLEO task as stored in the database. Fields marked as required are enforced by CLEO’s anti-hallucination validation at runtime. Making them required here ensures the type system catches violations at compile time rather than deferring to runtime checks.

TaskCreate

Input type for creating a new task via addTask(). Only the fields the caller MUST provide are required. All other fields have sensible defaults applied by the creation logic: - status defaults to 'pending' - priority defaults to 'medium' - type is inferred from parent context - size defaults to 'medium'

CompletedTask

A task with status = 'done'. Narrows Task to require completedAt. Use this type when you need to guarantee a completed task has its completion timestamp — for example, in cycle-time calculations or archive operations.

CancelledTask

A task with status = 'cancelled'. Narrows Task to require cancelledAt and cancellationReason. Use this type when processing cancelled tasks where the cancellation metadata is guaranteed to be present.

PhaseStatus

Phase status.

Phase

Phase definition.

PhaseTransition

Phase transition record.

ReleaseStatus

Release status.

Release

Release definition.

ProjectMeta

Project metadata.

FileMeta

File metadata (_meta block).

SessionNote

Session note in taskWork block.

TaskWorkState

Task work state.

TaskFile

Root task data structure.

ArchiveMetadata

Archive metadata attached to archived task records.

ArchivedTask

A task with archive metadata.

ArchiveReportType

Report type for archive statistics.

ArchiveSummaryReport

Summary report from archive statistics.

ArchivePhaseEntry

Phase breakdown entry from archive statistics.

ArchiveLabelEntry

Label breakdown entry from archive statistics.

ArchivePriorityEntry

Priority breakdown entry from archive statistics.

CycleTimeDistribution

Cycle time distribution buckets.

CycleTimePercentiles

Cycle time percentiles.

ArchiveCycleTimesReport

Cycle times report from archive statistics.

ArchiveDailyTrend

Daily archive trend entry.

ArchiveMonthlyTrend

Monthly archive trend entry.

ArchiveTrendsReport

Trends report from archive statistics.

ArchiveStatsEnvelope

Archive statistics result envelope.

BrainEntryRef

Compact brain entry reference used in contradiction analysis.

BrainEntrySummary

Brain entry reference with summary, used in superseded analysis.

ContradictionDetail

Contradiction detail between two brain entries.

SupersededEntry

Superseded entry pair showing old and replacement entries.

OutputFormat

Output format options.

DateFormat

Date format options.

OutputConfig

Output configuration.

BackupConfig

Backup configuration.

EnforcementProfile

Hierarchy enforcement profile preset.

HierarchyConfig

Hierarchy configuration.

SessionConfig

Session configuration.

LogLevel

Pino log levels.

LoggingConfig

Logging configuration.

LifecycleEnforcementMode

Lifecycle enforcement mode.

LifecycleConfig

Lifecycle enforcement configuration.

SharingMode

Sharing mode: whether .cleo/ files are committed to the project git repo.

SharingConfig

Sharing configuration for multi-contributor .cleo/ state management.

SignalDockMode

SignalDock transport mode.

SignalDockConfig

SignalDock integration configuration.

CleoConfig

CLEO project configuration (config.json).

ConfigSource

Configuration resolution priority.

ResolvedValue

A resolved config value with its source.

SessionScope

Session scope JSON blob shape.

SessionStats

Session statistics.

SessionTaskWork

Active task work state within a session.

Session

Session domain type — plain interface aligned with Drizzle sessions table.

SessionStartResult

Result of a session start operation. The sessionId field is a convenience alias for session.id, provided for consumers that expect it at the top level of the result.

ArchiveFields

Archive-specific fields for task upsert.

ArchiveFile

Archive file structure.

TaskQueryFilters

Filter bag for queryTasks(). Covers ~90% of task query patterns.

QueryTasksResult

Result from queryTasks() with pagination support.

TaskFieldUpdates

Partial task row fields for updateTaskFields().

TransactionAccessor

Subset of DataAccessor methods available inside a transaction callback. Write-only — reads use the outer accessor (snapshot isolation).

DataAccessor

DataAccessor interface. Core modules call these methods instead of readJson/saveJson. Each method maps directly to the file-level operations that core modules already perform.

AdapterManifest

DetectionPattern

ExitCode

CLEO exit codes — canonical definitions shared across all layers. Ranges: 0 = success, 1-99 = errors, 100+ = special (non-error) states. T4454 T4456 T5710

LAFSErrorCategory

LAFS error category.

LAFSError

LAFS error object.

Warning

LAFS warning.

LAFSTransport

LAFS transport metadata.

MVILevel

MVI (Minimal Viable Information) level.

LAFSPageNone

LAFS page — no pagination.

LAFSPageOffset

LAFS page — offset-based pagination.

LAFSPage

LAFS page union.

LAFSMeta

LAFS metadata block.

LAFSEnvelope

LAFS envelope (canonical protocol type).

FlagInput

Flag input for conformance checks.

ConformanceReport

Conformance report.

LafsAlternative

Actionable alternative the caller can try.

LafsErrorDetail

LAFS error detail shared between CLI and MCP.

LafsSuccess

LAFS success envelope (CLI).

LafsError

LAFS error envelope (CLI).

LafsEnvelope

CLI envelope union type.

GatewayMeta

Metadata attached to every MCP gateway response. Extends the canonical LAFSMeta with CLEO gateway-specific fields. T4655

GatewaySuccess

MCP success envelope (extends CLI base with _meta).

GatewayError

MCP error envelope (extends CLI base with _meta).

GatewayEnvelope

MCP envelope union type.

CleoResponse

Unified CLEO response envelope. Every CLEO response (CLI or MCP) is a CleoResponse. MCP responses include the _meta field; CLI responses do not.

MemoryBridgeConfig

Memory bridge types for CLEO provider adapters. Defines the shape of .cleo/memory-bridge.md content for cross-provider memory sharing. T5240

MemoryBridgeContent

SessionSummary

BridgeLearning

BridgePattern

BridgeDecision

BridgeObservation

IssueSeverity

Common issue types

IssueArea

IssueType

Diagnostics

IssuesDiagnosticsParams

IssuesDiagnosticsResult

IssuesCreateBugParams

IssuesCreateBugResult

IssuesCreateFeatureParams

IssuesCreateFeatureResult

IssuesCreateHelpParams

IssuesCreateHelpResult

LifecycleStage

Common lifecycle types

GateStatus

StageRecord

Gate

LifecycleCheckParams

LifecycleCheckResult

LifecycleStatusParams

LifecycleStatusResult

LifecycleHistoryParams

LifecycleHistoryEntry

LifecycleHistoryResult

LifecycleGatesParams

LifecycleGatesResult

LifecyclePrerequisitesParams

LifecyclePrerequisitesResult

LifecycleProgressParams

LifecycleProgressResult

LifecycleSkipParams

LifecycleSkipResult

LifecycleResetParams

LifecycleResetResult

LifecycleGatePassParams

LifecycleGatePassResult

LifecycleGateFailParams

LifecycleGateFailResult

Wave

Common orchestration types

SkillDefinition

OrchestrateStatusParams

OrchestrateStatusResult

OrchestrateNextParams

OrchestrateNextResult

OrchestrateReadyParams

OrchestrateReadyResult

OrchestrateAnalyzeParams

OrchestrateAnalyzeResult

OrchestrateContextParams

OrchestrateContextResult

OrchestrateWavesParams

OrchestrateWavesResult

OrchestrateSkillListParams

OrchestrateSkillListResult

OrchestrateBootstrapParams

BrainState

OrchestrateStartupParams

OrchestrateStartupResult

OrchestrateSpawnParams

OrchestrateSpawnResult

OrchestrateHandoffParams

OrchestrateHandoffResult

OrchestrateValidateParams

OrchestrateValidateResult

OrchestrateParallelStartParams

OrchestrateParallelStartResult

OrchestrateParallelEndParams

OrchestrateParallelEndResult

ReleaseType

Common release types

ReleaseGate

ChangelogSection

ReleasePrepareParams

ReleasePrepareResult

ReleaseChangelogParams

ReleaseChangelogResult

ReleaseCommitParams

ReleaseCommitResult

ReleaseTagParams

ReleaseTagResult

ReleasePushParams

ReleasePushResult

ReleaseGatesRunParams

ReleaseGatesRunResult

ReleaseRollbackParams

ReleaseRollbackResult

ResearchEntry

Common research types

ManifestEntry

ResearchShowParams

ResearchShowResult

ResearchListParams

ResearchListResult

ResearchQueryParams

ResearchQueryResult

ResearchPendingParams

ResearchPendingResult

ResearchStatsParams

ResearchStatsResult

ResearchManifestReadParams

ResearchManifestReadResult

ResearchInjectParams

ResearchInjectResult

ResearchLinkParams

ResearchLinkResult

ResearchManifestAppendParams

ResearchManifestAppendResult

ResearchManifestArchiveParams

ResearchManifestArchiveResult

SessionOp

Common session types

SessionStatusParams

SessionStatusResult

SessionListParams

SessionListResult

SessionShowParams

SessionShowResult

SessionHistoryParams

SessionHistoryEntry

SessionHistoryResult

SessionStartParams

SessionStartResult

SessionEndParams

SessionEndResult

SessionResumeParams

SessionResumeResult

SessionSuspendParams

SessionSuspendResult

SessionGcParams

SessionGcResult

SkillCategory

Common skill types

SkillStatus

DispatchStrategy

SkillSummary

SkillDetail

DispatchCandidate

DependencyNode

ValidationIssue

SkillsListParams

SkillsListResult

SkillsShowParams

SkillsShowResult

SkillsFindParams

SkillsFindResult

SkillsDispatchParams

SkillsDispatchResult

SkillsVerifyParams

SkillsVerifyResult

SkillsDependenciesParams

SkillsDependenciesResult

SkillsInstallParams

SkillsInstallResult

SkillsUninstallParams

SkillsUninstallResult

SkillsEnableParams

SkillsEnableResult

SkillsDisableParams

SkillsDisableResult

SkillsConfigureParams

SkillsConfigureResult

SkillsRefreshParams

SkillsRefreshResult

HealthCheck

Common system types

ProjectStats

SystemVersionParams

SystemVersionResult

SystemDoctorParams

SystemDoctorResult

SystemConfigGetParams

SystemConfigGetResult

SystemStatsParams

SystemStatsResult

SystemContextParams

SystemContextResult

SystemInitParams

SystemInitResult

SystemConfigSetParams

SystemConfigSetResult

SystemBackupParams

SystemBackupResult

SystemRestoreParams

SystemRestoreResult

SystemMigrateParams

SystemMigrateResult

SystemSyncParams

SystemSyncResult

SystemCleanupParams

SystemCleanupResult

TaskPriority

TaskOp

MinimalTask

TasksGetParams

TasksGetResult

TasksListParams

TasksListResult

TasksFindParams

TasksFindResult

TasksExistsParams

TasksExistsResult

TasksTreeParams

TaskTreeNode

TasksTreeResult

TasksBlockersParams

Blocker

TasksBlockersResult

TasksDepsParams

TaskDependencyNode

TasksDepsResult

TasksAnalyzeParams

TriageRecommendation

TasksAnalyzeResult

TasksNextParams

SuggestedTask

TasksNextResult

TasksCreateParams

TasksCreateResult

TasksUpdateParams

TasksUpdateResult

TasksCompleteParams

TasksCompleteResult

TasksDeleteParams

TasksDeleteResult

TasksArchiveParams

TasksArchiveResult

TasksUnarchiveParams

TasksUnarchiveResult

TasksReparentParams

TasksReparentResult

TasksPromoteParams

TasksPromoteResult

TasksReorderParams

TasksReorderResult

TasksReopenParams

TasksReopenResult

TasksStartParams

TasksStartResult

TasksStopParams

TasksStopResult

TasksCurrentParams

TasksCurrentResult

ValidationSeverity

Common validation types

ValidationViolation

ComplianceMetrics

ValidateSchemaParams

ValidateSchemaResult

ValidateProtocolParams

ValidateProtocolResult

ValidateTaskParams

ValidateTaskResult

ValidateManifestParams

ValidateManifestResult

ValidateOutputParams

ValidateOutputResult

ValidateComplianceSummaryParams

ValidateComplianceSummaryResult

ValidateComplianceViolationsParams

ValidateComplianceViolationsResult

ValidateTestStatusParams

ValidateTestStatusResult

ValidateTestCoverageParams

ValidateTestCoverageResult

ValidateComplianceRecordParams

ValidateComplianceRecordResult

ValidateTestRunParams

ValidateTestRunResult

TaskRecordRelation

A single task relation entry (string-widened version).

ValidationHistoryEntry

Validation history entry.

TaskRecord

String-widened Task for JSON serialization in dispatch/LAFS layer.

MinimalTaskRecord

Minimal task representation for find results.

TaskSummary

Task summary counts used in dashboard and stats views.

LabelCount

Label frequency entry.

DashboardResult

Dashboard result from system.dash query.

StatsCurrentState

Current state counts used in stats results.

StatsCompletionMetrics

Completion metrics for a given time period.

StatsActivityMetrics

Activity metrics for a given time period.

StatsAllTime

All-time cumulative statistics.

StatsCycleTimes

Cycle time statistics.

StatsResult

Stats result from system.stats query.

LogQueryResult

Log query result from system.log query.

ContextResult

Context monitoring data from system.context query.

SequenceResult

Sequence counter data from system.sequence query.

TaskRef

Compact task reference used across analysis and dependency results.

TaskRefPriority

Task reference with optional priority (used in orchestrator/HITL contexts).

LeveragedTask

Task with leverage score for prioritization.

BottleneckTask

Bottleneck task — blocks other tasks.

TaskAnalysisResult

Task analysis result from tasks.analyze.

TaskDepsResult

Single task dependency result from tasks.deps.

CompleteTaskUnblocked

Completion result — unblocked tasks after completing a task.

Provider

Provider identifier for spawn operations.

CAAMPSpawnOptions

CAAMP-compatible spawn options (inlined for zero-dep contracts).

CAAMPSpawnResult

CAAMP-compatible spawn result (inlined for zero-dep contracts).

CLEOSpawnContext

CLEO-specific spawn context Extends CAAMP options with CLEO task and protocol metadata

CLEOSpawnResult

CLEO spawn result Extends CAAMP SpawnResult with CLEO-specific timing and metadata

CLEOSpawnAdapter

Spawn adapter interface Wraps CAAMP SpawnAdapter with CLEO-specific context and result types

TokenResolution

Token resolution information for prompt processing

SpawnStatus

Spawn status values

ProtocolType

All supported protocol types.

GateName

Verification gate names (ordered dependency chain).

WarpStage

A single stage in the warp chain. The category union includes all canonical CLEO pipeline stages plus ‘custom’ for user-defined stages. Connection between two stages in the chain.

ChainShape

The topology/DAG of a workflow.

GateCheck

Discriminated union for gate check types.

GateContract

A quality gate embedded in the chain.

WarpChain

Complete chain definition combining shape and gates.

ChainValidation

Result of validating a chain definition.

WarpChainInstance

A chain bound to a specific epic.

GateResult

Result of evaluating a single gate.

WarpChainExecution

Runtime state of a chain instance execution.

TesseraVariable

A variable declaration within a Tessera template.

TesseraTemplate

A parameterized WarpChain template with variable bindings.

TesseraInstantiationInput

Input for instantiating a Tessera template into a concrete chain.