@obinexusltd/obix-cli-create

Scaffold an OBIX Heart UX application in seconds.

npx @obinexusltd/obix-cli-create
# or (after global install)
obix-cli-create

Usage

# Interactive (recommended)
npx @obinexusltd/obix-cli-create

# With a project name
npx @obinexusltd/obix-cli-create my-app

# Choose template upfront
npx @obinexusltd/obix-cli-create my-app --template node
npx @obinexusltd/obix-cli-create my-site --template html

# Non-interactive, all defaults
npx @obinexusltd/obix-cli-create my-app --yes

Templates

node (default)

Full-stack TypeScript application:

my-app/
├── src/
│   ├── core/       ← runtime.ts · types.ts · policies.ts
│   ├── ui/         ← renderer.ts · main.ts
│   ├── server/     ← app.ts (Express) · database.ts (node:sqlite)
│   └── cli/        ← index.ts (commander + inquirer)
├── package.json
├── tsconfig.json
└── .gitignore

Get started:

cd my-app
npm install
npm run dev       # → http://localhost:3000
npm run cli -- --help

html

Zero-dependency browser app — no build step:

my-site/
├── index.html
├── styles.css
├── app.js
├── package.json
└── .gitignore

Get started:

cd my-site
npx serve .       # → http://localhost:3000

What every OBIX app includes

Both templates implement the OBIX Heart UX patterns:

| Pattern | What it means | |---|---| | Controller → Control → Controllee | Input → state transition → DOM/DB output | | Data-Oriented Programming | State is a plain object; actions are pure functions | | #NoGhosting policy | Every open item must have an owner; policy runs on every change | | WCAG 2.1 AA | 48px touch targets, visible focus rings, skip links, ARIA live regions |

Options

| Flag | Description | |---|---| | [project-name] | Directory name / package name for the new project | | -t, --template <name> | node (default) or html | | -y, --yes | Skip all prompts, accept defaults |

OBINexus lineage

Part of the OBINexus Heart UX mono-repo (obix/cli/create/).
No riftlang, no nlink, no polybuild required — just npx.

Maintainer: Nnamdi Michael Okpala [email protected]
License: MIT