Documentation

Understand Kostral without reading everything.

The documentation is split by purpose: use the CLI reference to run Kostral, the system model to understand its behavior, and the architecture guide to understand implementation boundaries.

CLI Reference

Commands, syntax, options, output formats, and copy-paste examples.

Read CLI Reference →

System Model

Conceptual model: preparation, execution, engine responsibilities, and workflow composition.

Read system-model.md →

Architecture

IR, engine boundaries, contracts, and implementation structure.

Read architecture.md →

Contributors

How to add rules and work inside an independent engine without creating responsibility overlap.

Contributor guide →

Guarantees

Behavioral guarantees and mutation authority.

Read guarantees.md →

Remote Engines

Run engines as separate HTTP services and compose them with koss remote. Experimental demonstration with a static registry.

Read remote-engines.md →

Vision

Future direction and planned capabilities. Future concepts are kept separate from current implementation.

Read vision.md →

Documentation Index

The reading order for the whole documentation set, from the mental model to contribution rules.

Read docs/README.md →
Current mental model

One idea to remember

Independent engines. Composable workflow. Engine ownership defines what a module is responsible for; workflow composition defines when it runs.

Independent Engine
+
Workflow
=
Chosen behavior

Workflow composition also covers where an engine runs. Engines can be invoked locally or through remote HTTP clients; that changes the invocation mechanism, not the engine’s responsibility. See remote-engines.md.