fumablox

CLI

Commands you actually run while writing a Roblox library.

Every command reads the same compiler IR. Generate is not a special case.

fumablox generate
fumablox generate --code src --out content/docs/api
fumablox build          # alias
fumablox dev            # generate + watch Lua

Writes MDX into outDir. Files marked @generated by fumablox are replaced on each run.

Extract

fumablox extract                  # IR on stdout
fumablox extract --out api.json

This is the snapshot diff compares against. Check it in as api.baseline.json if you want PR-level API lockfiles.

Init

fumablox init
fumablox init docs

Copies the Fumadocs app template and writes fumablox.toml unless moonwave.toml already exists.

Flags

FlagCommandsMeaning
--code <dir>mostRepeatable source root
--config <file>mostfumablox.toml or moonwave.toml
--out <dir>generate, devMDX output
--json <file>generate, extractWrite the IR
--min-coverage <n>checkFail below this percent

On this page