Skip to main content

Documentation Index

Fetch the complete documentation index at: https://colossal.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Scaffold the project

npm create colossal-project my-store
cd my-store
npm run dev
  1. Run the create command. You’ll be redirected to authenticate with Colossal.
  2. Choose an existing project or create a new one. New projects can be seeded with demo products.
  3. The starter template is cloned, dependencies are installed, and your .env is configured.
  4. Visit http://localhost:3000 to see your storefront.
FlagDescription
--skip-installSkip dependency installation after scaffolding
--skip-authSkip browser authentication (use with --store-uid)
--store-uid <uid>Use a specific project UID directly
Pass --skip-auth with --store-uid to bypass authentication in CI or automated environments:
pnpm create colossal-project my-store --skip-auth --store-uid your-uid

​
Install agent skills

Add the agent skills so your AI coding agent knows the SDK, the design library, and how to apply a reference: 
npx skills add colossalhq/agent-skills --all -a claude-code -a cursor -y

​
Generate the design

Ask your agent to build the store.

Create a beautiful store for my rap-inspired streetwear brand

CursorOpen in Cursor
The agent picks a reference from the Design Library, applies the theme into your project, and designs you a storefront using best practices and components from our design library.

​
Example

A live storefront built with this flow:

​
Next steps

Storefront SDK

Hooks for products, cart, and checkout.

Deploy

Ship to Colossal Cloud or self-host anywhere.

Create an agent

Automate orders, notifications, and reports.

Apps

Connect Stripe, Klaviyo, Slack, and more.