Skip to main content

Functions & Classes

SymbolKindDescription
engineError()functionCreate a typed engine error result with pino logging and correct exit code.
engineSuccess()functionCreate an engine success result.
taskShow()functionGet a single task by ID.
taskList()functionList tasks with optional filters.
taskFind()functionFuzzy search tasks by title/description/ID.
taskExists()functionCheck if a task exists.
taskCreate()functionCreate a new task.
taskUpdate()functionUpdate a task’s fields.
taskComplete()functionComplete a task (set status to done).
taskDelete()functionDelete a task.
taskArchive()functionArchive completed tasks. Moves done/cancelled tasks from active task data to…
taskNext()functionSuggest next task to work on based on priority, phase alignment, age, and dep…
taskBlockers()functionShow blocked tasks and analyze blocking chains.
taskTree()functionBuild hierarchy tree.
taskDeps()functionShow dependencies for a task - both what it depends on and what depends on it.
taskRelates()functionShow task relations (existing relates entries).
taskRelatesAdd()functionAdd a relation between two tasks.
taskAnalyze()functionAnalyze a task for description quality, missing fields, and dependency health.
taskImpact()functionPredict downstream impact of a free-text change description. Delegates to…
taskRestore()functionRestore a cancelled task back to pending.
taskUnarchive()functionMove an archived task back to active task data with status ‘done’ (or specifi…
taskReorder()functionChange task position within its sibling group.
taskReparent()functionMove task under a different parent.
taskPromote()functionPromote a subtask to task or task to root (remove parent).
taskReopen()functionReopen a completed task (set status back to pending).
taskCancel()functionCancel a task (soft terminal state — reversible via restore).
taskComplexityEstimate()functionDeterministic complexity scoring from task metadata.
taskDepends()functionList dependencies for a task in a given direction. T4657 T4790 T4654
taskDepsOverview()functionOverview of all dependencies across the project. T5157
taskDepsCycles()functionDetect circular dependencies across the project. T5157
taskStats()functionCompute task statistics, optionally scoped to an epic. T4657 T4790 T4654
taskExport()functionExport tasks as JSON or CSV. T4657 T4790 T4654
taskHistory()functionGet task history from the log file. T4657 T4790 T4654
taskLint()functionLint tasks for common issues. T4657 T4790 T4654
taskBatchValidate()functionValidate multiple tasks at once. T4657 T4790 T4654
taskImport()functionImport tasks from a JSON source string or export package. T4790
taskPlan()functionCompute a ranked plan: in-progress epics, ready tasks, blockers, bugs. T4815
taskRelatesFind()functionFind related tasks using semantic search or keyword matching. T5672
taskLabelList()functionList all labels used in tasks. T5672
taskLabelShow()functionShow tasks associated with a label. T5672
taskSyncReconcile()functionReconcile external tasks with CLEO as SSoT.
taskSyncLinks()functionList external task links by provider or task ID.
taskSyncLinksRemove()functionRemove all external task links for a provider.
taskClaim()functionAtomically claim a task for an agent. Fails if the task is already claimed b…
taskUnclaim()functionRelease an agent’s claim on a task, setting assignee to null. No-op if the t…
sessionStatus()functionGet current session status.
sessionList()functionList sessions with budget enforcement. When a limit is applied (explicit or…
sessionFind()functionLightweight session discovery — returns minimal session records.
sessionShow()functionShow a specific session by ID.
taskCurrentGet()functionGet current task being worked on. Delegates to core/task-work/currentTask. T…
taskStart()functionStart working on a specific task. Delegates to core/task-work/startTask. T4782
taskStop()functionStop working on the current task. Delegates to core/task-work/stopTask. T4782
taskWorkHistory()functionGet task work history from session notes. T5323
sessionStart()functionStart a new session. Note: This function has engine-specific logic for task f…
sessionEnd()functionEnd the current session. Note: This function has engine-specific logic for ta…
sessionResume()functionResume an ended or suspended session. Note: This function has engine-specific…
sessionGc()functionGarbage collect old sessions. T4782
sessionSuspend()functionSuspend an active session. T4782
sessionHistory()functionList session history with focus changes and completed tasks. T4782
sessionCleanup()functionRemove orphaned sessions and clean up stale data. T4782
sessionRecordDecision()functionRecord a decision to the audit trail. T4782
sessionDecisionLog()functionRead the decision log, optionally filtered by sessionId and/or taskId. T4782
sessionContextDrift()functionCompute context drift score for the current session. T4782
sessionRecordAssumption()functionRecord an assumption made during a session. T4782
sessionStats()functionCompute session statistics, optionally for a specific session. T4782
sessionSwitch()functionSwitch to a different session. T4782
sessionArchive()functionArchive old/ended sessions. T4782
sessionHandoff()functionGet handoff data for the most recent ended session. T4915, T5123
sessionComputeHandoff()functionCompute and persist handoff data for a session. T4915
sessionBriefing()functionCompute session briefing - composite view for session start. Aggregates data…
sessionComputeDebrief()functionCompute and persist rich debrief data for a session. Persists as both handoff…
sessionDebriefShow()functionRead a session’s debrief data. Falls back to handoff data if no debrief is av…
sessionChainShow()functionShow the session chain for a given session. Returns ordered list of sessions…
sessionContextInject()functionInject context protocol content. T5673
listRcsdEpics()functionList all epic IDs that have RCASD pipeline data.
lifecycleStatus()functionlifecycle.check / lifecycle.status - Get lifecycle status for epic. T4785
lifecycleHistory()functionlifecycle.history - Stage transition history. T4785
lifecycleGates()functionlifecycle.gates - Get all gate statuses for an epic. T4785
lifecyclePrerequisites()functionlifecycle.prerequisites - Get required prior stages for a target stage. T4785
lifecycleCheck()functionlifecycle.check - Check if a stage’s prerequisites are met. T4785
lifecycleProgress()functionlifecycle.progress / lifecycle.record - Record stage completion. T4785
lifecycleSkip()functionlifecycle.skip - Skip a stage with reason. T4785
lifecycleReset()functionlifecycle.reset - Reset a stage (emergency). T4785
lifecycleGatePass()functionlifecycle.gate.pass - Mark gate as passed. T4785
lifecycleGateFail()functionlifecycle.gate.fail - Mark gate as failed. T4785
createGatewayMeta()functionCreate a fully typed GatewayMeta for domain responses.
enforceBudget()functionApply budget enforcement to a dispatch response envelope. Converts the Domai…
isWithinBudget()functionQuick check whether a response exceeds a token budget without modifying it…
ShimCommandclassMinimal Commander-compatible Command class. Captures command definitions for…
setFieldContext()functionSet the field extraction context for this CLI invocation. Called once from th…
getFieldContext()functionGet the current field extraction context.
resolveFieldContext()functionParse global field options from Commander.js parsed opts and resolve via the…
setFormatContext()functionSet the resolved format for this CLI invocation. Called once from the preActi…
getFormatContext()functionGet the current resolved format.
isJsonFormat()functionCheck if output should be JSON format.
isHumanFormat()functionCheck if output should be human-readable format.
isQuiet()functionCheck if quiet mode is enabled (suppress non-essential output).
resolveFormat()functionResolve output format from Commander.js option values. Reads —json, —human…
validateLafsShape()functionValidate a LAFS envelope shape and report violations. Full envelopes are del…
assertLafsShape()functionAssert that a LAFS envelope conforms to the shape contract, throwing an error…
LafsViolationErrorclassError thrown by assertLafsShape when an envelope fails validation. Carries…
emitLafsViolation()functionEmit a LAFS-shaped error envelope describing a validation failure and set…
normalizeForHuman()functionNormalize data shape for human renderers. Each command expects data with spe…
statusSymbol()functionMap task status to a display symbol. Falls back to ’?’ for unknown values.
statusColor()functionMap task status to a color escape.
prioritySymbol()functionMap task priority to a display symbol.
priorityColor()functionMap task priority to a color escape.
hRule()functionCreate a horizontal rule with box-drawing characters.
shortDate()functionFormat a date string as YYYY-MM-DD.
renderDoctor()function
renderStats()function
renderNext()function
renderBlockers()function
renderTree()function
renderStart()function
renderStop()function
renderCurrent()function
renderSession()function
renderVersion()function
renderPlan()function
renderGeneric()functionGeneric human renderer for commands that don’t have a specific renderer. Rend…
renderShow()functionRender a single task in a box format (mirrors bash display_text).
renderList()functionRender a list of tasks (mirrors bash list.sh text output).
renderFind()functionRender search results.
renderAdd()functionRender add result.
renderUpdate()functionRender update result.
renderComplete()functionRender complete result.
renderDelete()functionRender delete result.
renderArchive()functionRender archive result.
renderRestore()functionRender restore result.
cliOutput()functionOutput data to stdout in the resolved format (JSON or human-readable). Repla…
cliError()functionOutput an error in the resolved format. For JSON: delegates to formatError (a…
createDispatchMeta()functionCreate metadata for a dispatch response.
compose()functionComposes an array of Middleware functions into a single Middleware function…
deriveGatewayMatrix()functionDerive a gateway operation matrix from the registry. Returns…
getGatewayDomains()functionGet all accepted domain names for a gateway (canonical only).
resolve()functionResolves a domain + operation to its registered definition.
validateRequiredParams()functionValidates that all required parameters are present in the request. Returns an…
getByDomain()functionGet all operations for a specific canonical domain.
getByGateway()functionGet all operations for a specific gateway.
getByTier()functionGet all operations available at or below a specific tier.
getActiveDomains()functionGet a list of canonical domains that actually have operations registered.
getCounts()functionReturns summary counts of operations for module validation.
Dispatcherclass
mapCodebase()functionAnalyze a codebase and return structured mapping. When storeToBrain is true,…
configGet()functionGet config value by key (dot-notation supported)
configSet()functionSet a config value by key (dot-notation supported)
configSetPreset()functionApply a strictness preset to the project config. T067
configListPresets()functionList all available strictness presets. T067
queryHookProviders()functionQuery providers that support a specific hook event Returns detailed provider…
queryCommonHooks()functionGet hook events common to specified providers Analyzes which hook events are…
systemHooksMatrix()functionBuild a cross-provider hook support matrix using CAAMP APIs. Calls…
initProject()functionInitialize a CLEO project directory. Creates the .cleo/ directory structure…
isAutoInitEnabled()functionCheck if auto-init is enabled via environment variable
ensureInitialized()functionCheck initialization status and auto-init if configured
getVersion()functionGet current version (native implementation)
orchestrateStatus()functionorchestrate.status - Get orchestrator status T4478
orchestrateAnalyze()functionorchestrate.analyze - Dependency analysis T4478
orchestrateReady()functionorchestrate.ready - Get parallel-safe tasks (ready to execute) T4478
orchestrateNext()functionorchestrate.next - Next task to spawn T4478
orchestrateWaves()functionorchestrate.waves - Compute dependency waves T4478
orchestrateContext()functionorchestrate.context - Context usage check T4478
orchestrateValidate()functionorchestrate.validate - Validate spawn readiness for a task T4478
orchestrateSpawnSelectProvider()functionorchestrate.spawn.select - Select best provider for spawn based on required c…
orchestrateSpawnExecute()functionorchestrate.spawn.execute - Execute spawn for a task using adapter registry…
orchestrateSpawn()functionorchestrate.spawn - Generate spawn prompt for a task T4478
orchestrateStartup()functionorchestrate.startup - Initialize orchestration for an epic T4478
orchestrateBootstrap()functionorchestrate.bootstrap - Load brain state for agent bootstrapping T4478 T4657
orchestrateCriticalPath()functionorchestrate.critical-path - Find the longest dependency chain T4478
orchestrateUnblockOpportunities()functionorchestrate.unblock-opportunities - Analyze dependency graph for unblocking o…
orchestrateParallel()functionorchestrate.parallel - Manage parallel execution (start/end) T4632
orchestrateParallelStart()functionorchestrate.parallel.start - Start parallel execution for a wave T4632
orchestrateParallelEnd()functionorchestrate.parallel.end - End parallel execution for a wave T4632
orchestrateCheck()functionorchestrate.check - Check current orchestration state T4632
orchestrateSkillInject()functionorchestrate.skill.inject - Read skill content for injection into agent contex…
orchestrateHandoff()functionorchestrate.handoff - Composite session handoff + successor spawn Step order…
phaseList()functionphase.list - List all project phases
phaseShow()functionphase.show - Show details of a specific phase
phaseSet()functionphase.set - Set the current phase
phaseStart()functionphase.start - Start a pending phase
phaseComplete()functionphase.complete - Complete an active phase
phaseAdvance()functionphase.advance - Advance to the next phase
phaseRename()functionphase.rename - Rename a phase
phaseDelete()functionphase.delete - Delete a phase
releasePrepare()functionrelease.prepare - Prepare a release T4788
releaseChangelog()functionrelease.changelog - Generate changelog T4788
releaseList()functionrelease.list - List all releases (query operation via data read) T4788
releaseShow()functionrelease.show - Show release details (query operation via data read) T4788
releaseCommit()functionrelease.commit - Mark release as committed (metadata only) T4788
releaseTag()functionrelease.tag - Mark release as tagged (metadata only) T4788
releaseGatesRun()functionrelease.gates.run - Run release gates (validation checks) T4788
releaseRollback()functionrelease.rollback - Rollback a release T4788
releaseCancel()functionrelease.cancel - Cancel and remove a release in draft or prepared state T5602
releasePush()functionrelease.push - Push release to remote via git Uses execFileSync (no shell) fo…
releaseShip()functionrelease.ship - Composite release operation Sequence: validate gates → epic c…
systemDash()functionProject dashboard: task counts by status, active session info, current focus,…
systemStats()functionDetailed statistics: tasks by status/priority/type/phase, completion rate, av…
systemLabels()functionList all unique labels across tasks with counts and task IDs per label.
systemArchiveStats()functionArchive metrics: total archived, by reason, average cycle time, archive rate.
systemLog()functionQuery audit log with optional filters. Reads from SQLite audit_log table. T…
systemContext()functionContext window tracking: estimate token usage from current session/state.
systemSequence()functionRead task ID sequence state from canonical SQLite metadata. Supports ‘show’ a…
systemInjectGenerate()functionGenerate Minimum Viable Injection (MVI).
systemMetrics()functionSystem metrics: token usage, compliance summary, session counts. T4631
systemHealth()functionSystem health check: verify core data files exist and are valid. T4631
systemDiagnostics()functionSystem diagnostics: extended health checks with fix suggestions. T4631
systemHelp()functionReturn help text for the system. T4631
systemRoadmap()functionGenerate roadmap from pending epics and optional CHANGELOG history. T4631
systemCompliance()functionSystem compliance report from COMPLIANCE.jsonl. T4631
systemBackup()functionCreate a backup of CLEO data files. T4631
systemListBackups()functionList available system backups (read-only). T4783
systemRestore()functionRestore from a backup. T4631
backupRestore()functionRestore an individual file from backup. T5329
systemMigrate()functionCheck/run schema migrations. T4631
systemCleanup()functionCleanup stale data (sessions, backups, logs). T4631
systemAudit()functionAudit data integrity. T4631
systemSync()functionSync check (no external sync targets in native mode). T4631
systemSafestop()functionSafe stop: signal clean shutdown for agents. T4631
systemUncancel()functionUncancel a cancelled task (restore to pending). T4631
systemDoctor()functionRun comprehensive doctor diagnostics. T4795
systemFix()functionRun auto-fix for failed doctor checks. T4795
systemRuntime()functionRuntime/channel diagnostics for CLI installation mode checks. T4815
systemPaths()functionReport all resolved CleoOS paths (project + global hub). Backs the…
systemScaffoldHub()functionCreate the CleoOS Hub directories and seed the starter justfile if absent. I…
systemSequenceRepair()functionRepair task ID sequence using canonical core implementation. T4815
systemSmoke()functionRun operational smoke tests across all domains. Dispatches one read-only que…
parseIssueTemplates()functionParse all templates from the repo’s .github/ISSUE_TEMPLATE/ directory.
getTemplateForSubcommand()functionGet template config for a specific subcommand (bug/feature/help).
generateTemplateConfig()functionGenerate and cache the config as .cleo/issue-templates.json.
validateLabels()functionValidate that labels exist on a GitHub repo.
validateSchemaOp()functionvalidate.schema - JSON Schema validation T4477
validateTask()functionvalidate.task - Anti-hallucination task validation T4477
validateProtocol()functionvalidate.protocol - Protocol compliance check T4477
validateManifest()functionvalidate.manifest - Manifest entry validation T4477
validateOutput()functionvalidate.output - Output file validation T4477
validateComplianceSummary()functionvalidate.compliance.summary - Aggregated compliance metrics T4477
validateComplianceViolations()functionvalidate.compliance.violations - List compliance violations T4477
validateComplianceRecord()functionvalidate.compliance.record - Record compliance check result T4477
validateTestStatus()functionvalidate.test.status - Test suite status T4477
validateCoherenceCheck()functionvalidate.coherence-check - Cross-validate task graph for consistency T4477
validateTestRun()functionvalidate.test.run - Execute test suite via subprocess T4632
validateBatchValidate()functionvalidate.batch-validate - Batch validate all tasks against schema and rules…
validateTestCoverage()functionvalidate.test.coverage - Coverage metrics T4477
validateProtocolConsensus()functioncheck.protocol.consensus - Validate consensus protocol compliance T5327
validateProtocolContribution()functioncheck.protocol.contribution - Validate contribution protocol compliance T5327
validateProtocolDecomposition()functioncheck.protocol.decomposition - Validate decomposition protocol compliance T5327
validateProtocolImplementation()functioncheck.protocol.implementation - Validate implementation protocol compliance…
validateProtocolSpecification()functioncheck.protocol.specification - Validate specification protocol compliance T5327
validateProtocolResearch()functioncheck.protocol.research - Validate research protocol compliance T260
validateProtocolArchitectureDecision()functioncheck.protocol.architecture-decision - Validate ADR protocol compliance T260
validateProtocolValidation()functioncheck.protocol.validation - Validate validation-stage protocol compliance T260
validateProtocolTesting()functioncheck.protocol.testing - Validate testing-stage protocol compliance (IVT loop…
validateProtocolRelease()functioncheck.protocol.release - Validate release protocol compliance T260
validateProtocolArtifactPublish()functioncheck.protocol.artifact-publish - Validate artifact-publish protocol complian…
validateProtocolProvenance()functioncheck.protocol.provenance - Validate provenance protocol compliance T260
validateGateVerify()functioncheck.gate.verify - View or modify verification gates for a task T5327
dispatchMeta()functionBuild metadata for a dispatch domain response.
wrapResult()functionWrap a native engine result into a DispatchResponse. Handles success data, pa…
errorResult()functionReturn a standard error response.
unsupportedOp()functionReturn a standard “unsupported operation” error response.
getListParams()functionExtract limit and offset pagination params from a params dict.
handleErrorResult()functionHandle a caught error: extract message and return an internal error response…
routeByParam()functionShared parameter-based routing for merged operations. DRY utility — all doma…
BackgroundJobManagerclassManages background jobs for long-running operations
setJobManager()function
getJobManager()function
AdminHandlerclass
CheckHandlerclass
ConduitHandlerclassConduit dispatch handler for agent messaging operations.
MemoryHandlerclass
nexusStatus()functionGet nexus status (initialized, project count, last updated).
nexusListProjects()functionList all registered projects.
nexusShowProject()functionShow a single project by name.
nexusResolve()functionResolve a cross-project task query.
nexusDepsQuery()functionGet cross-project dependencies for a task query.
nexusGraph()functionBuild the global dependency graph.
nexusCriticalPath()functionGet the critical path across projects.
nexusBlockers()functionAnalyze blockers for a task query.
nexusOrphans()functionList orphaned cross-project tasks.
nexusDiscover()functionDiscover tasks related to a given task query across projects. Delegates all b…
nexusSearch()functionSearch for tasks across all registered projects. Delegates all business logic…
nexusInitialize()functionInitialize the nexus.
nexusRegisterProject()functionRegister a project in the nexus.
nexusUnregisterProject()functionUnregister a project from the nexus.
nexusSyncProject()functionSync a specific project or all projects.
nexusSetPermission()functionSet permission level for a project.
nexusReconcileProject()functionReconcile the nexus registry with the filesystem.
nexusShareStatus()functionGet sharing status for a project.
nexusShareSnapshotExport()functionExport a snapshot of the project’s tasks.
nexusShareSnapshotImport()functionImport a snapshot into the project.
nexusTransferPreview()functionPreview a cross-project task transfer (dry run).
nexusTransferExecute()functionExecute a cross-project task transfer.
NexusHandlerclass
OrchestrateHandlerclass
PipelineHandlerclass
bindSession()functionBind a session to the current process. Called by session.start mutation handl…
getBoundSession()functionGet the currently bound session context, or null if none is bound.
hasSession()functionCheck whether a session is currently bound.
unbindSession()functionUnbind the current session context. Called by session.end mutation handler.
resetSessionContext()functionReset the session context (for testing only).
SessionHandlerclass
stickyAdd()functionCreate a new sticky note.
stickyList()functionList sticky notes with optional filtering.
stickyShow()functionGet a single sticky note by ID.
stickyConvertToTask()functionConvert a sticky note to a task.
stickyConvertToMemory()functionConvert a sticky note to a memory observation.
stickyArchive()functionArchive a sticky note.
stickyConvertToTaskNote()functionConvert a sticky note to a task note.
stickyConvertToSessionNote()functionConvert a sticky note to a session note.
stickyPurge()functionPurge (permanently delete) a sticky note.
StickyHandlerclass
TasksHandlerclass
codeOutline()functioncode.outline — file structural skeleton.
codeSearch()functioncode.search — cross-codebase symbol search.
codeUnfold()functioncode.unfold — single symbol extraction.
codeParse()functioncode.parse — raw AST parse for a single file.
toolsIssueDiagnostics()functionCollect issue diagnostics.
toolsSkillList()functionList all discovered skills.
toolsSkillShow()functionShow a single skill by name.
toolsSkillFind()functionFind skills matching a query string.
toolsSkillDispatch()functionGet dispatch matrix entries for a skill.
toolsSkillVerify()functionVerify a skill’s installation and catalog status.
toolsSkillDependencies()functionGet dependency tree for a skill.
toolsSkillSpawnProviders()functionGet spawn-capable providers by capability.
toolsSkillCatalogInfo()functionGet catalog info (protocols, profiles, resources, or summary).
toolsSkillCatalogProtocols()functionList catalog protocols.
toolsSkillCatalogProfiles()functionList catalog profiles.
toolsSkillCatalogResources()functionList catalog shared resources.
toolsSkillPrecedenceShow()functionShow skill precedence map.
toolsSkillPrecedenceResolve()functionResolve skill paths for a specific provider.
toolsSkillInstall()functionInstall a skill to one or more providers.
toolsSkillUninstall()functionUninstall a skill from all providers.
toolsSkillRefresh()functionRefresh all tracked skills that have updates available.
toolsProviderList()functionList all registered providers.
toolsProviderDetect()functionDetect all available providers in the environment.
toolsProviderInjectStatus()functionCheck injection status for all installed providers.
toolsProviderSupports()functionCheck if a provider supports a specific capability.
toolsProviderHooks()functionQuery hook providers for a specific event.
toolsProviderInject()functionInject CLEO directives into all installed provider instruction files.
toolsAdapterList()functionList all discovered adapters.
toolsAdapterShow()functionShow a single adapter by ID.
toolsAdapterDetect()functionDetect active adapters.
toolsAdapterHealth()functionGet adapter health status.
toolsAdapterActivate()functionActivate an adapter by ID.
toolsAdapterDispose()functionDispose one or all adapters.
ToolsHandlerclass
createDomainHandlers()functionCreate a Map of all canonical domain handlers.
RateLimiterclassSliding-window rate limiter for the dispatch pipeline.
createRateLimiter()functionCreates a rate limiting middleware for the dispatch pipeline.
ConfigValidationErrorclassConfiguration validation error
validateConfig()functionValidate complete configuration
loadConfig()functionLoad configuration from all sources Priority order: 1. Environment variables…
getConfig()functionGet global configuration (singleton)
resetConfig()functionReset global configuration (for testing)
createAudit()functionCreates an audit middleware that logs all mutate operations (and query operat…
createFieldFilter()functionCreate the LAFS field-filter middleware. Handles: - _fields: filter response…
createSanitizer()functionCreates a middleware that sanitizes incoming request parameters. Uses the can…
createSessionResolver()functionCreates the session resolver middleware.
getCliDispatcher()functionGet or create the singleton CLI dispatcher. Creates a Dispatcher with all 9…
createCliDispatcher()functionFactory: creates a Dispatcher with all domain handlers + session-resolver, sa…
resetCliDispatcher()functionReset the singleton dispatcher (for testing).
dispatchFromCli()functionBuild a DispatchRequest, dispatch it, and handle output/errors. This is the…
handleRawError()functionHandle an error response from dispatchRaw(). Calls cliError() and process.ex…
dispatchRaw()functionDispatch and return the raw response without handling output. For commands t…
registerAddCommand()functionRegister the add command. T4460
registerAdminCommand()functionRegister the admin command group.
registerAdrCommand()function
registerAgentCommand()functionRegister the cleo agent command group.
registerAgentsCommand()functionRegister agents as an alias that prints deprecation notice. Health monitori…
registerAnalyzeCommand()functionRegister the analyze command. T4538
registerArchiveCommand()functionRegister the archive command. T4461
registerArchiveStatsCommand()functionRegister the archive-stats command. Routes through dispatch layer to admin.ar…
registerBackfillCommand()functionRegister the cleo backfill CLI command.
registerBackupCommand()function
registerBlockersCommand()function
registerBrainCommand()functionRegister the cleo brain command group. Registers a brain parent command…
registerBriefingCommand()functionRegister the briefing command. T4916
registerBugCommand()functionRegister the bug command. T4913
registerCantCommand()function
registerCheckCommand()functionRegister the check command group.
registerCheckpointCommand()functionRegister the checkpoint command. Delegates to src/store/git-checkpoint.ts for…
registerCommandsCommand()functionRegister the commands command. T4551, T5671
registerCompleteCommand()functionRegister the complete command. T4461
registerComplianceCommand()function
registerConfigCommand()function
registerConsensusCommand()functionRegister the consensus command group. T4537
registerContextCommand()function
registerContributionCommand()functionRegister the contribution command group. T4537
registerCurrentCommand()functionRegister the current command. T4756 T4666
registerDashCommand()functionRegister the dash command. T4535
registerDecompositionCommand()functionRegister the decomposition command group. T4537
registerDeleteCommand()functionRegister the delete command. T4461
registerDepsCommand()functionRegister the deps command group and its subcommands.
registerTreeCommand()functionRegister the tree command.
registerDetectCommand()function
registerDetectDriftCommand()function
registerDocsCommand()functionRegister the docs command. T4551
ProgressTrackerclassSimple progress tracker for CLI operations.
SpinnerclassSimple spinner for indeterminate progress.
createSelfUpdateProgress()functionCreate a progress tracker for self-update operations.
createDoctorProgress()functionCreate a progress tracker for doctor operations.
createUpgradeProgress()functionCreate a progress tracker for upgrade operations.
registerDoctorCommand()function
registerEnvCommand()functionRegister the env command group. T4581
registerExistsCommand()functionRegister the exists command.
registerExportCommand()function
registerExportTasksCommand()function
registerFindCommand()functionRegister the find command. T4460 T4668
registerGenerateChangelogCommand()functionRegister the generate-changelog command. T4555
registerGradeCommand()function
registerHistoryCommand()function
registerImplementationCommand()functionRegister the implementation command group. T4537
registerImportCommand()function
registerImportTasksCommand()function
getGitignoreTemplate()functionLoad the gitignore template from the package’s templates/ directory. Falls ba…
registerInitCommand()functionRegister the init command. T4681 T4663
registerInjectCommand()function
registerIssueCommand()functionRegister the issue command with all subcommands. T4555
registerLabelsCommand()functionRegister the labels command group. T4538
registerLifecycleCommand()function
registerListCommand()functionRegister the list command. T4460 T4668
registerLogCommand()functionRegister the log command. T4538
registerMapCommand()functionRegister the map command.
registerMemoryBrainCommand()function
registerMigrateClaudeMemCommand()functionRegister the migrate claude-mem command under a migrate parent command. Us…
registerNextCommand()function
registerNexusCommand()functionRegister the nexus command group. T4554
registerObserveCommand()function
registerOpsCommand()functionRegister the ops command.
registerOrchestrateCommand()function
registerOtelCommand()functionRegister the otel command group. T4535
registerPhaseCommand()functionRegister the phase command group. T4464, T5326
registerPhasesCommand()functionRegister the phases command group. T4538, T5326
registerPlanCommand()function
registerPromoteCommand()function
registerReasonCommand()functionRegister the cleo reason command group and its subcommands.
registerRefreshMemoryCommand()function
registerRelatesCommand()functionRegister the relates command group. T4538
registerReleaseCommand()function
registerRemoteCommand()functionRegister the remote command with add/remove/list/push/pull subcommands. T4884
registerReorderCommand()function
registerReparentCommand()function
registerResearchCommand()function
registerRestoreCommand()function
registerRoadmapCommand()function
registerSafestopCommand()functionRegister the safestop command. T4551
registerSelfUpdateCommand()function
registerSequenceCommand()function
registerSessionCommand()functionRegister the session command group. T4463
registerShowCommand()functionRegister the show command. T4460 T4666
registerSkillsCommand()functionRegister the skills command with all subcommands. T4555
registerSnapshotCommand()function
registerSpecificationCommand()functionRegister the specification command group. T4537
registerStartCommand()functionRegister the start command. T4756 T4666
registerStatsCommand()functionRegister the stats command. T4535
registerStickyCommand()functionRegister the sticky command group. T5281
registerStopCommand()functionRegister the stop command. T4756 T4666
registerTestingCommand()functionRegister the testing command. T4551
registerTokenCommand()function
registerUpdateCommand()functionRegister the update command. T4461
registerUpgradeCommand()function
registerValidateCommand()function
registerVerifyCommand()function
registerWebCommand()functionRegister the web command. T4551
initCliLogger()functionInitialize CLI logger with optional projectHash correlation context.
registerDynamicCommands()functionRegister dynamically-generated commands onto the Commander program. Stub imp…
renderErrorMarkdown()functionRender a CleoError as structured markdown for CLI display.
createProtocolEnforcement()functionCreates a middleware that enforces protocol compliance. Delegates to Protoco…
createVerificationGates()functionCreates a middleware that enforces verification gates on task operations.
getOperationSchema()functionLook up an operation in the OPERATIONS registry and return a JSON Schema obje…
getAllOperationSchemas()functionReturn schemas for ALL operations of a given gateway. Useful for documentati…
resolveTier()functionResolve tier from request params, defaulting to ‘standard’.
isOperationAllowed()functionCheck if a domain is allowed at the given tier.
applyProjection()functionApply field projection to a result object. Removes fields that are excluded a…
createProjectionContext()functionCreate projection context from request params.
createProjectionMiddleware()functionCreate the MVI projection middleware. Extracts _mviTier from params, checks…

Types & Interfaces

SymbolKindDescription
TaskRecordinterfaceTask object as stored in task data.
MinimalTaskRecordinterfaceMinimal task representation for find results.
GatewayMetaRecordtypeGatewayMeta with an index signature for DomainResponse._meta compatibility…
ShimOptioninterfaceParsed option definition.
ShimArginterfacePositional argument definition.
CommanderCompatOptioninterfaceCommander-compatible option view for tests.
ActionHandlertypeType for the action handler function - flexible to support various signatures
LafsShapeViolationinterfaceThe minimum shape invariants for a LAFS envelope, compatible with both minima…
CliOutputOptionsinterface
CliErrorDetailsinterfaceError details for structured error output.
GatewaytypeCQRS gateway: read-only queries vs state-modifying mutations.
SourcetypeWhere the request originated.
TiertypeProgressive disclosure tier. 0 = tasks + session (80% of agents) 1 = + memory…
ParamTypetypeThe concrete value types a parameter can carry at runtime. Drives JSON Schema…
ParamCliDefinterfaceCLI-specific decoration for a parameter. All fields are optional — omit the e…
ParamDefinterfaceA fully-described parameter definition. One ParamDef entry drives Commande…
CanonicalDomaintype
DispatchRequestinterfaceCanonical request shape that the CLI adapter produces. The dispatcher valida…
RateLimitMetainterfaceRate limit metadata attached to every response.
DispatchErrorinterfaceStructured error shape (LAFS-compatible).
DispatchResponseinterfaceCanonical response shape returned by the dispatcher. The CLI adapter transla…
DomainHandlerinterfaceContract for domain handlers. Each of the 9 target domains (tasks, session,…
DispatchNexttypeAsync function that produces a DispatchResponse.
MiddlewaretypeMiddleware function signature. Receives the request and a next continuatio…
OperationDefinterfaceDefinition of a single dispatchable operation.
ResolutioninterfaceResolution output for a dispatch request.
DispatcherConfiginterface
ProviderMatrixEntryinterfaceCoverage summary for a single provider in the hook matrix.
HookMatrixResultinterfaceFull hook matrix result.
RuntimeDatatype
DashboardDatainterfaceDashboard data shape returned by systemDash.
StatsDatainterfaceProject statistics data shape returned by systemStats.
LogQueryDatainterfacePaginated operation log query result.
ContextDatainterfaceContext window monitoring data.
SequenceDatainterfaceTask ID sequence state.
RoadmapDatainterfaceProject roadmap data with upcoming epics and release history.
ComplianceDatainterfaceCompliance monitoring data.
HelpDatainterfaceHelp topic content and related commands.
SyncDatainterface
PathsDatainterfaceSummary of all resolved CleoOS paths (project + global hub).
ScaffoldHubDatainterfaceResult of scaffolding the CleoOS Hub.
SmokeProbeinterfaceResult for a single domain smoke probe.
SmokeResultinterfaceAggregate smoke test result.
EngineResultinterfaceEngine result shape accepted by wrapResult. Matches the union of what all eng…
JobStatustypeBackground job status
BackgroundJobinterfaceBackground job representation
BackgroundJobManagerConfiginterfaceConfiguration for BackgroundJobManager
SessionContextinterfaceImmutable snapshot of the bound session context.
RateLimitConfiginterfacePer-category rate limit thresholds.
RateLimitingConfiginterfaceFull rate limiting configuration across all categories.
LifecycleEnforcementConfiginterfaceLifecycle enforcement configuration (Section 12.2)
ProtocolValidationConfiginterfaceProtocol validation configuration (Section 12.3)
DispatchConfiginterface
MCPConfigtypeAlias for DispatchConfig.
ProgressOptionsinterface
MviTiertypeDisclosure tier level for MVI (Minimum Viable Information) filtering.
ProjectionConfiginterfaceConfiguration for a single MVI projection tier.
ProjectionContextinterface

Other Exports

SymbolKindDescription
STRING_TO_EXITvariableCanonical mapping from string error codes to numeric exit codes. Source of t…
_error.tsfile
task-engine.tsfile
session-engine.tsfile
lifecycle-engine.tsfile
core-parity.test.tsfile
gateway-meta.tsfile
golden-parity.test.tsfile
budget.tsfile
lafs-conformance.test.tsfile
commander-shim.tsfile
field-context.tsfile
format-context.tsfile
output-format.tsfile
lafs-validator.tsfile
normalizer.tsfile
BOLDvariable
DIMvariable
NCvariable
REDvariable
GREENvariable
YELLOWvariable
BLUEvariable
MAGENTAvariable
CYANvariable
BOXvariable
colors.tsfile
system.tsfile
tasks.tsfile
index.tsfile
CANONICAL_DOMAINSvariableThe 10 canonical domain names.
types.tsfile
meta.tsfile
pipeline.tsfile
OPERATIONSvariableThe single source of truth for all operations in CLEO.
registry.tsfile
dispatcher.tsfile
codebase-map-engine.tsfile
config-engine.tsfile
hooks-engine.tsfile
init-engine.tsfile
memory-engine.tsfile
orchestrate-engine.tsfile
pipeline-engine.tsfile
release-engine.tsfile
system-engine.tsfile
template-parser.tsfile
validate-engine.tsfile
engine.tsfile
_meta.tsfile
_base.tsfile
_routing.tsfile
background-jobs.tsfile
job-manager-accessor.tsfile
admin.tsfile
check.tsfile
conduit.tsfile
memory.tsfile
nexus-engine.tsfile
nexus.tsfile
orchestrate.tsfile
pipeline.tsfile
session-context.tsfile
session.tsfile
sticky-engine.tsfile
sticky.tsfile
tasks.tsfile
code-engine.tsfile
tools-engine.tsfile
tools.tsfile
index.tsfile
DEFAULT_RATE_LIMITINGvariable
rate-limiter.tsfile
DEFAULT_LIFECYCLE_ENFORCEMENTvariableDefault lifecycle enforcement configuration
DEFAULT_PROTOCOL_VALIDATIONvariableDefault protocol validation configuration
DEFAULT_CONFIGvariable
ENV_PREFIXvariableEnvironment variable prefix for CLEO configuration
CONFIG_SCHEMAvariableConfiguration schema for validation
defaults.tsfile
config-loader.tsfile
config.tsfile
audit.tsfile
field-filter.tsfile
security.tsfile
sanitizer.tsfile
session-resolver.tsfile
cli.tsfile
add.tsfile
admin.tsfile
adr.tsfile
agent.tsfile
agents.tsfile
analyze.tsfile
archive.tsfile
archive-stats.tsfile
backfill.tsfile
backup.tsfile
blockers.tsfile
brain.tsfile
briefing.tsfile
bug.tsfile
cant.tsfile
check.tsfile
checkpoint.tsfile
commands.tsfile
complete.tsfile
compliance.tsfile
config.tsfile
consensus.tsfile
context.tsfile
contribution.tsfile
current.tsfile
dash.tsfile
decomposition.tsfile
delete.tsfile
deps.tsfile
detect.tsfile
detect-drift.tsfile
docs.tsfile
progress.tsfile
doctor.tsfile
env.tsfile
exists.tsfile
export.tsfile
export-tasks.tsfile
find.tsfile
generate-changelog.tsfile
grade.tsfile
history.tsfile
implementation.tsfile
import.tsfile
import-tasks.tsfile
init.tsfile
inject.tsfile
issue.tsfile
labels.tsfile
lifecycle.tsfile
list.tsfile
log.tsfile
map.tsfile
memory-brain.tsfile
migrate-claude-mem.tsfile
next.tsfile
nexus.tsfile
observe.tsfile
ops.tsfile
orchestrate.tsfile
otel.tsfile
phase.tsfile
phases.tsfile
plan.tsfile
promote.tsfile
reason.tsfile
refresh-memory.tsfile
relates.tsfile
release.tsfile
remote.tsfile
reorder.tsfile
reparent.tsfile
research.tsfile
restore.tsfile
roadmap.tsfile
safestop.tsfile
self-update.tsfile
sequence.tsfile
session.tsfile
show.tsfile
skills.tsfile
snapshot.tsfile
specification.tsfile
start.tsfile
stats.tsfile
sticky.tsfile
stop.tsfile
testing.tsfile
token.tsfile
update.tsfile
upgrade.tsfile
validate.tsfile
verify.tsfile
web.tsfile
codeCommandvariable
code.tsfile
index.tsfile
logger-bootstrap.tsfile
archive-stats.test.tsfile
checkpoint.test.tsfile
cli-output-flags.test.tsfile
commands.test.tsfile
docs.test.tsfile
export-tasks.test.tsfile
import-tasks.test.tsfile
logger-bootstrap.test.tsfile
safestop.test.tsfile
testing.test.tsfile
web.test.tsfile
dynamic.tsfile
init-detect.test.tsfile
init-gitignore.test.tsfile
nexus.test.tsfile
error.tsfile
cli-error-signature.test.tsfile
protocol-enforcement.tsfile
verification-gates.tsfile
index.tsfile
parity.integration.test.tsfile
param-utils.tsfile
schema-utils.tsfile
parity.test.tsfile
registry-derivation.test.tsfile
registry.test.tsfile
cli.test.tsfile
admin.test.tsfile
alias-detection.test.tsfile
check-ops.test.tsfile
check.test.tsfile
memory-brain.test.tsfile
memory-legacy-rejection.test.tsfile
nexus.test.tsfile
orchestrate-handoff.test.tsfile
orchestrate.test.tsfile
pipeline-manifest.test.tsfile
pipeline.test.tsfile
registry-parity.test.tsfile
sticky-list.test.tsfile
sticky.test.tsfile
tasks-filters.test.tsfile
tasks.test.tsfile
tools.test.tsfile
hooks-engine.test.tsfile
lifecycle-engine.test.tsfile
orchestrate-engine.test.tsfile
release-engine.test.tsfile
release-push-guard.test.tsfile
release-ship.test.tsfile
session-engine-scope.test.tsfile
session-handoff-fix.test.tsfile
session-safety.test.tsfile
task-engine.test.tsfile
validate-engine.test.tsfile
capability-matrix.tsfile
PROJECTIONSvariable
projections.tsfile
meta.test.tsfile
projection.tsfile
projections.test.tsfile
security.test.tsfile
audit.test.tsfile
pipeline.test.tsfile
projection.test.tsfile
protocol-enforcement.test.tsfile