@dizmo/create

Scaffold new dizmo projects with a modern, Vite-based build system.

Usage

Interactive Mode

npx @dizmo/create

You'll be prompted for:

• Project name
• Description
• Bundle ID
• Template (TypeScript / JavaScript / Planisy)
• Stylesheet (SCSS / CSS)
• Initialize git repository

With Arguments

npx @dizmo/create my-dizmo

Non-Interactive Mode

npx @dizmo/create my-dizmo --ts --scss --bundle-id com.dizmo.my.dizmo --description "My dizmo"

CLI Options

| Option | Alias | Description | |--------|-------|-------------| | --typescript | --ts | Use TypeScript template | | --javascript | --js | Use JavaScript template | | --planisy | | Use Planisy TypeScript template | | --scss | | Use SCSS for stylesheets | | --css | | Use plain CSS for stylesheets | | --bundle-id <id> | | Bundle identifier (e.g., com.dizmo.myapp) | | --description <text> | | Project description | | --git | | Initialize git repository (default: true) | | --no-git | | Skip git initialization | | --skip-install | | Skip npm install | | --local <path> | | Use local path for @dizmo/build (development only) |

Generated Project Structure

my-dizmo/
├── package.json           # Project config with dizmo.settings
├── tsconfig.json          # TypeScript config (if using TS)
├── README.md              # Project readme with build instructions
├── .gitignore
├── source/
│   ├── index.html         # Entry HTML
│   ├── index.ts           # Entry script (or .js)
│   └── styles/
│       └── styles.scss    # Stylesheet (or .css)
└── assets/
    ├── Icon.svg           # Light theme icon
    ├── Icon-dark.svg      # Dark theme icon
    └── Preview.png        # Preview image

Building the Generated Project

After scaffolding:

cd my-dizmo
npm install
npm run build

The .dzm file will be created in the build/ directory.

See @dizmo/build for build options and configuration.

Bundle ID Format

Bundle IDs must follow these rules:

• Lowercase only
• Words separated by dots
• Each segment starts with a letter
• At least 2 segments

Examples:

• com.dizmo.myapp ✓
• com.company.my.dizmo ✓
• MyApp ✗ (uppercase)
• myapp ✗ (single segment)

Development

Use --local to link to the local @dizmo/build during development:

node dizmo-create/dist/bin/dizmo-create.js my-test-dizmo --local ../dizmo-build

This sets @dizmo/build to file:../dizmo-build in the generated package.json.

Requirements

• Node.js >= 22.0.0

License

ISC