keryx — Documentation Index

Developer documentation for the keryx CLI.

These pages describe what the current main implementation actually does. Product intent and future design work live separately, under docs/requirements/ in the repository; where the two disagree, this section is the one that describes shipped behaviour.

Contents

• onboarding.md — Install, first-run walkthrough, the typical build loop, and TTY/CI behavior.
• complete-setup-and-agent-workflows.md — Complete global installation, project configuration, commands, operational scripts, and agent prompts.
• agent-installation-playbook.md — Agent-executable Gherkin setup, repair, validation, and handoff scenarios.
• architecture.md — System overview, layered architecture, invariants, cross-module data flows, integrations.
• harness.md — The agent runtime: doors, providers, sessions and forking, policy, containment, evidence and the completion gate, record/replay.
• modules.md — Per-module reference: purpose, CLI surface, key files, mechanics, and data paths.
• cli-reference.md — Every command, subcommand, flag, and exit code.
• workspace-and-lifecycle.md — The .metaproject/ contract, manifest, agent entrypoints, and init/update lifecycle.
• limitations.md — Known gaps, platform support, optional AI features, and what to use instead.

Releases

• Changelog — what has landed in each release, with a standing known-gaps list.
• Releases — tagged versions, each published to npm with provenance.

Guides — organised by what you are trying to do

• Give an agent context about my repository
• Use Shared Agent Context (workspaces, FWK, proposals)
• Run an agent against a repository without giving it my machine
• Use local SearXNG for agent web search
• Drive keryx from a bot or another product
• Review a branch and keep a durable record
• Run keryx in CI

Start here: new to the project? Begin with onboarding.md, then pick the guide that matches your task.