Skip to main content

Create Command

burger-api create <project-name> scaffolds a new Burger API project with interactive prompts.

  • Creates directory structure, config, and installs dependencies.
  • New projects get burger.build.ts at the root with the build-time scan settings (for example apiDir, apiPrefix, wsDir, debug). Build-time only: runtime options go in new Burger({...}), src/plugins.ts, and route config.ts.
  • TypeScript projects also get src/types.ts, a commented module-augmentation example for app-wide type extensions.
  • Always writes AGENTS.md (commands, layout, and framework rules for AI agents) (Claude Code and other agents read it), even with --no-skills.
  • Prompts: API routes, API directory, API prefix, debug mode, Page routes, Page directory, Page prefix, WebSocket routes, WebSocket directory, AI agent skills.
  • --local scaffolds link:burger-api and link:@burger-api/cli from your checkout instead of npm. See Local mode.

Example:

burger-api create my-api

Next steps: Edit burger.build.ts if needed, run bun run dev, add hooks and plugins with burger-api add. When skills are opted in they are installed to both .agents/skills/burger-api/ and .claude/skills/burger-api/. See CLI Tool.