Getting Started

1 min read 3 glossary terms 5 connected pages
The short version written for the Snayu team

A short page for new contributors that explains LychD is pre-alpha and helps you choose a first path: verifying the repository on a checkout, or attempting a live Linux host install.

Why read it: Read this on day one to set up a checkout, run the quality checks and understand which features you must not claim as working.
  1. 1First hour: clone, make install, lint/format/type checks and make test-ci inside an OCI (Podman) check image.
  2. 2Windows and macOS are unsupported hosting platforms; develop from Windows against a remote or dedicated Linux host.
  3. 3From 2 November 2026 ordinary pull requests target the dev branch; claim an issue before changing a shared contract.

Words on this page, decoded click one for its card

The original text Underlined words open their plain-English card.

LychD is pre-alpha. Use this page to choose the right first path; do not treat Designed behaviour as delivered. State of Work owns maturity claims—start with its outcome matrix.

Choose a path

You need… Go here
Architecture of one request through the body Map
Contributor checkout, lanes, quality gates, and branch rules CONTRIBUTING
Isolated AltarControl Panel/backend fixture without a live host install CONTRIBUTING — developer fixture and issue #53
Live Linux host acceptance (init → bind → model → reply) Summoning — not end-to-end yet
Vocabulary Lexicon

Windows and macOS are unsupported hosting platforms, including Linux guests on those hosts. Partners who develop from Windows should use a supported remote or dedicated Linux host for SummoningInstallation and host proofs; repository Core checks still run inside the OCI check image.

First hour on a checkout

These steps verify the repository on a machine with a working OCI engine (rootless Podman by default). They do not prove a managed installation or a model reply.

git clone https://github.com/hexanomicon/lychd.git
cd lychd
make install
make lint format-check type-check
make test-ci

Frontend-only work also needs Node from .nvmrc and make frontend-install, then the checks in CONTRIBUTING.

Claim one open issue before changing a shared contract. From 2 November 2026, ordinary pull requests target dev; until then, follow the current collaboration phase.

Alpha status in one glance

Scenario Answer now
CLI bootstrap Partial — see State of WorkWhat Actually Works
Local text chat Partial — retained receipts; general quality pending
Browser safety Loopback only
Full SummoningInstallation on a real host Not yet supported end to end
Remote IAM / federation / production release Unsupported or Designed

Read the matching State of WorkWhat Actually Works section before claiming a capability in an issue, PR, or demo.