Flexweave

Flexweave is a standalone product workspace for reusable mechanics primitives and the Studio authoring surface.

Product Surfaces

Surface	Path	Purpose
Flexweave Rust crate	core	Rust crate for deterministic mechanics primitives.
Flexweave Studio package	studio	TypeScript package for catalog contracts, validation, migrations, generated output checks, and authoring workflows.
Flexweave Studio app	studio/app	Reusable application shell imported by project-local Studio host apps.

Local Host App Model

Consumer projects run Studio workflows through the versioned flexweave-studio CLI. The consumer project owns its Studio project config, catalog content, generated output directories, runtime hooks, optional local host app entry point, adapter, branding, and deployment.

Create a local host app only when the project needs an authoring UI. The shared Flexweave packages own the reusable workflows and app shell. Create the initial local host app with:

flexweave-studio scaffold host-app --config studio.config.json

CLI and package updates use this flow:

npm update --global @flexweave/studio
flexweave-studio migrate --config studio.config.json
flexweave-studio verify --config studio.config.json

Agent Skills

Flexweave ships installable agent skills for consumer repo setup and mechanic authoring. Install them with the open skills CLI:

npx skills@latest add RickyRoller/flexweave --skill flexweave-setup --skill flexweave-author-mechanic

List the available skills without installing:

npx skills@latest add RickyRoller/flexweave --list

If Flexweave is vendored inside another repository, install from the direct subdirectory URL instead:

npx skills@latest add https://github.com/<owner>/<repo>/tree/main/flexweave --skill flexweave-setup --skill flexweave-author-mechanic

Commands

Command	Purpose
bun run build	Build the Rust crate and available Studio surfaces.
bun run check	Run read-only format, structure, term-scan, Rust crate, and Studio checks.
bun run fix	Format supported files.
bun run test	Run Rust crate and Studio tests.
bun run verify	Run the full workspace verification gate.

Documentation

Documentation uses Diataxis forms so each page has one job:

• Tutorials teach a complete learning path.
• How-to guides solve an operational task.
• Reference pages describe stable contracts.
• Explanation pages capture concepts and rationale.

Start with:

• Documentation Forms
• Repository Layout
• Using Flexweave
• Using Studio
• Updating Studio Packages
• Product Boundaries