WorkRoot/WRNexusJSDoc
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update portal for WRNexusJS 0.8.8

Browse Source
This commit is contained in:
Clintchiz
2026-08-11 14:41:58 +05:30
parent c767435cc0
commit 5c591ab7de
100 changed files with 1791 additions and 904 deletions
Download Patch File Download Diff File Expand all files Collapse all files
public/docs-index.json
+93 -93
View File
@@ -1,5 +1,5 @@
{
"version": "0.8.7",
"version": "0.8.8",
"status": "private-developer-preview",
"generatedAt": "2026-07-13",
"documents": [
@@ -7,630 +7,630 @@
"url": "/",
"title": "WRNexusJS",
"section": "portal",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/access",
"title": "access",
"section": "portal",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/getting-started",
"title": "getting started",
"section": "portal",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/tutorial",
"title": "tutorial",
"section": "portal",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/architecture",
"title": "architecture",
"section": "portal",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/language",
"title": "language",
"section": "portal",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages",
"title": "packages",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/project-structure",
"title": "project structure",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/routing",
"title": "routing",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/pages-and-components",
"title": "pages and components",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/server-data",
"title": "server data",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/api-routes",
"title": "api routes",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/middleware",
"title": "middleware",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/forms-and-validation",
"title": "forms and validation",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/authentication",
"title": "authentication",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/authorization",
"title": "authorization",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/security",
"title": "security",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/database",
"title": "database",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/uploads",
"title": "uploads",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/realtime",
"title": "realtime",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/pubsub",
"title": "pubsub",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/queues",
"title": "queues",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "experimental"
},
{
"url": "/guides/testing",
"title": "testing",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/workspaces-and-gateway",
"title": "workspaces and gateway",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/deployment",
"title": "deployment",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/configuration-and-profiles",
"title": "configuration and profiles",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/i18n-and-themes",
"title": "i18n and themes",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/mobile",
"title": "mobile",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "experimental"
},
{
"url": "/guides/observability",
"title": "observability",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/upgrading",
"title": "upgrading",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/troubleshooting",
"title": "troubleshooting",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/guides/full-stack-auth-demo",
"title": "full stack auth demo",
"section": "guide",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/examples",
"title": "examples",
"section": "portal",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/showcase",
"title": "showcase",
"section": "portal",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/benchmarks",
"title": "benchmarks",
"section": "portal",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/roadmap",
"title": "roadmap",
"section": "portal",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/changelog",
"title": "changelog",
"section": "portal",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/releases/0.8.7",
"title": "0.8.7",
"url": "/releases/0.8.8",
"title": "0.8.8",
"section": "portal",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/security",
"title": "security",
"section": "portal",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/support",
"title": "support",
"section": "portal",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/license",
"title": "license",
"section": "portal",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/search",
"title": "search",
"section": "portal",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/404",
"title": "404",
"section": "portal",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/ai",
"title": "ai",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/auth",
"title": "auth",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/authz",
"title": "authz",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/benchmark",
"title": "benchmark",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/cache",
"title": "cache",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/captcha",
"title": "captcha",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/cli",
"title": "cli",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/compiler",
"title": "compiler",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/content",
"title": "content",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/core",
"title": "core",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/csr",
"title": "csr",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/db",
"title": "db",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/dev-server",
"title": "dev server",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/dev-toolbar",
"title": "dev toolbar",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/encryption",
"title": "encryption",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/graphql",
"title": "graphql",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/helpers",
"title": "helpers",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/i18n",
"title": "i18n",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/identity",
"title": "identity",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/image",
"title": "image",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/jwt",
"title": "jwt",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/language-server",
"title": "language server",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/mcp",
"title": "mcp",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/mobile",
"title": "mobile",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "experimental"
},
{
"url": "/packages/native",
"title": "native",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/oauth",
"title": "oauth",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/observability",
"title": "observability",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/playground",
"title": "playground",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/plugin",
"title": "plugin",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/pubsub",
"title": "pubsub",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/pwa",
"title": "pwa",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/queue",
"title": "queue",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/reactive",
"title": "reactive",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/realtime",
"title": "realtime",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/router",
"title": "router",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/rpc",
"title": "rpc",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/security",
"title": "security",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/ssr",
"title": "ssr",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/store",
"title": "store",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/styles",
"title": "styles",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/syntax",
"title": "syntax",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/test",
"title": "test",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/tracking",
"title": "tracking",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/typecheck",
"title": "typecheck",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/ui",
"title": "ui",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/uploader",
"title": "uploader",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
},
{
"url": "/packages/validation",
"title": "validation",
"section": "package",
"version": "0.8.7",
"version": "0.8.8",
"stability": "preview"
}
]
public/llms-full.txt
+444 -8
View File
@@ -1,4 +1,4 @@
# WRNexusJS documentation 0.8.7
# WRNexusJS documentation 0.8.8
Status: Private Developer Preview. This site documents 47 release-aligned packages.
@@ -259,7 +259,7 @@ export const POST = async (ctx) => {
## CLI
See the generated **Complete CLI command reference** below. It is sourced from the installed 0.8.7 executable so command names and options cannot drift.
See the generated **Complete CLI command reference** below. It is sourced from the installed 0.8.8 executable so command names and options cannot drift.
## When asked to "create a page/component/feature"
@@ -1324,8 +1324,6 @@ bunx wrnexus update . --latest
The dry run previews dependency and migration changes. A real update prints the source and target versions, backup directory, each migration action, installation result, and verification result. Commit or back up the application before upgrading.
Release: WRNexusJS 0.8.7
# Complete CLI command reference
This section is generated from the installed `@wrnexus/cli@0.8.7` executable. It is the canonical command inventory for this release.
@@ -1537,6 +1535,430 @@ bunx wrnexus update . --latest
The dry run previews dependency and migration changes. A real update prints the source and target versions, backup directory, each migration action, installation result, and verification result. Commit or back up the application before upgrading.
# Complete CLI command reference
This section is generated from the installed `@wrnexus/cli@0.8.8` executable. It is the canonical command inventory for this release.
```text
wrnexus — WrNexus CLI
Usage:
wrnexus dev [app-dir] [--port=3000] [--host=::]
Start the development server (live reload)
wrnexus dev [app-dir] --services Start local production-service simulators with the app
wrnexus dev [app-dir] --production-runtime
wrnexus dev [app-dir] --services [--services-port=3099] [--services-http]
Rebuild and reload the exact production artifact
wrnexus build [app-dir] Build a production server bundle + assets
wrnexus preview [app-dir] Serve the existing exact production output
wrnexus create <app-name> Scaffold a new app
wrnexus workspace <name> Scaffold a monorepo (apps/* + shared packages/*)
wrnexus workspace add <name> [--domain=name.localhost]
Add an app to 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 the complete production workspace
wrnexus <environment> [workspace-dir] Run a configured workspace environment (development/staging/custom)
wrnexus generate <type> <name> Scaffold a page | component | api | schema
wrnexus generate routes | docker | mobile
Generate routes or scaffold deployment targets
wrnexus generate types [app-dir] Generate application-wide route/component/key types
wrnexus routes [app-dir] Generate typed named routes
wrnexus typecheck [app-dir] Generate types and check TypeScript plus every .wrn file
wrnexus mobile add <package...> Install Capacitor or Expo native packages
wrnexus mobile compile Compile .wrn pages into native Expo routes
wrnexus native list List cross-platform native capabilities
wrnexus native add <capability...> Install capability packages for the configured mobile mode
wrnexus eject <name...> Copy a Wire UI component into app/components
wrnexus update [dir] [--latest] Upgrade deps, migrate project files, and verify the app
wrnexus db <cmd> Migrations: migrate | rollback | status | seed | generate | new
wrnexus authz <cmd> Authorization: list | generate | init [--dialect=sqlite|postgres|mysql]
wrnexus test [level] [app-dir] [--watch]
Run unit | component | api | browser | visual | accessibility | performance
wrnexus profiles [app-dir] List config profiles (dev/prod/uat/…) and their env files
wrnexus doctor [app-dir] [--fix] Check project health; optionally apply safe repairs
wrnexus compatibility <check|explain|upgrade> [app-dir]
Inspect or explicitly upgrade behavior defaults
wrnexus contracts <check|snapshot> [app-dir]
Detect breaking boundary contract changes
wrnexus security <audit|headers|test> [app-dir]
Audit ASVS controls, inspect headers, or run abuse tests
wrnexus api <generate|docs> [app-dir] Generate OpenAPI, docs, Postman, examples and SDKs
wrnexus sdk generate <language> [app-dir]
Generate TypeScript, JavaScript, Java, Go, or Python SDK
wrnexus deploy <target> [app-dir] Generate docker | kubernetes | systemd | railway | render | fly
wrnexus mcp [app-dir] Start the WRNexus MCP server over stdio
wrnexus i18n <extract|validate> [app-dir]
Extract and audit translation keys
wrnexus report [app-dir] [--file=app/pages/page.wrn]
Create a sanitized reproduction bundle
wrnexus playground [--port=4173] Start the shareable WRN compiler playground
wrnexus config [app-dir] --explain Print the fully resolved profile configuration
wrnexus analyze [app-dir] Inspect dist/build-report.json and performance budgets
wrnexus explain <route|build|hydration|bundle> [subject] [app-dir]
Explain compiler and production build decisions
wrnexus explain <cache|permission> <subject> [app-dir]
Explain route caching or permission enforcement
wrnexus inspect <target> [app-dir] Inspect packages | plugins | routes | assets | runtimes | styles | migrations | bundle
wrnexus inspect component <name> [app-dir]
Inspect a component's typed public contract
wrnexus generate system <name> Scaffold a complete framework-native package
Profiles: pass --profile=<name> to dev/build/db (or set WRNEXUS_PROFILE) to load
that profile's .env cascade and config overrides. e.g. wrnexus dev --profile=uat
Workspace environments: configure protocol, rootDomain, port, hostname, runtime
(development|production), hmr, build, migrate, and profile in wrnexus.workspace.ts.
CLI overrides: --port, --host, --build/--no-build, --migrate/--no-migrate,
--profile, and --prepare-only.
Update options: --dry-run previews changes; --no-verify skips post-update check/build.
```
## CLI workflows with expected output
Commands below are copy-ready. Paths, ports, counts, and timings vary by project; the shown output identifies the success condition to check.
### Create, check, build, and preview an application
```bash
bunx @wrnexus/cli@0.8.8 create my-app
cd my-app
bun install
bunx wrnexus typecheck .
bunx wrnexus build .
bunx wrnexus preview . --port=3000
```
Expected output:
```text
✓ Application types are valid
✓ Runtime: .../dist/reactive.js
✓ Styles: .../dist/styles.css
✓ Server: .../dist/server.js
Run it: bun .../dist/server.js
```
### Generate framework files and committed application types
```bash
bunx wrnexus generate page Dashboard
bunx wrnexus generate component status-card
bunx wrnexus generate api health
bunx wrnexus generate schema account
bunx wrnexus generate routes
bunx wrnexus generate types .
```
Expected output includes created source paths followed by:
```text
✓ Generated app/routes.gen.ts (... routes)
✓ Generated .../app/types/wrnexus.generated.d.ts (... routes, ... components)
```
### Run development and production-runtime modes
```bash
bunx wrnexus dev . --port=3000
bunx wrnexus dev . --services --services-port=3099
bunx wrnexus dev . --production-runtime --port=3000
```
Expected output reports the active profile, discovered plugins/routes, generated cache path, and listening URL. Production-runtime mode rebuilds and reloads the exact production artifact.
### Database lifecycle
```bash
bunx wrnexus db status
bunx wrnexus db new create_accounts --from-models
bunx wrnexus db migrate
bunx wrnexus db generate
bunx wrnexus db seed
```
Expected output identifies the selected profile/dialect, migration state, applied migration names, and generated typed query files. Run `db rollback` only when intentionally reverting the latest migration.
### Diagnose, inspect, and enforce contracts
```bash
bunx wrnexus doctor .
bunx wrnexus typecheck .
bunx wrnexus compatibility check .
bunx wrnexus contracts check .
bunx wrnexus security audit .
bunx wrnexus inspect packages .
bunx wrnexus inspect routes .
bunx wrnexus inspect component Navbar .
bunx wrnexus analyze .
```
Successful checks exit with status 0. Inspect commands print the resolved package, route, component, asset, runtime, style, migration, or bundle contract without changing the application.
### Tests, API artifacts, SDKs, and deployment manifests
```bash
bunx wrnexus test unit .
bunx wrnexus test component .
bunx wrnexus test api .
bunx wrnexus test browser .
bunx wrnexus api generate .
bunx wrnexus api docs .
bunx wrnexus sdk generate typescript .
bunx wrnexus deploy docker .
```
Test commands return the underlying suite summary and a nonzero status on failure. API/SDK/deploy commands report each generated artifact; review and commit generated files after validation.
### Workspaces and environments
```bash
bunx wrnexus workspace company-platform
cd company-platform
bunx wrnexus workspace add reports --domain=reports.localhost
bunx wrnexus gateway --port=3000
bunx wrnexus production . --prepare-only
bunx wrnexus staging .
```
Expected output lists created apps, domain mappings, selected environment/profile, build and migration decisions, and the gateway address.
### Internationalization, native targets, MCP, and support bundles
```bash
bunx wrnexus i18n extract .
bunx wrnexus i18n validate .
bunx wrnexus generate mobile
bunx wrnexus mobile compile
bunx wrnexus native list
bunx wrnexus mcp .
bunx wrnexus report . --file=app/pages/index.wrn
```
Expected output identifies extracted/validated translation keys, generated native routes, available capabilities, MCP stdio startup, or the sanitized reproduction archive. MCP uses stdio, so protocol messages—not a web URL—are its normal runtime output.
### Safe upgrades
```bash
bunx wrnexus update . --latest --dry-run
bunx wrnexus update . --latest
```
The dry run previews dependency and migration changes. A real update prints the source and target versions, backup directory, each migration action, installation result, and verification result. Commit or back up the application before upgrading.
Release: WRNexusJS 0.8.8
# Complete CLI command reference
This section is generated from the installed `@wrnexus/cli@0.8.8` executable. It is the canonical command inventory for this release.
```text
wrnexus — WrNexus CLI
Usage:
wrnexus dev [app-dir] [--port=3000] [--host=::]
Start the development server (live reload)
wrnexus dev [app-dir] --services Start local production-service simulators with the app
wrnexus dev [app-dir] --production-runtime
wrnexus dev [app-dir] --services [--services-port=3099] [--services-http]
Rebuild and reload the exact production artifact
wrnexus build [app-dir] Build a production server bundle + assets
wrnexus preview [app-dir] Serve the existing exact production output
wrnexus create <app-name> Scaffold a new app
wrnexus workspace <name> Scaffold a monorepo (apps/* + shared packages/*)
wrnexus workspace add <name> [--domain=name.localhost]
Add an app to 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 the complete production workspace
wrnexus <environment> [workspace-dir] Run a configured workspace environment (development/staging/custom)
wrnexus generate <type> <name> Scaffold a page | component | api | schema
wrnexus generate routes | docker | mobile
Generate routes or scaffold deployment targets
wrnexus generate types [app-dir] Generate application-wide route/component/key types
wrnexus routes [app-dir] Generate typed named routes
wrnexus typecheck [app-dir] Generate types and check TypeScript plus every .wrn file
wrnexus mobile add <package...> Install Capacitor or Expo native packages
wrnexus mobile compile Compile .wrn pages into native Expo routes
wrnexus native list List cross-platform native capabilities
wrnexus native add <capability...> Install capability packages for the configured mobile mode
wrnexus eject <name...> Copy a Wire UI component into app/components
wrnexus update [dir] [--latest] Upgrade deps, migrate project files, and verify the app
wrnexus db <cmd> Migrations: migrate | rollback | status | seed | generate | new
wrnexus authz <cmd> Authorization: list | generate | init [--dialect=sqlite|postgres|mysql]
wrnexus test [level] [app-dir] [--watch]
Run unit | component | api | browser | visual | accessibility | performance
wrnexus profiles [app-dir] List config profiles (dev/prod/uat/…) and their env files
wrnexus doctor [app-dir] [--fix] Check project health; optionally apply safe repairs
wrnexus compatibility <check|explain|upgrade> [app-dir]
Inspect or explicitly upgrade behavior defaults
wrnexus contracts <check|snapshot> [app-dir]
Detect breaking boundary contract changes
wrnexus security <audit|headers|test> [app-dir]
Audit ASVS controls, inspect headers, or run abuse tests
wrnexus api <generate|docs> [app-dir] Generate OpenAPI, docs, Postman, examples and SDKs
wrnexus sdk generate <language> [app-dir]
Generate TypeScript, JavaScript, Java, Go, or Python SDK
wrnexus deploy <target> [app-dir] Generate docker | kubernetes | systemd | railway | render | fly
wrnexus mcp [app-dir] Start the WRNexus MCP server over stdio
wrnexus i18n <extract|validate> [app-dir]
Extract and audit translation keys
wrnexus report [app-dir] [--file=app/pages/page.wrn]
Create a sanitized reproduction bundle
wrnexus playground [--port=4173] Start the shareable WRN compiler playground
wrnexus config [app-dir] --explain Print the fully resolved profile configuration
wrnexus analyze [app-dir] Inspect dist/build-report.json and performance budgets
wrnexus explain <route|build|hydration|bundle> [subject] [app-dir]
Explain compiler and production build decisions
wrnexus explain <cache|permission> <subject> [app-dir]
Explain route caching or permission enforcement
wrnexus inspect <target> [app-dir] Inspect packages | plugins | routes | assets | runtimes | styles | migrations | bundle
wrnexus inspect component <name> [app-dir]
Inspect a component's typed public contract
wrnexus generate system <name> Scaffold a complete framework-native package
Profiles: pass --profile=<name> to dev/build/db (or set WRNEXUS_PROFILE) to load
that profile's .env cascade and config overrides. e.g. wrnexus dev --profile=uat
Workspace environments: configure protocol, rootDomain, port, hostname, runtime
(development|production), hmr, build, migrate, and profile in wrnexus.workspace.ts.
CLI overrides: --port, --host, --build/--no-build, --migrate/--no-migrate,
--profile, and --prepare-only.
Update options: --dry-run previews changes; --no-verify skips post-update check/build.
```
## CLI workflows with expected output
Commands below are copy-ready. Paths, ports, counts, and timings vary by project; the shown output identifies the success condition to check.
### Create, check, build, and preview an application
```bash
bunx @wrnexus/cli@0.8.8 create my-app
cd my-app
bun install
bunx wrnexus typecheck .
bunx wrnexus build .
bunx wrnexus preview . --port=3000
```
Expected output:
```text
✓ Application types are valid
✓ Runtime: .../dist/reactive.js
✓ Styles: .../dist/styles.css
✓ Server: .../dist/server.js
Run it: bun .../dist/server.js
```
### Generate framework files and committed application types
```bash
bunx wrnexus generate page Dashboard
bunx wrnexus generate component status-card
bunx wrnexus generate api health
bunx wrnexus generate schema account
bunx wrnexus generate routes
bunx wrnexus generate types .
```
Expected output includes created source paths followed by:
```text
✓ Generated app/routes.gen.ts (... routes)
✓ Generated .../app/types/wrnexus.generated.d.ts (... routes, ... components)
```
### Run development and production-runtime modes
```bash
bunx wrnexus dev . --port=3000
bunx wrnexus dev . --services --services-port=3099
bunx wrnexus dev . --production-runtime --port=3000
```
Expected output reports the active profile, discovered plugins/routes, generated cache path, and listening URL. Production-runtime mode rebuilds and reloads the exact production artifact.
### Database lifecycle
```bash
bunx wrnexus db status
bunx wrnexus db new create_accounts --from-models
bunx wrnexus db migrate
bunx wrnexus db generate
bunx wrnexus db seed
```
Expected output identifies the selected profile/dialect, migration state, applied migration names, and generated typed query files. Run `db rollback` only when intentionally reverting the latest migration.
### Diagnose, inspect, and enforce contracts
```bash
bunx wrnexus doctor .
bunx wrnexus typecheck .
bunx wrnexus compatibility check .
bunx wrnexus contracts check .
bunx wrnexus security audit .
bunx wrnexus inspect packages .
bunx wrnexus inspect routes .
bunx wrnexus inspect component Navbar .
bunx wrnexus analyze .
```
Successful checks exit with status 0. Inspect commands print the resolved package, route, component, asset, runtime, style, migration, or bundle contract without changing the application.
### Tests, API artifacts, SDKs, and deployment manifests
```bash
bunx wrnexus test unit .
bunx wrnexus test component .
bunx wrnexus test api .
bunx wrnexus test browser .
bunx wrnexus api generate .
bunx wrnexus api docs .
bunx wrnexus sdk generate typescript .
bunx wrnexus deploy docker .
```
Test commands return the underlying suite summary and a nonzero status on failure. API/SDK/deploy commands report each generated artifact; review and commit generated files after validation.
### Workspaces and environments
```bash
bunx wrnexus workspace company-platform
cd company-platform
bunx wrnexus workspace add reports --domain=reports.localhost
bunx wrnexus gateway --port=3000
bunx wrnexus production . --prepare-only
bunx wrnexus staging .
```
Expected output lists created apps, domain mappings, selected environment/profile, build and migration decisions, and the gateway address.
### Internationalization, native targets, MCP, and support bundles
```bash
bunx wrnexus i18n extract .
bunx wrnexus i18n validate .
bunx wrnexus generate mobile
bunx wrnexus mobile compile
bunx wrnexus native list
bunx wrnexus mcp .
bunx wrnexus report . --file=app/pages/index.wrn
```
Expected output identifies extracted/validated translation keys, generated native routes, available capabilities, MCP stdio startup, or the sanitized reproduction archive. MCP uses stdio, so protocol messages—not a web URL—are its normal runtime output.
### Safe upgrades
```bash
bunx wrnexus update . --latest --dry-run
bunx wrnexus update . --latest
```
The dry run previews dependency and migration changes. A real update prints the source and target versions, backup directory, each migration action, installation result, and verification result. Commit or back up the application before upgrading.
# Canonical documentation locations
- Framework and package documentation: https://wrnexusjs.dev/
@@ -1544,7 +1966,7 @@ The dry run previews dependency and migration changes. A real update prints the
# Installed package documentation
The following README files and declarations come from the installed private 0.8.7 release.
The following README files and declarations come from the installed private 0.8.8 release.
## @wrnexus/ai
@@ -2152,7 +2574,7 @@ export { A as AUTH_SECURITY_EVENT_TYPES, a as AuthAccountStatus, b as AuthClock,
export { MemoryAuthStore } from './stores/memory.js';
export { SqlAuthStore } from './stores/sql.js';
export { AUTH_SESSION_KEY, authSession, clearAuthSession, establishAuthSession, getAuthSession, getAuthUser, isAuthenticatedContext, requireAuth } from './middleware.js';
export { A as AuthHttpOptions, a as AuthPasskeyHttpOptions, b as AuthSchemaOverrides, c as AuthSchemaSet, d as authBrowserSchemaDescriptors, e as authBrowserSchemaMap, f as authSchemas, g as authenticatorConfirmSchema, h as authenticatorDisableSchema, i as authenticatorSetupSchema, j as changePasswordSchema, k as createAuthHttpHandlers, l as emptyActionSchema, m as impersonationStartSchema, n as invitationAcceptSchema, o as loginSchema, p as magicLinkConsumeSchema, q as magicLinkRequestSchema, r as mfaOtpRequestSchema, s as mfaSchema, t as otpIssueSchema, u as otpLoginCompleteSchema, v as otpLoginRequestSchema, w as otpSchema, x as passkeyAuthenticationOptionsSchema, y as passkeyAuthenticationVerifySchema, z as passkeyRegistrationOptionsSchema, B as passkeyRegistrationVerifySchema, C as passwordResetRequestSchema, D as passwordResetSchema, E as recoveryCodesSchema, F as registerSchema, G as resolveAuthSchemas, H as sessionRevokeSchema, I as signUpSchema, J as verificationRequestSchema, K as verificationTokenSchema } from './index-CSXo5T-F.js';
export { A as AuthHttpOptions, a as AuthPasskeyHttpOptions, b as AuthSchemaOverrides, c as AuthSchemaSet, d as authBrowserSchemaDescriptors, e as authBrowserSchemaMap, f as authSchemas, g as authenticatorConfirmSchema, h as authenticatorDisableSchema, i as authenticatorSetupSchema, j as changePasswordSchema, k as createAuthHttpHandlers, l as emptyActionSchema, m as impersonationStartSchema, n as invitationAcceptSchema, o as loginSchema, p as magicLinkConsumeSchema, q as magicLinkRequestSchema, r as mfaOtpRequestSchema, s as mfaSchema, t as otpIssueSchema, u as otpLoginCompleteSchema, v as otpLoginRequestSchema, w as otpSchema, x as passkeyAuthenticationOptionsSchema, y as passkeyAuthenticationVerifySchema, z as passkeyRegistrationOptionsSchema, B as passkeyRegistrationVerifySchema, C as passwordResetRequestSchema, D as passwordResetSchema, E as recoveryCodesSchema, F as registerSchema, G as resolveAuthSchemas, H as sessionRevokeSchema, I as signUpSchema, J as verificationRequestSchema, K as verificationTokenSchema } from './index-B4uaD0Z3.js';
export { AuthAuditIssue, AuthConfig, AuthPluginOptions, AuthRoutesConfig, authComponentsDir, authPlugin } from './plugin.js';
export { DefaultAuthRouteOptions, clearDefaultAuthEngine, getDefaultAuthEngine, getDefaultAuthRouteOptions, getDefaultAuthSchemas, hasDefaultAuthEngine, setDefaultAuthEngine, setDefaultAuthRouteOptions, setDefaultAuthSchemas, tryGetDefaultAuthEngine } from './runtime.js';
export { createAuthSecretProtector } from './protector.js';
@@ -9623,6 +10045,10 @@ interface WorkspaceCompletionItem {
}
declare function workspaceCompletionItems(root: string): WorkspaceCompletionItem[];
declare function clearWorkspaceIndexCache(root?: string): void;
declare function workspaceSymbolLocations(root: string, name: string, limit?: number): {
uri: string;
range: Range;
}[];
declare function extractComponentRefactor(document: TextDocument, range: Range, name: string): {
documentChanges: ({
kind: string;
@@ -9664,7 +10090,9 @@ declare function wordAt(text: string, position: Position): {
word: string;
range: Range;
} | null;
declare function documentDiagnostics(document: TextDocument): {
declare function documentDiagnostics(document: TextDocument, options?: {
includeTypes?: boolean;
}): {
range: {
start: {
line: number;
@@ -9740,8 +10168,16 @@ declare function completionItems(): {
kind: number;
detail: string;
}[];
declare const semanticTokensLegend: {
tokenTypes: "variable"[];
tokenModifiers: ("declaration" | "modification")[];
};
/** Encode state declarations, reads, and writes using the LSP relative token format. */
declare function semanticTokens(document: TextDocument): {
data: number[];
};
export { type Position, type Range, type TextDocument, WRN_COMPLETIONS, type WorkspaceCompletionItem, clearWorkspaceIndexCache, completionItems, definitionLocation, documentDiagnostics, documentSymbols, extractComponentRefactor, formatDocument, hover, htmlToWrn, offsetAt, positionAt, symbolLocations, virtualTypeScriptDocument, wordAt, workspaceCompletionItems };
export { type Position, type Range, type TextDocument, WRN_COMPLETIONS, type WorkspaceCompletionItem, clearWorkspaceIndexCache, completionItems, definitionLocation, documentDiagnostics, documentSymbols, extractComponentRefactor, formatDocument, hover, htmlToWrn, offsetAt, positionAt, semanticTokens, semanticTokensLegend, symbolLocations, virtualTypeScriptDocument, wordAt, workspaceCompletionItems, workspaceSymbolLocations };
```
---
public/llms.txt
+472 -50
View File
@@ -1,4 +1,4 @@
# WRNexusJS documentation 0.8.7
# WRNexusJS documentation 0.8.8
Status: Private Developer Preview. This site documents 47 release-aligned packages.
@@ -259,7 +259,7 @@ export const POST = async (ctx) => {
## CLI
See the generated **Complete CLI command reference** below. It is sourced from the installed 0.8.7 executable so command names and options cannot drift.
See the generated **Complete CLI command reference** below. It is sourced from the installed 0.8.8 executable so command names and options cannot drift.
## When asked to "create a page/component/feature"
@@ -1535,6 +1535,428 @@ bunx wrnexus update . --latest
The dry run previews dependency and migration changes. A real update prints the source and target versions, backup directory, each migration action, installation result, and verification result. Commit or back up the application before upgrading.
# Complete CLI command reference
This section is generated from the installed `@wrnexus/cli@0.8.8` executable. It is the canonical command inventory for this release.
```text
wrnexus — WrNexus CLI
Usage:
wrnexus dev [app-dir] [--port=3000] [--host=::]
Start the development server (live reload)
wrnexus dev [app-dir] --services Start local production-service simulators with the app
wrnexus dev [app-dir] --production-runtime
wrnexus dev [app-dir] --services [--services-port=3099] [--services-http]
Rebuild and reload the exact production artifact
wrnexus build [app-dir] Build a production server bundle + assets
wrnexus preview [app-dir] Serve the existing exact production output
wrnexus create <app-name> Scaffold a new app
wrnexus workspace <name> Scaffold a monorepo (apps/* + shared packages/*)
wrnexus workspace add <name> [--domain=name.localhost]
Add an app to 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 the complete production workspace
wrnexus <environment> [workspace-dir] Run a configured workspace environment (development/staging/custom)
wrnexus generate <type> <name> Scaffold a page | component | api | schema
wrnexus generate routes | docker | mobile
Generate routes or scaffold deployment targets
wrnexus generate types [app-dir] Generate application-wide route/component/key types
wrnexus routes [app-dir] Generate typed named routes
wrnexus typecheck [app-dir] Generate types and check TypeScript plus every .wrn file
wrnexus mobile add <package...> Install Capacitor or Expo native packages
wrnexus mobile compile Compile .wrn pages into native Expo routes
wrnexus native list List cross-platform native capabilities
wrnexus native add <capability...> Install capability packages for the configured mobile mode
wrnexus eject <name...> Copy a Wire UI component into app/components
wrnexus update [dir] [--latest] Upgrade deps, migrate project files, and verify the app
wrnexus db <cmd> Migrations: migrate | rollback | status | seed | generate | new
wrnexus authz <cmd> Authorization: list | generate | init [--dialect=sqlite|postgres|mysql]
wrnexus test [level] [app-dir] [--watch]
Run unit | component | api | browser | visual | accessibility | performance
wrnexus profiles [app-dir] List config profiles (dev/prod/uat/…) and their env files
wrnexus doctor [app-dir] [--fix] Check project health; optionally apply safe repairs
wrnexus compatibility <check|explain|upgrade> [app-dir]
Inspect or explicitly upgrade behavior defaults
wrnexus contracts <check|snapshot> [app-dir]
Detect breaking boundary contract changes
wrnexus security <audit|headers|test> [app-dir]
Audit ASVS controls, inspect headers, or run abuse tests
wrnexus api <generate|docs> [app-dir] Generate OpenAPI, docs, Postman, examples and SDKs
wrnexus sdk generate <language> [app-dir]
Generate TypeScript, JavaScript, Java, Go, or Python SDK
wrnexus deploy <target> [app-dir] Generate docker | kubernetes | systemd | railway | render | fly
wrnexus mcp [app-dir] Start the WRNexus MCP server over stdio
wrnexus i18n <extract|validate> [app-dir]
Extract and audit translation keys
wrnexus report [app-dir] [--file=app/pages/page.wrn]
Create a sanitized reproduction bundle
wrnexus playground [--port=4173] Start the shareable WRN compiler playground
wrnexus config [app-dir] --explain Print the fully resolved profile configuration
wrnexus analyze [app-dir] Inspect dist/build-report.json and performance budgets
wrnexus explain <route|build|hydration|bundle> [subject] [app-dir]
Explain compiler and production build decisions
wrnexus explain <cache|permission> <subject> [app-dir]
Explain route caching or permission enforcement
wrnexus inspect <target> [app-dir] Inspect packages | plugins | routes | assets | runtimes | styles | migrations | bundle
wrnexus inspect component <name> [app-dir]
Inspect a component's typed public contract
wrnexus generate system <name> Scaffold a complete framework-native package
Profiles: pass --profile=<name> to dev/build/db (or set WRNEXUS_PROFILE) to load
that profile's .env cascade and config overrides. e.g. wrnexus dev --profile=uat
Workspace environments: configure protocol, rootDomain, port, hostname, runtime
(development|production), hmr, build, migrate, and profile in wrnexus.workspace.ts.
CLI overrides: --port, --host, --build/--no-build, --migrate/--no-migrate,
--profile, and --prepare-only.
Update options: --dry-run previews changes; --no-verify skips post-update check/build.
```
## CLI workflows with expected output
Commands below are copy-ready. Paths, ports, counts, and timings vary by project; the shown output identifies the success condition to check.
### Create, check, build, and preview an application
```bash
bunx @wrnexus/cli@0.8.8 create my-app
cd my-app
bun install
bunx wrnexus typecheck .
bunx wrnexus build .
bunx wrnexus preview . --port=3000
```
Expected output:
```text
✓ Application types are valid
✓ Runtime: .../dist/reactive.js
✓ Styles: .../dist/styles.css
✓ Server: .../dist/server.js
Run it: bun .../dist/server.js
```
### Generate framework files and committed application types
```bash
bunx wrnexus generate page Dashboard
bunx wrnexus generate component status-card
bunx wrnexus generate api health
bunx wrnexus generate schema account
bunx wrnexus generate routes
bunx wrnexus generate types .
```
Expected output includes created source paths followed by:
```text
✓ Generated app/routes.gen.ts (... routes)
✓ Generated .../app/types/wrnexus.generated.d.ts (... routes, ... components)
```
### Run development and production-runtime modes
```bash
bunx wrnexus dev . --port=3000
bunx wrnexus dev . --services --services-port=3099
bunx wrnexus dev . --production-runtime --port=3000
```
Expected output reports the active profile, discovered plugins/routes, generated cache path, and listening URL. Production-runtime mode rebuilds and reloads the exact production artifact.
### Database lifecycle
```bash
bunx wrnexus db status
bunx wrnexus db new create_accounts --from-models
bunx wrnexus db migrate
bunx wrnexus db generate
bunx wrnexus db seed
```
Expected output identifies the selected profile/dialect, migration state, applied migration names, and generated typed query files. Run `db rollback` only when intentionally reverting the latest migration.
### Diagnose, inspect, and enforce contracts
```bash
bunx wrnexus doctor .
bunx wrnexus typecheck .
bunx wrnexus compatibility check .
bunx wrnexus contracts check .
bunx wrnexus security audit .
bunx wrnexus inspect packages .
bunx wrnexus inspect routes .
bunx wrnexus inspect component Navbar .
bunx wrnexus analyze .
```
Successful checks exit with status 0. Inspect commands print the resolved package, route, component, asset, runtime, style, migration, or bundle contract without changing the application.
### Tests, API artifacts, SDKs, and deployment manifests
```bash
bunx wrnexus test unit .
bunx wrnexus test component .
bunx wrnexus test api .
bunx wrnexus test browser .
bunx wrnexus api generate .
bunx wrnexus api docs .
bunx wrnexus sdk generate typescript .
bunx wrnexus deploy docker .
```
Test commands return the underlying suite summary and a nonzero status on failure. API/SDK/deploy commands report each generated artifact; review and commit generated files after validation.
### Workspaces and environments
```bash
bunx wrnexus workspace company-platform
cd company-platform
bunx wrnexus workspace add reports --domain=reports.localhost
bunx wrnexus gateway --port=3000
bunx wrnexus production . --prepare-only
bunx wrnexus staging .
```
Expected output lists created apps, domain mappings, selected environment/profile, build and migration decisions, and the gateway address.
### Internationalization, native targets, MCP, and support bundles
```bash
bunx wrnexus i18n extract .
bunx wrnexus i18n validate .
bunx wrnexus generate mobile
bunx wrnexus mobile compile
bunx wrnexus native list
bunx wrnexus mcp .
bunx wrnexus report . --file=app/pages/index.wrn
```
Expected output identifies extracted/validated translation keys, generated native routes, available capabilities, MCP stdio startup, or the sanitized reproduction archive. MCP uses stdio, so protocol messages—not a web URL—are its normal runtime output.
### Safe upgrades
```bash
bunx wrnexus update . --latest --dry-run
bunx wrnexus update . --latest
```
The dry run previews dependency and migration changes. A real update prints the source and target versions, backup directory, each migration action, installation result, and verification result. Commit or back up the application before upgrading.
# Complete CLI command reference
This section is generated from the installed `@wrnexus/cli@0.8.8` executable. It is the canonical command inventory for this release.
```text
wrnexus — WrNexus CLI
Usage:
wrnexus dev [app-dir] [--port=3000] [--host=::]
Start the development server (live reload)
wrnexus dev [app-dir] --services Start local production-service simulators with the app
wrnexus dev [app-dir] --production-runtime
wrnexus dev [app-dir] --services [--services-port=3099] [--services-http]
Rebuild and reload the exact production artifact
wrnexus build [app-dir] Build a production server bundle + assets
wrnexus preview [app-dir] Serve the existing exact production output
wrnexus create <app-name> Scaffold a new app
wrnexus workspace <name> Scaffold a monorepo (apps/* + shared packages/*)
wrnexus workspace add <name> [--domain=name.localhost]
Add an app to 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 the complete production workspace
wrnexus <environment> [workspace-dir] Run a configured workspace environment (development/staging/custom)
wrnexus generate <type> <name> Scaffold a page | component | api | schema
wrnexus generate routes | docker | mobile
Generate routes or scaffold deployment targets
wrnexus generate types [app-dir] Generate application-wide route/component/key types
wrnexus routes [app-dir] Generate typed named routes
wrnexus typecheck [app-dir] Generate types and check TypeScript plus every .wrn file
wrnexus mobile add <package...> Install Capacitor or Expo native packages
wrnexus mobile compile Compile .wrn pages into native Expo routes
wrnexus native list List cross-platform native capabilities
wrnexus native add <capability...> Install capability packages for the configured mobile mode
wrnexus eject <name...> Copy a Wire UI component into app/components
wrnexus update [dir] [--latest] Upgrade deps, migrate project files, and verify the app
wrnexus db <cmd> Migrations: migrate | rollback | status | seed | generate | new
wrnexus authz <cmd> Authorization: list | generate | init [--dialect=sqlite|postgres|mysql]
wrnexus test [level] [app-dir] [--watch]
Run unit | component | api | browser | visual | accessibility | performance
wrnexus profiles [app-dir] List config profiles (dev/prod/uat/…) and their env files
wrnexus doctor [app-dir] [--fix] Check project health; optionally apply safe repairs
wrnexus compatibility <check|explain|upgrade> [app-dir]
Inspect or explicitly upgrade behavior defaults
wrnexus contracts <check|snapshot> [app-dir]
Detect breaking boundary contract changes
wrnexus security <audit|headers|test> [app-dir]
Audit ASVS controls, inspect headers, or run abuse tests
wrnexus api <generate|docs> [app-dir] Generate OpenAPI, docs, Postman, examples and SDKs
wrnexus sdk generate <language> [app-dir]
Generate TypeScript, JavaScript, Java, Go, or Python SDK
wrnexus deploy <target> [app-dir] Generate docker | kubernetes | systemd | railway | render | fly
wrnexus mcp [app-dir] Start the WRNexus MCP server over stdio
wrnexus i18n <extract|validate> [app-dir]
Extract and audit translation keys
wrnexus report [app-dir] [--file=app/pages/page.wrn]
Create a sanitized reproduction bundle
wrnexus playground [--port=4173] Start the shareable WRN compiler playground
wrnexus config [app-dir] --explain Print the fully resolved profile configuration
wrnexus analyze [app-dir] Inspect dist/build-report.json and performance budgets
wrnexus explain <route|build|hydration|bundle> [subject] [app-dir]
Explain compiler and production build decisions
wrnexus explain <cache|permission> <subject> [app-dir]
Explain route caching or permission enforcement
wrnexus inspect <target> [app-dir] Inspect packages | plugins | routes | assets | runtimes | styles | migrations | bundle
wrnexus inspect component <name> [app-dir]
Inspect a component's typed public contract
wrnexus generate system <name> Scaffold a complete framework-native package
Profiles: pass --profile=<name> to dev/build/db (or set WRNEXUS_PROFILE) to load
that profile's .env cascade and config overrides. e.g. wrnexus dev --profile=uat
Workspace environments: configure protocol, rootDomain, port, hostname, runtime
(development|production), hmr, build, migrate, and profile in wrnexus.workspace.ts.
CLI overrides: --port, --host, --build/--no-build, --migrate/--no-migrate,
--profile, and --prepare-only.
Update options: --dry-run previews changes; --no-verify skips post-update check/build.
```
## CLI workflows with expected output
Commands below are copy-ready. Paths, ports, counts, and timings vary by project; the shown output identifies the success condition to check.
### Create, check, build, and preview an application
```bash
bunx @wrnexus/cli@0.8.8 create my-app
cd my-app
bun install
bunx wrnexus typecheck .
bunx wrnexus build .
bunx wrnexus preview . --port=3000
```
Expected output:
```text
✓ Application types are valid
✓ Runtime: .../dist/reactive.js
✓ Styles: .../dist/styles.css
✓ Server: .../dist/server.js
Run it: bun .../dist/server.js
```
### Generate framework files and committed application types
```bash
bunx wrnexus generate page Dashboard
bunx wrnexus generate component status-card
bunx wrnexus generate api health
bunx wrnexus generate schema account
bunx wrnexus generate routes
bunx wrnexus generate types .
```
Expected output includes created source paths followed by:
```text
✓ Generated app/routes.gen.ts (... routes)
✓ Generated .../app/types/wrnexus.generated.d.ts (... routes, ... components)
```
### Run development and production-runtime modes
```bash
bunx wrnexus dev . --port=3000
bunx wrnexus dev . --services --services-port=3099
bunx wrnexus dev . --production-runtime --port=3000
```
Expected output reports the active profile, discovered plugins/routes, generated cache path, and listening URL. Production-runtime mode rebuilds and reloads the exact production artifact.
### Database lifecycle
```bash
bunx wrnexus db status
bunx wrnexus db new create_accounts --from-models
bunx wrnexus db migrate
bunx wrnexus db generate
bunx wrnexus db seed
```
Expected output identifies the selected profile/dialect, migration state, applied migration names, and generated typed query files. Run `db rollback` only when intentionally reverting the latest migration.
### Diagnose, inspect, and enforce contracts
```bash
bunx wrnexus doctor .
bunx wrnexus typecheck .
bunx wrnexus compatibility check .
bunx wrnexus contracts check .
bunx wrnexus security audit .
bunx wrnexus inspect packages .
bunx wrnexus inspect routes .
bunx wrnexus inspect component Navbar .
bunx wrnexus analyze .
```
Successful checks exit with status 0. Inspect commands print the resolved package, route, component, asset, runtime, style, migration, or bundle contract without changing the application.
### Tests, API artifacts, SDKs, and deployment manifests
```bash
bunx wrnexus test unit .
bunx wrnexus test component .
bunx wrnexus test api .
bunx wrnexus test browser .
bunx wrnexus api generate .
bunx wrnexus api docs .
bunx wrnexus sdk generate typescript .
bunx wrnexus deploy docker .
```
Test commands return the underlying suite summary and a nonzero status on failure. API/SDK/deploy commands report each generated artifact; review and commit generated files after validation.
### Workspaces and environments
```bash
bunx wrnexus workspace company-platform
cd company-platform
bunx wrnexus workspace add reports --domain=reports.localhost
bunx wrnexus gateway --port=3000
bunx wrnexus production . --prepare-only
bunx wrnexus staging .
```
Expected output lists created apps, domain mappings, selected environment/profile, build and migration decisions, and the gateway address.
### Internationalization, native targets, MCP, and support bundles
```bash
bunx wrnexus i18n extract .
bunx wrnexus i18n validate .
bunx wrnexus generate mobile
bunx wrnexus mobile compile
bunx wrnexus native list
bunx wrnexus mcp .
bunx wrnexus report . --file=app/pages/index.wrn
```
Expected output identifies extracted/validated translation keys, generated native routes, available capabilities, MCP stdio startup, or the sanitized reproduction archive. MCP uses stdio, so protocol messages—not a web URL—are its normal runtime output.
### Safe upgrades
```bash
bunx wrnexus update . --latest --dry-run
bunx wrnexus update . --latest
```
The dry run previews dependency and migration changes. A real update prints the source and target versions, backup directory, each migration action, installation result, and verification result. Commit or back up the application before upgrading.
# Canonical documentation locations
- Framework and package documentation: https://wrnexusjs.dev/
@@ -1545,289 +1967,289 @@ The dry run previews dependency and migration changes. A real update prints the
## @wrnexus/ai
- @wrnexus/ai 0.8.7
- @wrnexus/ai 0.8.8
- Documentation: https://wrnexusjs.dev/packages/ai
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/auth
- @wrnexus/auth 0.8.7
- @wrnexus/auth 0.8.8
- Documentation: https://wrnexusjs.dev/packages/auth
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/authz
- @wrnexus/authz 0.8.7
- @wrnexus/authz 0.8.8
- Documentation: https://wrnexusjs.dev/packages/authz
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/benchmark
- @wrnexus/benchmark 0.8.7
- @wrnexus/benchmark 0.8.8
- Documentation: https://wrnexusjs.dev/packages/benchmark
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/cache
- @wrnexus/cache 0.8.7
- @wrnexus/cache 0.8.8
- Documentation: https://wrnexusjs.dev/packages/cache
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/captcha
- @wrnexus/captcha 0.8.7
- @wrnexus/captcha 0.8.8
- Documentation: https://wrnexusjs.dev/packages/captcha
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/cli
- @wrnexus/cli 0.8.7
- @wrnexus/cli 0.8.8
- Documentation: https://wrnexusjs.dev/packages/cli
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/compiler
- @wrnexus/compiler 0.8.7
- @wrnexus/compiler 0.8.8
- Documentation: https://wrnexusjs.dev/packages/compiler
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/content
- @wrnexus/content 0.8.7
- @wrnexus/content 0.8.8
- Documentation: https://wrnexusjs.dev/packages/content
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/core
- @wrnexus/core 0.8.7
- @wrnexus/core 0.8.8
- Documentation: https://wrnexusjs.dev/packages/core
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/csr
- @wrnexus/csr 0.8.7
- @wrnexus/csr 0.8.8
- Documentation: https://wrnexusjs.dev/packages/csr
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/db
- @wrnexus/db 0.8.7
- @wrnexus/db 0.8.8
- Documentation: https://wrnexusjs.dev/packages/db
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/dev-server
- @wrnexus/dev-server 0.8.7
- @wrnexus/dev-server 0.8.8
- Documentation: https://wrnexusjs.dev/packages/dev-server
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/dev-toolbar
- @wrnexus/dev-toolbar 0.8.7
- @wrnexus/dev-toolbar 0.8.8
- Documentation: https://wrnexusjs.dev/packages/dev-toolbar
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/encryption
- @wrnexus/encryption 0.8.7
- @wrnexus/encryption 0.8.8
- Documentation: https://wrnexusjs.dev/packages/encryption
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/graphql
- @wrnexus/graphql 0.8.7
- @wrnexus/graphql 0.8.8
- Documentation: https://wrnexusjs.dev/packages/graphql
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/helpers
- @wrnexus/helpers 0.8.7
- @wrnexus/helpers 0.8.8
- Documentation: https://wrnexusjs.dev/packages/helpers
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/i18n
- @wrnexus/i18n 0.8.7
- @wrnexus/i18n 0.8.8
- Documentation: https://wrnexusjs.dev/packages/i18n
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/identity
- @wrnexus/identity 0.8.7
- @wrnexus/identity 0.8.8
- Documentation: https://wrnexusjs.dev/packages/identity
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/image
- @wrnexus/image 0.8.7
- @wrnexus/image 0.8.8
- Documentation: https://wrnexusjs.dev/packages/image
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/jwt
- @wrnexus/jwt 0.8.7
- @wrnexus/jwt 0.8.8
- Documentation: https://wrnexusjs.dev/packages/jwt
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/language-server
- @wrnexus/language-server 0.8.7
- @wrnexus/language-server 0.8.8
- Documentation: https://wrnexusjs.dev/packages/language-server
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/mcp
- @wrnexus/mcp 0.8.7
- @wrnexus/mcp 0.8.8
- Documentation: https://wrnexusjs.dev/packages/mcp
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/mobile
- @wrnexus/mobile 0.8.7
- @wrnexus/mobile 0.8.8
- Documentation: https://wrnexusjs.dev/packages/mobile
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/native
- @wrnexus/native 0.8.7
- @wrnexus/native 0.8.8
- Documentation: https://wrnexusjs.dev/packages/native
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/oauth
- @wrnexus/oauth 0.8.7
- @wrnexus/oauth 0.8.8
- Documentation: https://wrnexusjs.dev/packages/oauth
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/observability
- @wrnexus/observability 0.8.7
- @wrnexus/observability 0.8.8
- Documentation: https://wrnexusjs.dev/packages/observability
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/playground
- @wrnexus/playground 0.8.7
- @wrnexus/playground 0.8.8
- Documentation: https://wrnexusjs.dev/packages/playground
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/plugin
- @wrnexus/plugin 0.8.7
- @wrnexus/plugin 0.8.8
- Documentation: https://wrnexusjs.dev/packages/plugin
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/pubsub
- @wrnexus/pubsub 0.8.7
- @wrnexus/pubsub 0.8.8
- Documentation: https://wrnexusjs.dev/packages/pubsub
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/pwa
- @wrnexus/pwa 0.8.7
- @wrnexus/pwa 0.8.8
- Documentation: https://wrnexusjs.dev/packages/pwa
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/queue
- @wrnexus/queue 0.8.7
- @wrnexus/queue 0.8.8
- Documentation: https://wrnexusjs.dev/packages/queue
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/reactive
- @wrnexus/reactive 0.8.7
- @wrnexus/reactive 0.8.8
- Documentation: https://wrnexusjs.dev/packages/reactive
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/realtime
- @wrnexus/realtime 0.8.7
- @wrnexus/realtime 0.8.8
- Documentation: https://wrnexusjs.dev/packages/realtime
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/router
- @wrnexus/router 0.8.7
- @wrnexus/router 0.8.8
- Documentation: https://wrnexusjs.dev/packages/router
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/rpc
- @wrnexus/rpc 0.8.7
- @wrnexus/rpc 0.8.8
- Documentation: https://wrnexusjs.dev/packages/rpc
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/security
- @wrnexus/security 0.8.7
- @wrnexus/security 0.8.8
- Documentation: https://wrnexusjs.dev/packages/security
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/ssr
- @wrnexus/ssr 0.8.7
- @wrnexus/ssr 0.8.8
- Documentation: https://wrnexusjs.dev/packages/ssr
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/store
- @wrnexus/store 0.8.7
- @wrnexus/store 0.8.8
- Documentation: https://wrnexusjs.dev/packages/store
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/styles
- @wrnexus/styles 0.8.7
- @wrnexus/styles 0.8.8
- Documentation: https://wrnexusjs.dev/packages/styles
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/syntax
- @wrnexus/syntax 0.8.7
- @wrnexus/syntax 0.8.8
- Documentation: https://wrnexusjs.dev/packages/syntax
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/test
- @wrnexus/test 0.8.7
- @wrnexus/test 0.8.8
- Documentation: https://wrnexusjs.dev/packages/test
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/tracking
- @wrnexus/tracking 0.8.7
- @wrnexus/tracking 0.8.8
- Documentation: https://wrnexusjs.dev/packages/tracking
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/typecheck
- @wrnexus/typecheck 0.8.7
- @wrnexus/typecheck 0.8.8
- Documentation: https://wrnexusjs.dev/packages/typecheck
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/ui
- @wrnexus/ui 0.8.7
- @wrnexus/ui 0.8.8
- Documentation: https://wrnexusjs.dev/packages/ui
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/uploader
- @wrnexus/uploader 0.8.7
- @wrnexus/uploader 0.8.8
- Documentation: https://wrnexusjs.dev/packages/uploader
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
## @wrnexus/validation
- @wrnexus/validation 0.8.7
- @wrnexus/validation 0.8.8
- Documentation: https://wrnexusjs.dev/packages/validation
- README and complete exported TypeScript API: https://wrnexusjs.dev/llms-full.txt
# UI component catalog
The installed @wrnexus/ui 0.8.7 release contains 102 documented components. The contracts below include every mount name, purpose, prop type, required/default status, slot, and event. Interactive examples live only on the dedicated component showcase.
The installed @wrnexus/ui 0.8.8 release contains 102 documented components. The contracts below include every mount name, purpose, prop type, required/default status, slot, and event. Interactive examples live only on the dedicated component showcase.
### Accordion
Showcase: https://component.wrnexusjs.dev/
public/sitemap.xml
+1 -1
View File
File diff suppressed because one or more lines are too long