@commerce-kick/create
Version:
CLI tool to create projects from your commerce-kick templates
95 lines (66 loc) • 1.9 kB
Markdown
# Create Commerce Kit
A CLI tool to quickly scaffold projects from curated commerce-kick templates.
## Usage
```bash
# Using npx (recommended)
npx @commerce-kick/create my-project
# Or install globally
npm install -g @commerce-kick/create
@commerce-kick/create my-project
```
## Features
- 🚀 Multiple template options
- 📦 Automatic dependency installation
- 🔧 Git repository initialization
- 💻 Interactive CLI prompts with `@clack/prompts`
- 🎨 Beautiful and modern terminal output
## Available Templates
- **Start Kit [web]**: Tanstack Start, Vite, and Tailwind CSS
- **Commerce Kit [mobile]**: Built with love and Expo
## Command Line Options
```bash
@commerce-kick/create [project-name] [options]
Options:
-t, --template <template> Template to use (start-kit, native-kit)
-p, --package-manager <manager> Package manager to use (npm, yarn, pnpm, bun)
--no-install Skip dependency installation
--no-git Skip git initialization
-h, --help Display help for command
-V, --version Display version number
```
## Examples
```bash
# Interactive mode
npx @commerce-kick/create
# Specify project name
npx @commerce-kick/create my-awesome-project
# Use specific template
npx @commerce-kick/create my-project --template start-kit
# Specify package manager
npx @commerce-kick/create my-project --package-manager pnpm
# Skip dependency installation
npx @commerce-kick/create my-project --no-install
# Skip git initialization
npx @commerce-kick/create my-project --no-git
```
## Development
```bash
# Clone the repository
git clone git@github.com:commerce-kick/create.git
cd create
# Install dependencies
npm install
# Run in development mode
npm run dev
# Build for production
npm run build
```
## Publishing
```bash
# Build the project
npm run build
# Publish to npm
npm publish
```
## License
MIT