Skip to main content

Cairn — a human-readable process language for governed agentic work in human systems, with grammar and plan conformance.

Project description

Cairn

Cairn is a human-readable process language for governed agentic work in human systems.

It gives humans and AI systems a shared way to describe, plan, interpret, and review complex work across technical, psychological, organisational, and sociological dimensions. It bridges pseudocode-style clarity with modern agentic realities: iteration, recursion, non-determinism, sync/async, queuing, outcome review, error handling, and human context.

The specification lives in SPEC.md (v0.9).

Install: pip install cairn-lang — the distribution is named cairn-lang (the PyPI name cairn belongs to an unrelated project) but the import is unchanged: import cairn.

Optional extras:

  • pip install 'cairn-lang[render]' — YAML stylesheets
  • pip install 'cairn-lang[web]'cairn-serve interactive composer
  • pip install 'cairn-lang[export]' — HTML / DOCX / PDF export (python-docx + fpdf2)

What it looks like

A small slice, in the readable Narrative style:

PROCESS — Answer a question from local memory.
  1. Gather context with read-only tools (search, then compile the surrounding nodes).
  2. The model writes the answer using only what was gathered — no invented sources.
  3. Save the exchange so the next turn can resume.

The same step in the precise Formal style (same backbone, with tags + traceability):

2. Generate the answer from gathered_context.  [LLM, STOCHASTIC, SYNC] [SATISFIES: R1]
   CONSTRAINTS: answer only from retrieved context; do not invent sources.

Full worked descriptions of three real systems are in examples/.

Rendering & export

Cairn can be turned into audience-friendly views:

cairn-render my-process.cairn.md --profile narrative_steps
# Domain examples:
#   --profile therapeutic     (psychological / regulation + feedback focus)
#   --profile change_leader   (organisational change + coalition/alignment focus)
cairn-render my-process.cairn.md -f html -o view.html
cairn-render my-process.cairn.md -f pdf -o plan.pdf   # requires [export]

Or programmatically:

from cairn.render import render_plan, export_view

view = render_plan(text, profile="operator")
pdf = export_view(view, "pdf")

Interactive composer: cairn-serve

What it's for

  • Documenting requirements and technical specifications in design documents.
  • Reverse-engineering hidden or unclear processes out of existing code, AI systems, or legacy implementations.
  • Defining governed agentic processes — recursive calls, iterative refinement, dynamic LLM decisions, tool boundaries, serialized agent discussions, trace, and outcome alignment.
  • Real-world use cases: recursive agentic workflows (chat interfaces, autonomous systems), low-resource queuing, semantic engines, multi-step reasoning.
  • Describing work as it actually happens: technical mechanisms embedded in human contexts, including cognitive, emotional, organisational, and social dynamics.
  • New constructs for human dimensions: REGULATION, APPRAISAL, FEEDBACK, MACRO (psych), COALITION, ALIGN, VISION, RESISTANCE (org), SOCIALIZE, SYMBOLIC_INTERACTION, ROLE (socio), etc.
  • Multi-scale STATE (e.g. scope: org.team), enhanced EMERGENT with attrs, domain-aware validation.

Put simply: Cairn treats software work, thinking work, and organisational work as processes embedded in human systems, not as purely mechanical flows.

Philosophy

Human-first readability

The primary goal is maximum human readability. Anyone — technical or not — should read a Cairn description and quickly understand the process without wrestling with syntax, jargon, or abstraction. We remove cognitive barriers so attention stays on what the process actually does, not on decoding notation.

This matters because agentic work is rarely just computation. It often includes judgement, uncertainty, memory, motivation, trust, conflict, change, and review. Cairn keeps those human dimensions describable without losing the governed runtime spine that lets AI systems validate and interpret plans.

Least abstract, simplest language possible

  • Concrete, everyday words wherever they suffice.
  • Short, direct sentences; active voice.
  • Structure scaffolds without getting in the way.
  • Details (constraints, context, edge cases) are optional layers consulted when needed — the main flow stays clean and punchy.

Consistency through core verbs

A small recommended lexicon (Initialize, Propose, Evaluate, Decide, Update, Execute, Iterate, Queue, Merge, Handle…) gives a consistent rhythm and "process feel" that helps readers scan, compare, and mentally simulate flows — and helps multiple people or LLMs write consistently. Verbs are not rigid rules; clarity always wins.

Balance of structure and flexibility

  • Numbered steps + indentation give sequence and hierarchy.
  • PLAN envelopes turn a PROCESS into a versioned live plan that can be revised when new information arrives.
  • Tags ([LLM, SYNC, DYNAMIC]) add precision without cluttering prose.
  • One canonical backbone is projected into audience render profiles (precise ai, readable operator, and more) — serving machines and humans alike.
  • CONTEXT and CONSTRAINTS supply supporting knowledge on demand.

Human-system awareness

Cairn can describe psychological, organisational, and sociological processes alongside technical ones because governed agentic work happens inside human systems. These dimensions are not a separate ambition from the agentic use case; they are part of the operating environment that a useful agentic process must be able to notice, express, and review.

Practical and evolving

Cairn is meant to be used "in anger" on real projects, evolving from actual needs rather than theoretical perfection.

The ultimate test: a reader thinks "I get what's happening here," not "I need to learn the notation first."

Status

v0.8 (current on PyPI as cairn-lang) — complete export support (html/docx/pdf), interactive cairn-serve, executable grammar + conformance, multiple render profiles, and real usage examples across the family stack.

The specification is at v0.9 (PLAN envelopes etc.). A structural grammar is in GRAMMAR.md. Refined by describing real systems (Tirzah, Hoglah, Mahalath, etc.).

Repository

  • SPEC.md — the specification (v0.9).
  • GRAMMAR.md — structural EBNF for the skeleton.
  • examples/ — real systems described in Cairn (Tirzah, Hoglah, Mahalath, Mahlah, Milcah, Mizpah); see tirzah-system.cairn.md for end-to-end composition.
  • CHANGELOG.md — how the spec has evolved.
  • okf/ — an Open Knowledge Format knowledge bundle: Cairn's concepts and reference, as linked markdown.

Feedback & contributing

Cairn evolves from real use, so feedback is the point — especially from describing your own processes in it. That is exactly how v0.7 was shaped.

  • Ambiguity, gap, or rough edge? Open a feedback issue.
  • A new construct, tag, or change? Open a proposal (same chooser) — say what real process motivated it; concrete beats theoretical.
  • Questions, ideas, show-and-tell? Use the Discussions tab.
  • See CONTRIBUTING.md for how proposals are handled.

License

Apache License 2.0.

Conformance (cairn package)

Cairn is primarily a spec, but it also ships a tiny, dependency-free conformance surface so a runtime can validate the plans it produces instead of embedding a private dialect:

import cairn

# Runtime PLAN dict conformance (SPEC §4.5)
errors = cairn.validate_plan(plan_dict)   # [] when conformant

# Structural grammar (GRAMMAR.md EBNF + SPEC §12 well-formedness)
doc = cairn.parse_document(cairn_text_or_markdown)
errors = cairn.validate_document(doc)   # [] when well-formed
plan = cairn.document_to_plan(doc)        # first PLAN or PROCESS → plan dict

# Simplified human-readable views
view = cairn.render_plan(cairn_text_or_markdown, profile="narrative_steps")
cairn.CANONICAL_PLAN                       # an executable known-good fixture
cairn.PLAN_CONSTRUCTS                      # the allowed step constructs (SPEC §5)

CLI: cairn-validate examples/hoglah.cairn.md · cairn-render examples/hoglah.cairn.md

View composer (cairn-serve)

An interactive, local composer for building a transformation view of a process and saving the recipe as a named template:

pip install 'cairn-lang[web]'
cairn-serve            # http://127.0.0.1:8795

Paste a Cairn process, pick a profile and options (language, format, depth, sections, layout), watch the view update live, then Save as template. A template is persisted as a stylesheet under ~/.cairn/templates/<name>.json, so it is directly reusable on the CLI: cairn-render --stylesheet ~/.cairn/templates/<name>.json input.cairn.md.

Grammar parser: docs/GRAMMAR-PARSER.md. Simplified views: docs/VIEW-GENERATOR.md.

Tirzah's recursive planner is tested against cairn.validate_plan so its output cannot drift from the grammar.

Works the same on native Linux and WSL. Requires keturah in the same environment (local editable install or PyPI once published).

pip install -e ".[dev]" && pytest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cairn_lang-0.8.0.tar.gz (60.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cairn_lang-0.8.0-py3-none-any.whl (58.7 kB view details)

Uploaded Python 3

File details

Details for the file cairn_lang-0.8.0.tar.gz.

File metadata

  • Download URL: cairn_lang-0.8.0.tar.gz
  • Upload date:
  • Size: 60.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for cairn_lang-0.8.0.tar.gz
Algorithm Hash digest
SHA256 2a04f1dd504039e0baf6c953d93a188003f8dd6c7ec62da381d916addb17c76e
MD5 1a412b98adda23b12153cfa7829e5631
BLAKE2b-256 50a403b95c351d6dedebd556de00d3bea3a3ecc86a96100b4e9d08ce80813b56

See more details on using hashes here.

File details

Details for the file cairn_lang-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: cairn_lang-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 58.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for cairn_lang-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9bdf149f0be3247aa642f1a2665ddbd9874ef542879210cccf076becb9c237d4
MD5 009d9177b990cf870009c3d29ba2ef8b
BLAKE2b-256 f43e46389729266682c738b239dfc50d20979027beef8cd74bdda26c55abf925

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page