Gene

CLI scaffolder for HZKJN apps.

Gene helps you quickly scaffold different types of applications (web, SaaS, mobile, CLI, etc.) with sensible defaults and opinionated structure.

Usage

Interactive mode

bun create @hzkjn/gene

This will prompt you to:

1. Enter your app name
2. Select the type of app you want to create

Standard usage

bun create @hzkjn/gene my-app

This will prompt you to select the type of app you want to create.

Semi-interactive (template specified)

bun create @hzkjn/gene --template web

This will prompt only for the app name, using the specified template.

Power user mode (skip all prompts)

bun create @hzkjn/gene my-app --template saas-workspaces

or

bun create @hzkjn/gene my-app -t web

Available templates

• web
• mobile
• browser-extension
• api
• cli
• lib
• saas-workspaces
• saas-domains

For App Developers (using Gene)

After scaffolding your app:

cd my-app
bun install
bun run dev

That’s it. You’re ready to build.

For Gene Maintainers (developing Gene itself)

When making changes to Gene (the CLI):

1. Run tests

   bun test

2. Build the package

   bun run build

3. Bump the version

   npm version <major|minor|patch>

4. Push commits and tags

   git push
   git push --tags

Publishing is handled via GitHub Actions.

⚠️ Do not publish manually.
Tagged releases trigger the automated publish workflow.

License

MIT