Skip to content

Reference

Machine-readable API surface for Tyravel 1.0.x. Use this section when you need package names, CLI commands, facade entry points, or exported symbols — not narrative guides.

What's here

SectionPurpose
All packagesEvery @tyravel/* package with install instructions and public exports
CLI commandsFull tyravel command list with usage strings
FacadesStatic facades and links to guide chapters

Regenerating

Reference pages are generated from the monorepo:

bash
npm run docs:generate

Outputs land in docs/reference/generated/ and update the VitePress sidebar. Run this after adding packages or CLI commands.

Stability

Not every export is production-stable. Check API stability and STABILITY.md before building on experimental APIs.

Agents & tooling

docs/.vitepress/generated/manifest.json indexes packages, commands, and facades for MCP and IDE integrations (tyravel mcp:serve, tyravel mcp:export-rules).

Released under the MIT License.