create-shipkit-app
v0.4.2
Published
Create a ShipKit app from Bones and keep it in sync with upstream
Maintainers
Readme
create-shipkit-app
Scaffold and manage ShipKit sites from the command line.
Quick start
npm create shipkit-app@latest my-new-siteOr install globally:
npm install -g create-shipkit-app
shipkit create my-new-siteCommands
| Command | What it does |
|---------|--------------|
| shipkit create [name] | Create a new project from Bones, the public root template (or --template lacymorrow/shipkit for the everything-included build). Creates a GitHub repo (via gh), clones it, sets the upstream remote to the template, grafts upstream history so future syncs merge cleanly, and installs with the template's package manager. |
| shipkit add <items...> | Add ShipKit registry items (npx shadcn add @shipkit/<item>), for example shipkit add payments email. Adds --overwrite automatically for items that replace a Bones stub (payments, storage, payload). shipkit create my-app --add payments,email does it right after install. |
| shipkit sync | Pull upstream template changes into your project. Opens a PR branch by default; use --direct to merge into the current branch. |
| shipkit deploy | Deploy your ShipKit site to Vercel. |
All commands support -y / --yes for non-interactive use (CI, agents):
npx create-shipkit-app my-new-site --yes
shipkit sync --yes --directcreate options
-t, --template <owner/repo>: template repo to scaffold from (defaults to ShipKit Premium, falls back to shipkit-io/bones)-d, --directory <dir>: target directory--no-install: skip dependency installation
Requirements
- Node.js 18+
git(required)ghCLI (optional, enables GitHub repo creation)
Development
bun install
bun run build # tsup -> dist/index.js
bun run typecheck
node dist/index.js create --helpThis CLI previously lived in the lacymorrow/shipkit repo under cli/. It was extracted so the ShipKit template ships lighter.
License
MIT
