CLI reference
Get the CLI
The yichus
npm package runs the engine's catalog tools from a terminal or CI with Node 20
or newer, and needs no Java:
npx yichus@0.3.9 tools npx yichus@0.3.9 verify notes-api.bosatsu --instances 1
The commands listed below, such as explore, dist,
and fact-diff, are the JVM command-line tool's, which is not
distributed yet. Most have a catalog tool that the npm CLI runs with
npx yichus@0.3.9 call.
The two MCP servers
Two npm packages wrap parts of the same engine, and an MCP client starts
either with npx.
@yichus/api-mcp serves the API Safety MCP tools (scaffold,
verify, report — the surface documented under
API MCP docs).
@yichus/mcp is the
local relay that opens the hosted
data apps and playground with WebMCP enabled.
npx -y -p @yichus/api-mcp@0.1.11 yichus-api-mcp npx -y @yichus/mcp@0.1.4
Commands
Commands on the yichus binary. Each page includes the current
usage, options, and available subcommands.
yichus build— Type-check Bosatsu files with Yichus packagesyichus eval— Evaluate a binding and print resultyichus sim— Generate interactive HTML simulationyichus simapp— Generate simulation app from .sim.bosatsu configyichus deploy— Execute the declarative deploy manifestyichus matchless— Export Matchless IR and metadata sidecaryichus spec— Run native bounded and structural checks of declared Bosatsu properties (TLC is not yet available)yichus tla— Retired TLA+ sketch command; use spec for native checksyichus admit— Solve batch admission against declared escrow invariantsyichus law— Check declared Yichus/Law obligations by seeded generation, or propose properties with --suggestyichus obligations— Report which commit strategy discharged Yichus/Law obligations license, and the next obligationyichus lean— Prove supported Bosatsu laws with the pinned Lean toolchain on this hostyichus tlc— Check a protocol case with pinned TLC 1.7.4, replaying any counterexample nativelyyichus conformance— Check declared Yichus/Spec Conformance bindings against the compiled handlers by executionyichus dist— Check declared distributed-world specs by deterministic simulationyichus protocol— Explore declared finite transaction protocols with atomic states, faults, and sourced counterexamplesyichus flow— Verified mutation flows: conformance, parts, batch, equivalenceyichus yir— Export canonical YIR (validated on emit)yichus dossier— Export a one-shot trace dossier over the provenance graphyichus workbook— Export package/impact workbook artifacts for agentsyichus verify— Enumerate interleavings for IO-heavy sourceyichus audit— Audit IO patterns in Bosatsu filesyichus service— Service and CRUD scaffolding commandsyichus api— Scaffold, verify, and deploy a Yichus-first Bosatsu APIyichus access— Prove per-user data access from Matchless IRyichus explore— Emit system profile JSONyichus properties— Emit a canonical per-binding property digestyichus verify-claims— Check an agent's report against computed program facts; inspect supported, refuted, and not-provable resultsyichus why— Evaluate one binding on typed inputs and report why the output is what it isyichus snapshot— Record one isolated run as a saved example, re-check it after an edit, and accept a reviewed changeyichus glance— Compare N programs' glance channels on one shared declared axisyichus organize— Render the organization lenses (page, vocabulary, stack, conventions, map, flow, diff) over Bosatsu filesyichus diff— Diff two explorer profiles structurallyyichus fact-diff— Diff the fact families between two program versionsyichus serve— Start explorer HTTP serviceyichus mcp— Start explorer MCP serveryichus playground— Start browser-based simulation editoryichus daemon— Explorer daemonyichus bosatsu— Passthrough to bosatsu CLI