Skip to content

Create A Nimi App

Use @nimiplatform/app-tools when you want a developer repository for a Nimi App. The CLI creates scaffold inputs and local checks. It does not grant public admission, permissions, registry visibility, release descriptors, or installed app update truth.

Create The Scaffold

bash
pnpm dlx --package @nimiplatform/app-tools nimi-app create --dir my-nimi-app --profile standalone
cd my-nimi-app
pnpm install
pnpm run init

standalone is the external developer repository profile. It creates a candidate app repository with its own .nimi/** host truth surface and submitted manifest input. Use workspace-app only for a monorepo app slice that has an admitted workspace reason to live under apps/<app>/.

Run And Check It Locally

bash
pnpm dev:shell
pnpm run validate
pnpm run local-audit
pnpm run doctor

pnpm dev:shell launches the generated Tauri shell. The app authenticates through the in-app Runtime account login, like a shipped app. A local not-yet-admitted app must use Developer Mode and the Runtime developer registration gate. The scaffold does not create a standalone developer session or bypass Runtime account custody.

If you only need to verify SDK access to Runtime-backed text generation, read First AI Call.

If you are wiring shared UI, auth, shell, telemetry, or model configuration, read Use Kit In An App.

What The Scaffold Owns

File or commandMeaning
nimi.app.yamlDeveloper-submitted manifest input, not admitted descriptor truth
pnpm run initExplicit scaffold activation and .nimi/{config,contracts,methodology} projection
pnpm run doctorScaffold state, dependency alignment, managed glue, and projection drift check
pnpm run updateRefresh scaffold-managed glue while preserving app-owned product code
pnpm run local-auditLocal pre-submission evidence, not platform admission

Reference App

apps/tester/ is the Nimi Lab developer reference app. It shows a Runtime authenticated shell, Kit workbench surfaces, AI capability lanes, app-owned history storage, and local acceptance checks. Treat it as a reference for SDK, Kit, app-tools, and Runtime auth integration, not as platform admission truth. For a reading map, see Use Tester As A Reference App.

Source Basis

Nimi AI open world platform documentation.