Skip to main content

​
Overview

The sunpeak new command creates a new sunpeak project with a minimal, convention-based structure for building MCP Apps. 
sunpeak new
Install sunpeak globally first:
pnpm add -g sunpeak

​
Usage

Create a new project interactively: 
sunpeak new
Or specify a project name: 
sunpeak new my-app
Or specify both project name and resources to include: 
sunpeak new my-app review,carousel

​
Arguments

ArgumentDescription
projectNameName of the project directory (optional, prompts if not provided)
resourcesComma or space-separated list of resources to include (optional, prompts if not provided)

​
What Gets Created

The framework includes:
  • Convention-based structure - MCP Resources auto-discovered from src/resources/{name}/
  • Simulations in tests/ - Simulation JSON files live in tests/simulations/{name}/
  • Pre-configured tooling - Vite, TypeScript, Tailwind CSS 4, Vitest
  • Development scripts - Ready-to-use dev, build, mcp, and test commands
  • Example components - Sample MCP Resources to get started quickly

​
Project Structure

my-app/
├── src/resources/
│   └── review/
│       └── review-resource.tsx
├── tests/simulations/
│   └── review/
│       └── review-{scenario}-simulation.json
└── package.json

​
Next Steps

After creating your project:
  1. Navigate to your project: cd my-app
  2. Start the dev server: sunpeak dev
  3. Open http://localhost:3000 to see the simulator

Project Scaffold

Learn more about the project structure and available commands.