create-textmode (✿◠‿◠)

| | | | |:---|:---|:---|

create-textmode is a command-line tool to quickly scaffold new projects using textmode.js with sensible defaults and minimal friction.

Just run the CLI via npm create textmode@latest or your package manager's equivalent command, answer a few prompts, and you're ready to start building!

Features

• One-command scaffolding - Start a new project with npm create textmode@latest or your package manager's equivalent
• Interactive prompts - Choose project name, template, textmode.js version, official add-ons, dependency installation, and dev server startup
• JavaScript and TypeScript templates - Vanilla starters plus Tweakpane-controlled UI variants
• Package-manager aware - Auto-detect npm, pnpm, yarn, or bun
• Non-interactive flags - Full CLI options for scripts and CI
• Sensible defaults - Vite, textmode.js, Prettier, ESLint, and a .gitignore; TypeScript variants add tsconfig and a typecheck script

Try it online first

Open editor.textmode.art, a browser-based live-coding environment for the complete official textmode.js ecosystem, to try textmode.js before or alongside scaffolding; sketches run as you edit, with no local toolchain required.

Requirements

• Node.js 18+ (per engines)
• One of: npm, pnpm, yarn, or bun on your PATH

Quick start

npm create textmode@latest
# or
pnpm create textmode@latest
# or
yarn create textmode
# ...

The CLI will prompt for project name, template, textmode.js version, official add-ons, installing dependencies, and starting the dev server.

Non-interactive examples

# TypeScript template, pin textmode.js, auto-install, do not run dev server
npm create textmode@latest my-textmode-app -- --template vanilla-ts --textmode-version 0.18.0 --install --no-run

# JavaScript template with pnpm, skip install and run
pnpm create textmode@latest demo -- --template vanilla-js --pm pnpm --no-install --no-run

# Pre-install the synth and export add-ons and wire their plugins into the starter sketch
npm create textmode@latest audio-art -- --template vanilla-js --addons synth,export --install --no-run

Options

• --template <name>: choose a template (prompts if omitted)
• --addons <name1,name2,...>: pre-install official textmode.js add-ons and wire their plugins into the starter sketch (prompts via multi-select if omitted)
• --name <projectName> or first positional arg: directory/package name (default suggestion if omitted)
• --textmode-version <ver>: pin textmode.js (prompts from fetched stable versions >= 0.18.0; defaults to latest)
• --pm <npm|pnpm|yarn|bun>: force a package manager (auto-detected otherwise)
• --install / --no-install: install dependencies after scaffold (prompts if neither is provided)
• --run / --no-run: start the dev server after install (prompts if neither is provided)
• --force: allow using a non-empty directory without prompting
• --help: show usage
• --version: show the CLI version

Templates

All templates ship with Vite, textmode.js, Prettier, ESLint, and a .gitignore. TypeScript variants add tsconfig and a typecheck script. Below are the extras that differ by template:

| Template | Flavor | Extras | |:---------|:-------|:-------| | vanilla-js | JavaScript | Base starter sketch | | vanilla-ts | TypeScript | Base starter sketch + TS config | | vanilla-js-tweakpane | JavaScript + Tweakpane | UI controls wired with Tweakpane | | vanilla-ts-tweakpane | TypeScript + Tweakpane | UI controls wired with Tweakpane + TS config |

Adding new templates? Keep the shared tooling note above and only list what’s unique in the table.

Add-ons

All official textmode.js add-on libraries are supported. When selected, the CLI adds the package (always at its latest version) to your dependencies and registers its plugin on the textmode.create({ ... }) call in the starter sketch.

| Id | Package | Latest plugin export | |:---|:--------|:---------------------| | export | textmode.export.js | ExportPlugin | | synth | textmode.synth.js | SynthPlugin | | figlet | textmode.figlet.js | FigletPlugin | | filters | textmode.filters.js | FiltersPlugin |

Local development

npm install        # also installs git hooks (commitlint, lint-staged, pre-push protection)
npm run check      # format check + lint + test
npm run lint       # ESLint across codebase
npm test           # Vitest (run once)

# Run CLI directly (no npm-create shim); no "--" needed
node bin/index.js demo --template vanilla-js --pm pnpm --no-install --no-run
# or
node bin/index.js
# ...

Contributing

Thank you for considering contributing to this project! (✿◠‿◠)

Please read the Contributing Guide to get started, and follow the Code of Conduct in all community spaces.

License

create-textmode is licensed under the AGPL-3.0-or-later License.