Create Reactor App

🧩 Create Reactor App is a CLI tool that helps you quickly bootstrap a new application using the Reactor SDK. Get started with interactive AI applications in seconds!

Quick Start

npx create-reactor-app my-app

Or with pnpm:

pnpm dlx create-reactor-app my-app

Usage

Interactive Mode

Simply run the command without arguments to be prompted for project details:

npx create-reactor-app

You'll be asked to:

1. Enter your project name
2. Select a template from available options

Command Line Arguments

You can also provide arguments directly:

npx create-reactor-app [project-name] [template] [options]

Options:

| Option | Description | | --------------- | ------------------------------------------ | | --token, -t | GitHub token for private repository access | | --help, -h | Show help message |

Examples:

# Create a project with longlive template
npx create-reactor-app my-game longlive

# Create a project with matrix template
npx create-reactor-app my-matrix-app matrix-2

# Create a project with a GitHub token (for private repos)
npx create-reactor-app my-app longlive --token ghp_xxxxxxxxxxxx

Private Repository Access

If the repository is private, you'll be prompted to enter a GitHub token when:

• Fetching available templates fails
• Cloning the repository fails

You can also pass the token directly via the --token (or -t) argument to skip the prompt.

Available Templates

The CLI automatically fetches the latest templates from the repository.

Getting Started After Creation

After creating your project:

cd your-project-name
pnpm dev

Open http://localhost:3000 in your browser to see your application running. Make sure to setup your API keys first!

Examples Repository

All templates are sourced from the official examples in the Reactor SDK repository. You can browse the examples directory to see the full source code and understand how each template works.

Documentation

For comprehensive guides, API references, and tutorials, visit the official Reactor documentation:

📚 Reactor Documentation

Requirements

• Node.js 16 or later
• pnpm (recommended) or npm

Local Development

To test or develop the CLI locally:

# Navigate to the create-app package
cd packages/create-app

# Install dependencies
pnpm install

# Build the CLI
pnpm build

# Link it globally
pnpm link --global

Now you can use create-reactor-app anywhere on your system:

create-reactor-app my-app

To unlink when you're done:

pnpm unlink --global

License

ISC License - Copyright (c) Reactor Technologies, Inc.

Support

• 📖 Documentation
• 💻 Examples Repository
• 🐛 Report Issues

Happy building with Reactor! 🚀