Reference

Reference pages are exact lookup material for CodeAlmanac commands, page formats, source addresses, run records, config keys, local state, and topic metadata. The topic graph defines reference as the wiki neighborhood for commands, formats, and states, and this hub routes readers to the narrow page that owns each contract [@topics].

Use this page when you already know the part of the system you need to verify. For narrative system shape, start with Architecture instead; for task steps, start with the relevant guide.

Public Surfaces#

Public command surface lists the visible codealmanac commands, their main options, hidden worker entries, and legacy flags that are intentionally absent [@command-surface]. Pair it with JSON output contract when a command needs machine-readable output, or Error and exit code contract when changing terminal failures [@json-output] [@error-exit].

Config keys defines auto_commit, harness.default, harness.model, telemetry.enabled, and automation keys, including precedence between CLI flags, the one user config file, and built-in defaults; there is no repository-level config layer [@config-keys].

Wiki Page Format#

Frontmatter and sources defines the supported page metadata fields, source entry shape, file-source indexing, and inline citation checks [@page-format]. Links and routes defines Markdown page links, README.md folder routes, and the route forms the viewer and index resolve [@links-routes].

Topics YAML defines the authored topics.yaml schema, topic slug normalization, parent DAG constraints, and mutation behavior for topic commands [@topics-yaml].

Runtime Lookup#

Run states and events is the ledger reference for run kinds, statuses, event kinds, queued specs, cancellation, attach, and logs [@run-states]. Local state layout lists the committed wiki paths and the runtime files under ~/.codealmanac/, including the global database, config file, per-repository index, update lock, and scheduler logs [@local-state].

Inputs And Harnesses#

Source addresses lists the raw ingest input forms, their resolver order, accepted GitHub, URL, Git, transcript, and path shapes, and the rejection rules for malformed inputs [@source-addresses].

Harness event shape defines the normalized event payload shared by provider adapters and run logging. Cosmic Python translation maps local architecture terms to the Architecture Patterns with Python ideas used in this rewrite [@harness-events] [@cosmic-python].