Installation

Uzumaki apps run through the uzumaki CLI. Install it first, then use the CLI to scaffold, run, and package apps.

Requirements

The uzumaki CLI is the only requirement. It ships JavaScript and TypeScript built in (Uzumaki is built on Deno), so you do not need Node.js, Deno, or Bun installed to run apps. To install app dependencies like React you need any package manager — pnpm, npm, yarn, and bun all work. Examples below use pnpm.

Install the CLI

Windows

powershell irm https://uzumaki.run/install.ps1 | iex

macOS and Linux

curl -fsSL https://uzumaki.run/install.sh | sh

Verify the Install

uzumaki --version

If the command is not found, restart your terminal and make sure the installer directory was added to your PATH.

Create an App

uzumaki init my-app
cd my-app
pnpm install
pnpm dev

The dev command opens your app in a native window. There is no browser tab to open. Swap pnpm for npm, yarn, or bun if you prefer.

Common Commands

Command	Use it for
uzumaki init <name>	Scaffold a new project.
uzumaki <entry>	Run a TypeScript or bundled JavaScript entry file.
uzumaki build	Build and package the configured app.
uzumaki upgrade	Upgrade the installed CLI.

For the full list of commands and flags, see the CLI reference.

Next, build your first screen in Quick Start.