create-bestax
v3.3.2
Published
Create a new bestax-bulma project
Maintainers
Readme
create-bestax
The scaffolder for @allxsmith/bestax-bulma — spin up a Vite app pre-wired for the Bulma v1 React component library in one command. Picks your framework (JS or TypeScript), CSS flavor, and icon library, and can drop in the bestax AI skills so an agent like Claude Code knows the library from the first prompt.
Part of the bestax monorepo — see also @allxsmith/bestax-bulma for the components themselves.
Usage
Quick Start
# Using npm
npm create bestax@latest my-app
# Using npx
npx create-bestax@latest my-app
# Alternative naming
npm create bestax-bulma@latest my-appInteractive Mode
Running without arguments will prompt you for all options:
npm create bestax@latestYou'll be asked to:
- Enter a project name
- Select a framework (Vite or Vite + TypeScript)
- Choose a Bulma CSS flavor (Complete or Minimal)
- Select an icon library (Font Awesome, Material Icons, etc.)
- Choose whether to install the bestax AI skills into
.claude/skills/
Every prompt has a flag equivalent, so the whole flow is scriptable and CI-friendly — see the options below.
Command Line Options
npm create bestax@latest [project-directory] [options]Arguments:
[project-directory]- Optional project directory name
Options:
-t, --template <template>- Template to use:viteorvite-ts
Default:vite-b, --bulma <flavor>- Bulma CSS flavor:complete- Full Bulma CSS with all components and helpersprefixed- Prefixed version for compatibilityno-helpers- Without helper classesno-helpers-prefixed- Prefixed without helpersno-dark-mode- Without dark mode support
Default:complete
-i, --icon <library>- Icon library:none- No icon libraryfontawesome- Font Awesomemdi- Material Design Iconsionicons- Ioniconsmaterial-icons- Material Iconsmaterial-symbols- Material Symbols
Default:none
--skills/--no-skills- Install (or skip) the bestax AI skills into.claude/skills/(with aCLAUDE.md) so a Claude Code session picks them up automatically. When omitted you're prompted; with-ythe default is to install.-y, --yes- Skip prompts and use defaults or provided options.
When used, the following defaults are selected unless overridden by flags:- Template:
vite - Bulma flavor:
complete - Icon library:
none - AI skills: installed (pass
--no-skillsto opt out)
- Template:
Example:
# Create a TypeScript project with Font Awesome icons
npm create bestax@latest my-app -t vite-ts -i fontawesome -b complete
# Use all defaults (skip prompts)
npm create bestax@latest my-app -yTemplates
Available templates:
vite- Vite + JavaScriptvite-ts- Vite + TypeScript
Each template includes:
- Pre-configured bestax-bulma integration (React 19)
- The latest
@allxsmith/bestax-bulma, which ships Bulma v1 automatically - Icon library support (Font Awesome, Material Design, etc.)
- Sample components demonstrating library usage
- Development and build scripts
For AI Tools
Scaffolding for an AI agent? Pass --skills (or accept the prompt) to drop the bestax
Agent Skills and a CLAUDE.md into the new project so Claude Code, Cursor, or Copilot
build the bestax way from the start. The library also ships LLM-optimized docs:
- LLMs guide — using bestax with Claude Code, Cursor, Copilot
- Agent Skills — teach your agent the bestax conventions
- llms.txt (curated index) · llms-full.txt (full docs)
Development
npm run build # Build the CLI
npm run dev # Watch mode
npm test # Run tests
npm run lint # Lint CLI source code
npm run typecheck # Type check CLI source codeNote on Templates: Template files in templates/ are excluded from linting. They should be manually validated by scaffolding a test project and running lint/build there before releasing.
Publishing
This package uses semantic-release with scope-based rules. Only commits with feat(create-bestax) or fix(create-bestax) will trigger releases.
