Installation

Package Overview

NitroStack consists of three separate packages:

Install CLI (Required)

Install the NitroStack CLI globally:

npm install -g @nitrostack/cli

Verify Installation

nitrostack-cli --version

Alternative: Use npx

You can also use npx without global installation:

npx @nitrostack/cli init my-project

Project Dependencies

When you create a new project, dependencies are automatically added:

Root Project (package.json)

{
  "dependencies": {
    "nitrostack": "^1",
    "zod": "^3.22.4",
    "dotenv": "^16.3.1"
  },
  "devDependencies": {
    "@nitrostack/cli": "^1",
    "@types/node": "^22.10.0",
    "typescript": "^5.3.3"
  }
}

Widgets Project (src/widgets/package.json)

{
  "dependencies": {
    "@nitrostack/widgets": "^1",
    "next": "^14",
    "react": "^18",
    "react-dom": "^18"
  }
}

System Requirements

• Node.js: 18.x or 20.x (LTS recommended)
• npm: 8.x or newer
• OS: Windows, macOS, or Linux

Install in Existing Projects

Installing Root Dependencies

# Install all dependencies in root and widgets
nitrostack-cli install

This runs npm install in both the root directory and src/widgets.

Manual Installation

# Root dependencies
npm install nitrostack zod dotenv
npm install -D @nitrostack/cli @types/node typescript

# Widget dependencies (if using widgets)
cd src/widgets
npm install @nitrostack/widgets next react react-dom

Upgrading Packages

Upgrade NitroStack packages to the latest version:

nitrostack-cli upgrade

This updates nitrostack in both root and widgets directories.

See Upgrade Command for more options.

NitroStudio Setup

NitroStudio is now a standalone application:

1. Download NitroStudio from nitrostack.ai/studio
2. Start your project: npm run dev
3. Connect Studio to your project directory

Studio connects to your MCP server and widget server automatically.

Next Steps

• Quick Start Guide
• Init Command
• Dev Command