327 lines
17 KiB
Markdown
327 lines
17 KiB
Markdown
# @wrnexus/cli
|
|
|
|
Production parity commands:
|
|
|
|
```bash
|
|
wrnexus build .
|
|
wrnexus preview . --port=3000
|
|
wrnexus dev . --production-runtime
|
|
```
|
|
|
|
`preview` refuses to start without `dist/server.js` and executes that exact
|
|
artifact with the production profile. Production-runtime development rebuilds
|
|
the same minified artifact after app, public, or configuration changes and
|
|
keeps the last good server running when a rebuild fails.
|
|
|
|
> The `wrnexus` command-line tool that scaffolds, runs, builds, tests, and manages WrNexus apps.
|
|
|
|
Part of the **WrNexus** framework — an SSR-first, Bun-native full-stack web framework.
|
|
|
|
## Overview
|
|
|
|
`@wrnexus/cli` provides the `wrnexus` executable — the single entry point for developing a WrNexus app. It runs the HMR dev server, produces a self-contained production build, scaffolds apps/pages/components, drives database migrations, regenerates typed routes and queries, runs tests, and manages configuration profiles. It also scaffolds multi-app monorepos and serves them behind a domain-routing gateway. This is a CLI/build-time package (it shells out to the Bun binary for the dev child and tests) and it also exports the workspace config types via a subpath.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
bun add @wrnexus/cli
|
|
```
|
|
|
|
> Private package — the machine must be authenticated to the `wrnexus` npm org
|
|
> (a read token in `~/.npmrc`). Requires **Bun** (Node is not supported).
|
|
|
|
Once installed, invoke it from an app directory:
|
|
|
|
```bash
|
|
bunx wrnexus dev
|
|
# or add scripts: "dev": "wrnexus dev .", "build": "wrnexus build ."
|
|
```
|
|
|
|
## Commands
|
|
|
|
### Local production services
|
|
|
|
`wrnexus dev . --services` starts the application and the bounded local database,
|
|
cache, mail, SMS, webhook, storage, queue, cron, authentication and metrics simulator.
|
|
It generates a localhost/`*.localhost` development certificate under
|
|
`.wrnexus/certificates/` and serves both the application and service console over HTTPS.
|
|
Trust that certificate locally to remove the browser warning. Use `--services-http` only
|
|
when an external development proxy already terminates TLS.
|
|
|
|
### Exact production runtime with live updates
|
|
|
|
`wrnexus dev . --production-runtime` rebuilds and executes `dist/server.js` with
|
|
production resolution, serialization, caching, headers and assets. The supervisor keeps
|
|
the last good process when a build fails. On a successful rebuild the opt-in production
|
|
HMR socket reconnects, requests the new document and morphs it into the browser; ordinary
|
|
`wrnexus preview` and deployed production servers never include that client.
|
|
|
|
### API platform
|
|
|
|
`wrnexus api generate [app-dir]` (or `api docs`) derives operations from file routes and
|
|
emits `generated/api/openapi.json`, safe static documentation, Postman collection, curl examples,
|
|
and TypeScript, JavaScript, Java, Go and Python SDKs. Generate one client with
|
|
`wrnexus sdk generate <language> [app-dir]`.
|
|
|
|
Every command accepts an optional `[app-dir]` (defaults to `.`). Commands that read config or `.env` also accept `--profile=<name>` (see [Profiles](#profiles)).
|
|
|
|
| Command | Purpose |
|
|
| ------------------------------------- | ---------------------------------------------------------------------- |
|
|
| `wrnexus dev [app-dir] [--port=3000]` | Start the development server with live reload / HMR. |
|
|
| `wrnexus build [app-dir]` | Build a self-contained production server bundle + assets into `dist/`. |
|
|
| `wrnexus create <app-name>` | Scaffold a new single app from an inline template. |
|
|
| `wrnexus workspace <name>` | Scaffold a monorepo (`apps/*` + shared `packages/*`). |
|
|
| `wrnexus workspace add <name>` | Add and register an app in the current workspace. |
|
|
| `wrnexus gateway [--port=3000]` | Serve every workspace app behind one port, routed by domain. |
|
|
| `wrnexus production [workspace-dir]` | Build, migrate, and serve every workspace app in production. |
|
|
| `wrnexus generate <type> <name>` | Scaffold a `page` \| `component` \| `api` \| `schema`. |
|
|
| `wrnexus generate routes` | Regenerate the typed routes file (`app/routes.gen.ts`). |
|
|
| `wrnexus generate docker` | Scaffold `Dockerfile`, `.dockerignore`, and `docker-compose.yml`. |
|
|
| `wrnexus generate mobile` | Scaffold a Capacitor shell for iOS and Android. |
|
|
| `wrnexus mobile add <package...>` | Install Capacitor plugins and sync native projects. |
|
|
| `wrnexus eject <name...>` | Copy WrNexus UI component `.wrn` sources into `app/components/`. |
|
|
| `wrnexus db <cmd>` | Database migrations and tooling (see [db](#wrnexus-db)). |
|
|
| `wrnexus test [app-dir] [--watch]` | Run the app's tests via `bun test` (defaults to the `test` profile). |
|
|
| `wrnexus profiles [app-dir]` | List config profiles and their `.env` files, marking the active one. |
|
|
| `wrnexus compatibility check` | Check whether behavior defaults are explicitly pinned and current. |
|
|
| `wrnexus compatibility explain` | Explain configured, effective, and current compatibility behavior. |
|
|
| `wrnexus compatibility upgrade` | Back up config and explicitly opt into reviewed current behavior. |
|
|
| `wrnexus help` | Print usage. |
|
|
|
|
`wrnexus g` is an alias for `wrnexus generate`.
|
|
|
|
Compatibility upgrades never happen implicitly. New applications pin
|
|
`compatibilityDate` and `frameworkBehaviour`; existing applications use
|
|
`wrnexus compatibility explain` before the backed-up, idempotent upgrade command.
|
|
|
|
### `wrnexus dev`
|
|
|
|
Supervises a child dev-server process (from `@wrnexus/dev-server`). The child owns file watching and HMR: CSS and client-island edits update the live page over a WebSocket with no restart; when a server module changes, the child exits with a restart code and the supervisor respawns it (the browser reconnects and morphs in the new HTML). On startup it regenerates typed DB queries and typed routes (best effort). Use `--port=` to change the port (default `3000`).
|
|
|
|
```bash
|
|
wrnexus dev . --port=8080
|
|
```
|
|
|
|
### `wrnexus build`
|
|
|
|
Emits into `<app-dir>/dist/`:
|
|
|
|
- `server.js` — a single, minified, self-contained Bun server with a **static** manifest of every page / api / realtime / middleware / component / layout module (no runtime filesystem scan or on-the-fly bundling).
|
|
- `reactive.js`, `theme.css`, `theme.js`, `ui.css`, and (if present) `styles.css` — hashed, minified browser assets.
|
|
- `public/` — copied verbatim.
|
|
|
|
Before bundling, it regenerates typed queries for the default and every named database. Run the output with:
|
|
|
|
```bash
|
|
bun dist/server.js # PORT env var optional
|
|
# Generated apps also provide: npm start
|
|
# Build and start together: npm run production
|
|
```
|
|
|
|
### `wrnexus create`
|
|
|
|
Scaffolds a complete v0.8 app from an inline template. The generated project includes strict TypeScript, ESLint and Prettier, editor recommendations, environment templates, database migrations, locales, schemas, tests, API/middleware/realtime examples, Tailwind and Iconify, PWA/mobile defaults, and the framework package kits. Its `wrnexus.config.ts` documents the current imports, types, stores, performance, observability, tenancy, build, navigation, theme, i18n, database, storage, realtime, security, and profile configuration.
|
|
|
|
Use `bun run dev` during development, `bun run check` for the complete typecheck/lint/test/format gate, `bun run build && bun run start` for production, or `bun run production` to build and start in one command.
|
|
|
|
### `wrnexus update`
|
|
|
|
`wrnexus update --latest` performs a complete project upgrade. It hands control to the exact target CLI, backs up important project files under `.wrnexus/update-backups/`, updates every `@wrnexus/*` dependency, refreshes framework-owned references, and applies every versioned syntax/config/file migration between the project version and target version. After installation it runs the project's `check` and `build` scripts; the new version is recorded only after verification succeeds.
|
|
|
|
Use `--dry-run` to preview an upgrade or `--no-verify` when verification is intentionally handled elsewhere. Migrations never overwrite user-owned configuration wholesale: each release must provide a focused, idempotent transformation for any changed syntax or config contract.
|
|
|
|
```bash
|
|
wrnexus create my-app
|
|
```
|
|
|
|
### `wrnexus generate`
|
|
|
|
Scaffolds a single file from a template, refusing to overwrite an existing file. Types (with aliases): `page`/`p`, `component`/`c`, `api`/`a`, `schema`/`s`. Nested names create nested paths.
|
|
|
|
```bash
|
|
wrnexus generate page about # app/pages/about.wrn
|
|
wrnexus generate component user-card # app/components/user-card.wrn
|
|
wrnexus generate api users/list # app/api/users/list.ts
|
|
wrnexus generate schema signup # app/schemas/signup.ts
|
|
wrnexus generate routes # regenerate app/routes.gen.ts
|
|
wrnexus generate docker # Dockerfile + compose + .dockerignore
|
|
wrnexus generate mobile --mode=webview --app-id=com.example.app --app-name="Example" --url=https://app.example.com
|
|
wrnexus generate mobile --mode=native
|
|
```
|
|
|
|
The mobile generator creates a separate `mobile/` package and reads
|
|
`config.mobile.mode`. `webview` creates a Capacitor shell that renders the hosted
|
|
WrNexus application. `native` creates a WebView-free Expo/React Native app whose
|
|
screens call the shared backend through `mobile/src/wrnexus.ts`. Native screens
|
|
do not render `.wrn` HTML. In either mode, run `bun install` in `mobile/`; iOS
|
|
device builds require macOS and Xcode.
|
|
|
|
Install official or community Capacitor plugins through the root CLI:
|
|
|
|
```bash
|
|
wrnexus mobile add @capacitor/camera @capacitor/haptics
|
|
wrnexus mobile sync
|
|
wrnexus mobile assets # generate native icons from config.mobile.icon
|
|
```
|
|
|
|
In native mode, `mobile add` runs `expo install` and `mobile sync` runs Expo
|
|
prebuild. In WebView mode they retain the Capacitor install/sync behavior.
|
|
`wrnexus mobile compile` maps portable `app/pages/**/*.wrn` pages to Expo Router
|
|
TSX routes. Native `bun run start` invokes this compilation automatically.
|
|
|
|
Browser code can access installed plugins through the SSR-safe
|
|
`@wrnexus/mobile` bridge. The command adds each plugin to both the WrNexus app
|
|
(JavaScript proxy) and `mobile/` (native synchronization).
|
|
|
|
`wrnexus mobile sync` also configures Android so only true network failures use
|
|
the local connection-error screen. HTTP errors such as 404 and 500 keep their
|
|
WrNexus response pages.
|
|
|
|
### `wrnexus eject`
|
|
|
|
Copies a WrNexus UI component's `.wrn` source out of `@wrnexus/ui` into `app/components/`, so the app owns and can edit it (the app copy shadows the library one by name). Run with no names to list available components. It skips components that already exist in the app.
|
|
|
|
```bash
|
|
wrnexus eject button card modal
|
|
```
|
|
|
|
### `wrnexus db`
|
|
|
|
Database migrations and tooling. Without a flag, commands target the **default** database (`db` in `wrnexus.config.ts`, files under `app/db/`). Pass `--db=<name>` to target a named database (`databases.<name>`, files under `app/db/<name>/`).
|
|
|
|
| Subcommand | Purpose |
|
|
| ------------------------------- | ----------------------------------------------------------------------------------- |
|
|
| `db new <name> [--from-models]` | Scaffold a migration; `--from-models` derives it from the TS models in `schema.ts`. |
|
|
| `db migrate` | Apply all pending migrations. |
|
|
| `db rollback` | Revert the last applied migration. |
|
|
| `db status` | List applied / pending migrations. |
|
|
| `db generate` | Regenerate typed queries (`queries/*.sql` → `queries.gen.ts`). |
|
|
| `db seed` | Run the database's `seed.ts` (default export / `seed` function). |
|
|
| `db studio [table]` | Inspect tables — list row counts, or dump the first 50 rows of one table. |
|
|
|
|
```bash
|
|
wrnexus db new create_users --from-models
|
|
wrnexus db migrate
|
|
wrnexus db studio users
|
|
wrnexus db status --db=analytics
|
|
```
|
|
|
|
### `wrnexus workspace` and `wrnexus gateway`
|
|
|
|
`workspace <name>` scaffolds a monorepo: complete v0.8 apps under `apps/*`, shared libraries under `packages/*`, root TypeScript/lint/format/editor/environment tooling, and a `wrnexus.workspace.ts` that maps each app to the domains it serves. `gateway` runs every app behind one port and routes by `Host` header, with optional per-app auth and gateway-wide security (trusted hosts, rate limit, security headers, access log). Newly added workspace apps use the same current scaffold.
|
|
|
|
```bash
|
|
wrnexus workspace acme
|
|
wrnexus gateway --port=3000
|
|
```
|
|
|
|
For a complete production start, use the first-class workspace orchestrator:
|
|
|
|
```bash
|
|
wrnexus production --host=0.0.0.0 --port=3000
|
|
```
|
|
|
|
It builds every registered app, applies default and named-database SQL migrations
|
|
when present, and starts the production gateway only after preparation succeeds.
|
|
Use `--prepare-only`, `--no-build`, or `--no-migrate` when deployment stages are
|
|
managed separately; `--environment=<name>` selects another workspace environment.
|
|
|
|
From a workspace root, add and register another app in one command:
|
|
|
|
```bash
|
|
wrnexus workspace add reports --domain=reports.localhost
|
|
bun install
|
|
```
|
|
|
|
Development gateways bind to `127.0.0.1` by default for reliable access on Windows,
|
|
macOS, and Linux. Open the configured app domain on the gateway port (for example
|
|
`http://localhost:3000` or `http://admin.localhost:3000`), not the internal child ports
|
|
printed while apps start. Pass `--host=0.0.0.0` to accept connections from other devices.
|
|
|
|
### `wrnexus test`
|
|
|
|
Runs the app's tests with `bun test`. Defaults to the `test` profile (config + `.env.test`). Pass `--watch` to re-run on change; extra flags pass straight through to `bun test`.
|
|
|
|
```bash
|
|
wrnexus test . --watch
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Create and run a single application
|
|
|
|
```bash
|
|
bunx @wrnexus/cli create customer-portal
|
|
cd customer-portal
|
|
bun install
|
|
bun run dev
|
|
```
|
|
|
|
### Add routes and shared UI to an existing app
|
|
|
|
```bash
|
|
wrnexus generate page reports/monthly
|
|
wrnexus generate api reports/export
|
|
wrnexus generate component report-filter
|
|
wrnexus generate routes
|
|
```
|
|
|
|
### Create a multi-app workspace and add another app
|
|
|
|
```bash
|
|
wrnexus workspace company-suite
|
|
cd company-suite
|
|
wrnexus workspace add reports --domain=reports.localhost
|
|
bun install
|
|
wrnexus gateway --port=3000
|
|
```
|
|
|
|
Open `http://reports.localhost:3000`; the gateway selects `apps/reports` from the
|
|
request host.
|
|
|
|
### Upgrade with migrations and verification
|
|
|
|
```bash
|
|
wrnexus update --latest --dry-run
|
|
wrnexus update --latest
|
|
wrnexus doctor
|
|
```
|
|
|
|
Use `wrnexus doctor --fix [app-dir]` to apply conservative repairs before the
|
|
health check: create missing `app/pages` and a default config, align skewed
|
|
`@wrnexus/*` dependency ranges, record the current migration marker, and format
|
|
only syntax-valid `.wrn` files. Invalid JSON or WRN sources are reported/skipped
|
|
instead of overwritten; repeat runs are idempotent.
|
|
|
|
## Profiles
|
|
|
|
Pass `--profile=<name>` to `dev`, `build`, `db` (or set `WRNEXUS_PROFILE`) to select a config profile. The CLI publishes `WRNEXUS_PROFILE` so config loaders and the dev child pick it up, and loads that profile's `.env` cascade (`.env`, `.env.local`, `.env.<profile>`, `.env.<profile>.local`) into `process.env`.
|
|
|
|
```bash
|
|
wrnexus dev --profile=uat
|
|
wrnexus profiles # ● development (config, .env.development)
|
|
# ○ production
|
|
# ○ uat (config, .env.uat)
|
|
```
|
|
|
|
## Subpath exports
|
|
|
|
`@wrnexus/cli/workspace` exposes the workspace configuration types used by `wrnexus.workspace.ts`:
|
|
|
|
```ts
|
|
import type { WorkspaceConfig, WorkspaceApp } from "@wrnexus/cli/workspace";
|
|
|
|
const config: WorkspaceConfig = {
|
|
security: { trustedHostsOnly: true, headers: true, accessLog: true },
|
|
apps: [{ name: "web", dir: "apps/web", domains: ["localhost", "web.localhost"] }],
|
|
};
|
|
|
|
export default config;
|
|
```
|
|
|
|
## Requirements / Notes
|
|
|
|
- **Bun-only.** The CLI runs on Bun, spawns the Bun binary for the dev child and `bun test`, and the production build uses `Bun.build`. Node is not supported.
|
|
- Orchestrates the rest of the framework: `@wrnexus/dev-server` (dev/prod server + gateway), `@wrnexus/router` (route + typed-routes codegen), `@wrnexus/compiler` (`.wrn` → `.ts`), `@wrnexus/db` (migrations, typed queries), `@wrnexus/styles` (config, profiles, `.env`, themes, styles), `@wrnexus/ui` (ejectable WrNexus UI components), `@wrnexus/validation`, `@wrnexus/csr`, and `@wrnexus/i18n`.
|
|
- Reads `wrnexus.config.ts` for `db` / `databases`, `theme`, `styles`, `seo`, `security`, `i18n`, and `profiles`, and `wrnexus.workspace.ts` for the gateway.
|