Skip to main content

​
Overview

The sunpeak new command creates a new sunpeak project with a minimal, convention-based structure for building ChatGPT App UIs (MCP Resources). 
sunpeak new
Install sunpeak globally first:
pnpm add -g sunpeak

​
Usage

Create a new project: 
sunpeak new
Or specify a project name: 
sunpeak new my-app

​
What Gets Created

The framework includes:
  • Convention-based structure - MCP Resources auto-discovered from src/resources/*-resource.tsx
  • Simulations - JSON files auto-discovered from src/simulations/*-simulation.json
  • Pre-configured tooling - Vite, TypeScript, Tailwind CSS 4, Vitest
  • Development scripts - Ready-to-use dev, build, mcp, and test commands
  • Example components - Sample MCP Resource to get started quickly

​
Project Structure

my-app/
├── src/
│   ├── components/
│   ├── resources/
│   └── simulations/
├── public/
├── package.json
└── tsconfig.json

​
Next Steps

After creating your project:
  1. Install dependencies: pnpm install
  2. Start the dev server: sunpeak dev
  3. Open http://localhost:6767 to see the ChatGPT simulator

Project Scaffold

Learn more about the project structure and available commands.