Skip to main content
nexlem

Documentation

See also: Nexlem on GitHub · nexlem.com

This index lists every document under docs/, grouped by purpose. Start with Install if you have never set up Nexlem before; jump to Reference if you need the exact shape of a command, flag, or config key.

Install

  • install.md — Prerequisites, install steps, and /nexlem init flow for a fresh machine or a fresh project.

Getting Started

  • GETTING_STARTED.md — End-to-end walkthrough: from /nexlem init to your first published campaign.

Reference

  • COMMANDS.md — Full reference for every /nexlem skill command (interactive user surface).
  • SDK_REFERENCE.md — Full reference for every nexlem-sdk query handler (machine/wire surface).
  • SKILLS.md — Inventory of all /nexlem skills. Auto-generated from scaffold/manifest.json — do not edit manually. Run bun run build:skills-doc to regenerate.
  • cli-flags.md — All CLI flags accepted by Bun scripts and the SDK.
  • env-vars.md — All environment variables read by Nexlem at runtime.
  • CONFIG.md — Config file cascade (project.json → business.json → site → campaign) and the merge semantics.
  • AGENTS.md — The 16 registered agents (14 pipeline + 2 standalone tools) in the content factory DAG and their contracts.

Policy

  • forward-only.md — Forward-only evolution rule: why v2.2 ships no migration from prior versions and how the project handles breaking changes.
  • STABILITY.md — Tiered stability contract (stable / evolving / experimental) for every consumer-facing surface.
  • RELEASING.md — Maintainer release process: version bump, CHANGELOG, tag, publish.

Recipes

  • COOKBOOK.md — Task-oriented recipes for common content-factory workflows.
  • examples/ — Worked end-to-end examples (currently: hyundai-hb20/).

Concepts

  • WHAT_IS_NEXLEM.md — The "why" behind Nexlem: content factory framing, the DAG model, and how the pieces fit together.

Migrations

  • migrations/ — Per-version migration guides (currently: v2.1-to-v2.2.md and TEMPLATE.md). v2.2 ships no migration file from prior versions by design — it's Nexlem's first public release. See forward-only.md for the rationale.

Edit this page on GitHub