DOCUMENTATION

Navigate the whole system

A repository-grounded field guide to building, operating, extending, and integrating Karnelian

Chameleon archivist searching Karnelian documentation

Documentation index

CLILifecycle, tasks, skills, and MAGIC

/v1REST and WebSocket interface

TRUSTPolicy, approvals, attestation, and ledger

FIELD GUIDE

Choose a path into Karnelian

Search the index for an endpoint, command, subsystem, or operational task. Every entry opens a shareable reference with direct source links.

Start HereSHIPPED

Quick start

Build the Rust workspace, complete local setup, and bring the Karnelian daemon online.

Open reference

Start HereSHIPPED

Installation and machine setup

Choose interactive, automated, or manual installation and apply the host-specific setup guidance.

Open reference

ConceptsSHIPPED

System architecture

Follow a request from an interface through the Rust orchestrator, policy boundary, workers, and durable state.

Open reference

ConceptsPRE-ALPHA DEVELOPMENT

Lian and the agent loop

Understand the default identity, heartbeat turn, context assembly, delegation, and durable session lifecycle.

Open reference

ConceptsSHIPPED

Skills and workers

Package tools as declared skills and route them to bounded language-specific runtimes.

Open reference

ConceptsPRE-ALPHA DEVELOPMENT

Sub-agents and workflows

Delegate bounded work to isolated agent sessions and coordinate multi-step workflow execution.

Open reference

ConceptsSHIPPED

Skill authoring and runtimes

Design a skill contract, choose a bounded runtime, and validate packages before execution.

Open reference

ConceptsSHIPPED

Memory and Elixirs

Retrieve relevant history and turn reviewed knowledge into reusable, quality-scored Elixirs.

Open reference

ConceptsSHIPPED

Sessions and context compaction

Preserve channel-scoped conversations while keeping long-running context within model limits.

Open reference

ConceptsSHIPPED

XP progression and skill metrics

Measure agent and skill performance through ledger-correlated progression events.

Open reference

ConceptsEXPERIMENTAL

MAGIC

Use authenticated, provider-aware entropy for mantras, integrity research, and quantum-category skills.

Open reference

CLIALPHA COMPLETE

CLI reference

Operate the daemon, migrations, logs, tasks, skills, and MAGIC from the `carnelian` binary.

Open reference

APISHIPPED

System and event API

Check health, inspect runtime state, collect metrics, and subscribe to the live event stream.

Open reference

APISHIPPED

Resource API

Work with tasks, runs, skills, memory, providers, approvals, capabilities, XP, voice, Elixirs, and MAGIC.

Open reference

APIPRE-ALPHA DEVELOPMENT

Channel adapters

Route external conversations through paired channel identities without bypassing sessions, policy, or audit boundaries.

Open reference

OperationsSHIPPED

Security and approvals

Resolve authority before execution with deny-by-default capabilities and human approval gates.

Open reference

OperationsSHIPPED

Worker attestation and quarantine

Compare worker-reported ledger, build, and configuration state before assigning more work.

Open reference

OperationsSHIPPED

Audit ledger

Verify privileged history through a BLAKE3-linked event chain with optional entropy provenance.

Open reference

OperationsSHIPPED

Configuration and providers

Configure data services, local models, hosted fallbacks, and machine-specific runtime behavior.

Open reference

OperationsSHIPPED

Model gateway and voice

Route local and hosted model traffic, stream responses, track usage, and operate the voice integration.

Open reference

OperationsSHIPPED

Development and testing

Work across the Rust workspace, Dioxus desktop, TypeScript gateway, and multi-runtime workers.

Open reference

OperationsSHIPPED

Logging and observability

Correlate runtime, agent, security, memory, tool, gateway, and database activity without leaking secrets.

Open reference

OperationsSHIPPED

Deployment and troubleshooting

Run the current stack, diagnose service boundaries, and recover from common startup failures.

Open reference

OperationsPLANNING

KRNL OS direction

Track the planned Linux-forked machine environment without presenting roadmap architecture as shipped.

Open reference

Product-facing pages use Karnelian and KRNL naming. The current compiled binary, crate paths, and repository configuration still use carnelian; those technical identifiers are preserved exactly.