@mutka-explorer/create
v2.1.0
Published
Scaffold a new Mutka module — a typed TypeScript project wired to @mutka-explorer/module that builds to a single ESM file.
Maintainers
Readme
@mutka-explorer/create
Scaffold a new Mutka module - a typed
TypeScript project wired to @mutka-explorer/module
that builds to a single self-contained ESM file (what Mutka loads).
Usage
npm create @mutka-explorer@latest my-module
# or
npx @mutka-explorer/create my-moduleIt prompts for the module id (author.name), display name, GitHub username, and
permissions, then generates:
my-module/
src/index.ts ← typed skeleton with a working command
package.json ← pins @mutka-explorer/module + a tsup build
tsconfig.json
mutka.config.json ← points GitHub discovery at dist/index.js
scripts/dev-install.mjs
README.mdNon-interactive
npm create @mutka-explorer@latest my-module -- \
--yes --author you --name "My Module" --permissions "fs:read,ui" --no-installFlags: --id, --name, --description, --author, --permissions (comma-separated),
--yes (accept defaults), --no-install, --pm <npm|pnpm|yarn>.
After scaffolding
cd my-module
npm install
npm run install:local # build + copy into ~/.mutka/modules/<id>/, then reload MutkaEdit src/index.ts - host is fully typed. The module runs isolated in a Web
Worker (no DOM, no native network; use host.net). See the
developer guide.
