Skip to content

itechmeat/start-vibe-project

Repository files navigation

Social preview

start-vibe-project

start-vibe-project is a CLI that bootstraps a new project with an AI-first documentation structure for spec-driven development. It creates a ready-to-fill .project workspace (about, specs, architecture, context, stories) so teams can align on requirements before writing code.

During setup you choose a template and stack, and the tool prepares agent directories and installs the required skills for your AI tool. The result is a clean, consistent starting point for OpenSpec-driven workflows.

instruction-with-sound.mp4

⚠️ INSTALL FIRST!

Quick Start

Using bun (recommended)

bunx start-vibe-project@latest

Using npm/npx

npx start-vibe-project

Features

  • Interactive setup: Guided CLI prompts to configure your project
  • AI-first documentation: Pre-structured .project/ folder for AI agents
  • Multiple templates: Web app, mobile app, API service, library, or empty project
  • Tech stack selection: Choose frontend and backend frameworks
  • Multi-agent support: Works with GitHub Copilot, Claude Code, Cursor, and more
  • Automatic skill installation: Installs essential skills for your AI tool

What Gets Created

my-project/
├── .project/
│   ├── INIT.md           # Project setup checklist for the creator agent
│   ├── about.md          # Project overview (pre-filled with your description)
│   ├── specs.md          # Technical specifications (with your stack choices)
│   ├── architecture.md   # System architecture (to be defined by agent)
│   ├── project-context.md # Living context document
│   └── stories/
│       └── stories.md    # User stories (to be defined)
├── .github/skills/       # Skills for your AI tool (or .claude/, .cursor/, etc.)
├── .github/agents/
│   └── creator.md        # Project Creator agent
├── .github/instructions/relief-pilot.instructions.md # Relief Pilot instructions (GitHub Copilot only, if enabled)
├── .github/copilot-instructions.md # Copilot instructions (if Relief Pilot is enabled)
├── .editorconfig         # Editor configuration
├── AGENTS.md             # Agent instructions
└── .gitignore

Workflow

  1. Run the CLI: bunx start-vibe-project@latest (or npx start-vibe-project@latest)
  2. Answer prompts: Name, template, description, components, stack, AI tool
  3. Open in your AI tool: VS Code with Copilot, Claude Code, Cursor, etc.
  4. Select creator agent: The agent will continue project documentation
  5. Follow agent instructions: Complete about.md, specs.md, architecture.md, stories

Supported AI Tools (29)

  • Claude Code
  • Codex
  • GitHub Copilot
  • Cursor
  • OpenCode
  • ... and more supported

Installed Skills

The following skills are automatically installed:

Templates

Template Description
Web Application Full-stack or frontend web application
Mobile Application iOS, Android, or cross-platform mobile app
API Service Backend REST or GraphQL API service

Install first

  • OpenSpec (auto-installed) — a spec-driven layer for AI development; installed automatically by CLI, or manual install: npm install -g @fission-ai/openspec@latest
  • Relief Pilot (conditional) — install only if you selected Relief Pilot during setup; configure it per the extension page instructions.
  • SimpleMem (recommended) — long-term memory for working with AI across sessions; recommended to use it via MCP.

Development

Local testing (without publishing to npm)

Link the package globally:

bun link

Now you can run it from anywhere:

start-vibe-project my-test-project

Or run directly from source:

bun run dev

Unlink after testing

bun unlink start-vibe-project

Build

bun run build

License

MIT

About

Initialize a new project with AI-first documentation structure

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors