create-octane-xplat

Get a TypeScript app running, then build its first useful flow with your coding agent.

Xplat's target direction spans web, iOS, Android, macOS, Windows, and Linux. This starter configures web, iOS, and Android. macOS, Windows, and Linux are separate experiments — an AppKit host, a WinUI 3 scaffold with runtime verification pending, and a WebKitGTK webview host. See target support. The framework is 0.x and its API surface is still changing.

With Node.js and pnpm 11.24.0 installed:

pnpm create octane-xplat my-app

The creator asks which platforms to target — web, iOS, and Android are all pre-selected. Pass --targets to skip the prompt:

pnpm create octane-xplat my-app --targets web          # web only
pnpm create octane-xplat my-app --targets web,android  # web + Android

Platforms skipped here can be enabled later with pnpm xplat add <platform> inside the app. (Non-interactive runs without --targets scaffold all three.)

The creator copies the template, installs dependencies with pnpm, and starts the web dev server when the web target is included. Open the printed URL and open my-app in your agent. Ask it to read AGENTS.md and .agents/skills/xplat/SKILL.md, then build a packing checklist with add, pack, and remove actions using in-memory state. Check the result before asking for the next feature: add “Passport” and “Charger,” pack Passport, and confirm that one item remains. Reloading should clear the list in this in-memory version. The first-flow guide includes the full prompt and failure checks.

The generated app pins pnpm 11.24.0. Its pnpm-workspace.yaml loads @octane-xplat/patches as a configDependencies package, making the framework patches available during the first install.

Leave the server running while you edit. After stopping it, restart from the app directory:

cd my-app
pnpm dev            # web

From that directory, these commands run other targets or check the app — the dev:*/build:* entries exist only for platforms chosen at create time (pnpm xplat add adds the rest later):

pnpm dev:ios        # needs macOS, Xcode, and NativeScript setup
pnpm dev:android    # needs Android SDK, compatible JDK, and NativeScript setup
pnpm lint
pnpm typecheck      # every enabled tsconfig
pnpm build          # web production bundle

Get a working app and iterate provides prerequisites, live-update boundaries, and version guidance. The starter's Xplat skill is included; NativeScript's official skills are optional and installed separately. Ask your agent to report checks and targets actually run. llms.txt indexes the docs.