Skip to main content

Install the CLI

Install @shellui/cli so you can create a project, run the development server, and build a production shell. Node.js 18.0.0 or higher is required. npm ships with Node.js.

Install globally​

Use a global install when you want shellui on your PATH from any directory:

npm install -g @shellui/cli

Then run commands directly:

shellui start
shellui start --host
shellui dev --app
shellui build
shellui build --app
npx shellui build --app --bundles app,dmg

dev is an alias for start. --host listens on 0.0.0.0. --app starts or builds the desktop wrapper.

Install this release​

These docs describe Shellui 0.6.0 on the npm latest tag. The commands above install that release. Pin it when you want 0.6.0 and not a later version:

npm install -g @shellui/cli@0.6.0
npm install --save-dev @shellui/cli@0.6.0
npm install @shellui/sdk@0.6.0
npm install @shellui/core@0.6.0

See the changelog for what changed in 0.6.0. Account management, magic link login, and email settings are in this release. On-device AI stays off unless ai.enabled is true.

Install in a project​

Add the CLI as a dev dependency when the version should stay with the repo:

npm install --save-dev @shellui/cli

Call it with npx:

npx shellui start
npx shellui build

Or add scripts to package.json:

{
  "scripts": {
    "dev": "shellui dev",
    "build": "shellui build",
    "dev:app": "shellui dev --app",
    "build:app": "shellui build --app",
    "build:app:dmg": "shellui build --app --bundles app,dmg"
  }
}

Confirm the install​

Print the installed version:

shellui --version

If the command is missing, use npx shellui --version from a project that lists @shellui/cli, or reinstall globally.

The CLI pulls in @shellui/core for the React shell. Install these yourself only when you import them from application code:

  • @shellui/core - config types, useAuth, and the runtime the CLI serves
  • @shellui/sdk - iframe APIs (init, toasts, overlays, storage)

Next: create a project.