ship-create 1.0.0 → 1.1.0

package/README.md

@@ -1,39 +1,61 @@
-# SHIP CLI
+# ship-create
 
-A zero-dependency, zero-API-key project scaffolder for The SHIP Method OS. Built for non-developers — there's nothing to `npm install` and nothing to sign up for before your first command works.
+A zero-dependency, zero-API-key project scaffolder for The SHIP Method OS. Published on npm as [`ship-create`](https://www.npmjs.com/package/ship-create) — no git clone, no API key, nothing to sign up for before your first command works.
 
 ## Run It
 
-From the repo root:
+From anywhere — an empty folder, your desktop, wherever you want the new project to land:
 
 ```
-node ship-cli/create.mjs
+npx ship-create
 ```
 
-That's it. No `npm install` needed for the CLI itself (it only uses Node.js built-ins). You do need [Node.js](https://nodejs.org) installed (18 or newer) — if `node -v` works in your terminal, you're ready.
+That's it. No global install needed. You do need [Node.js](https://nodejs.org) installed (18 or newer) — if `node -v` works in your terminal, you're ready.
+
+> Prefer a permanent global command? `npm install -g ship-create`, then just run `ship-create`.
 
 ## What It Asks
 
 1. **Project name** — e.g. "Acme CRM"
-2. **What you're building** — pick from the 8 product types in [`../06-TEMPLATES/`](../06-TEMPLATES)
+2. **What you're building** — one of 8 product types (SaaS, CRM, membership, lead-gen, directory, dashboard, internal tool, marketplace)
 3. **Which AI tool you mainly use** — ChatGPT, Claude, Gemini, Cursor, or Windsurf
 
 ## What It Creates
 
-A new folder at `projects/<your-project-slug>/` containing:
+A new folder at `./<your-project-slug>/`, in whatever directory you ran the command from, containing:
 
-- The full [`starter-kit/`](../starter-kit) app shell (sale page, member area, backoffice — working Next.js code on mock data)
+- The full starter-kit app shell (sale page, member area, backoffice — working Next.js + Tailwind code on mock data)
 - `AGENTS.md`, `CLAUDE.md`, `.cursorrules`, `.windsurfrules` — copied in, so Cursor/Windsurf/Claude Code enforce the SHIP order automatically the moment you open the folder
 - `docs/PROJECT.md` — pre-filled with your project name and product type
 - `docs/<TYPE>_TEMPLATE.md` — the starter pack matching what you're building
 - `docs/HUMAN_FLOW.md` — blank template, ready for Stage 2
+- `docs/PROMPTS.md` — the full Idea → Code prompt chain
 - `docs/FIRST_PROMPT.txt` — a ready-to-paste prompt for whichever AI tool you picked, with `PROJECT.md` already loaded into it
 - `NEXT_STEPS.md` — plain-language instructions for what to do next, tailored to your AI tool choice
 
+Everything it needs is bundled inside this package's own `templates/` folder — nothing is read from the SHIP Method OS repo at runtime, so it works standalone via `npx` for anyone, without access to that (private) repo.
+
 ## Why No API Key
 
 If you already pay for ChatGPT Plus, Claude Pro, or Gemini Advanced, requiring a *separate* API key (different billing, different signup, different rate limits) to use this CLI would be pure friction. Instead, the CLI prepares the exact prompt you need and tells you where to paste it — into the tool you already have open in a browser tab.
 
 ## Re-running
 
-The CLI refuses to overwrite an existing `projects/<slug>/` folder — pick a different project name, or delete the old folder first if you want to start over.
+The CLI refuses to overwrite an existing `./<slug>/` folder in your current directory — pick a different project name, or delete the old folder first if you want to start over.
+
+## Maintaining This Package
+
+This folder lives inside the private `the-ship-method-os` repo but publishes as a separate public package. If the source templates change (`starter-kit/`, `01-STRUCTURE/PROJECT.md`, `02-HUMAN-FLOW/HUMAN_FLOW.md`, `03-INSTRUCTION/PROMPTS.md`, `06-TEMPLATES/*.md`, or the root agent rule files), re-sync them into `templates/` and bump the version before publishing:
+
+```
+# from the repo root
+cp -R starter-kit ship-cli/templates/starter-kit
+rm -rf ship-cli/templates/starter-kit/{node_modules,.next,package-lock.json,next-env.d.ts,tsconfig.tsbuildinfo}
+cp 01-STRUCTURE/PROJECT.md 02-HUMAN-FLOW/HUMAN_FLOW.md 03-INSTRUCTION/PROMPTS.md ship-cli/templates/docs/
+cp 06-TEMPLATES/*.md ship-cli/templates/docs/product-types/
+cp AGENTS.md CLAUDE.md .cursorrules .windsurfrules ship-cli/templates/
+
+cd ship-cli
+npm version patch   # or minor/major
+npm publish --access public
+```

package/create.mjs

@@ -186,6 +186,14 @@ async function main() {
     }
   }
 
+  // 2b. Copy the Claude Code skill (.claude/skills/ship-method/SKILL.md) so
+  // Claude Code can explicitly invoke the SHIP workflow as a skill, not
+  // just follow it as a passive rules file.
+  const claudeSkillSrc = path.join(TEMPLATES_DIR, ".claude");
+  if (fs.existsSync(claudeSkillSrc)) {
+    copyRecursiveExcluding(claudeSkillSrc, path.join(outDir, ".claude"), new Set());
+  }
+
   // 3. Create a docs/ folder with a pre-filled PROJECT.md and the matching product-type template.
   const docsDir = path.join(outDir, "docs");
   fs.mkdirSync(docsDir, { recursive: true });
@@ -281,6 +289,11 @@ This folder includes AGENTS.md / CLAUDE.md / .cursorrules / .windsurfrules.
 If you open this folder in Cursor, Windsurf, or Claude Code, those tools
 will automatically enforce filling Structure and Human Flow before
 generating feature code — you don't need to do anything extra.
+
+If you use Claude Code specifically, there's also a \`.claude/skills/ship-method/SKILL.md\`
+— Claude can invoke it directly as a skill (not just a passive rule file)
+whenever you ask it to build a feature or review whether something is
+ready to ship.
 `;
 
   fs.writeFileSync(path.join(outDir, "NEXT_STEPS.md"), nextSteps);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ship-create",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Scaffold a new project the SHIP Method way — Structure, Human Flow, Instruction, Publish. No git clone, no API key, just one command.",
   "type": "module",
   "license": "MIT",

package/templates/.claude/skills/ship-method/SKILL.md

@@ -0,0 +1,52 @@
+---
+name: ship-method
+description: Use when starting any new product, feature, or "build me an app" request — before writing any application code. Walks through Structure, Human Flow, Instruction, Publish in order, using this repo's templates. Also use when asked to review whether a project is "ready to build" or "ready to ship."
+---
+
+# The SHIP Method
+
+You are operating inside a project built with **The SHIP Method OS**. The method has four phases, run strictly in order:
+
+```
+S — STRUCTURE   →   H — HUMAN FLOW   →   I — INSTRUCTION   →   P — PUBLISH
+(what & why)         (the experience)     (AI-ready specs)      (ship it)
+```
+
+The single most common reason AI-built products end up broken, scope-creeped, or unshippable: someone skips Structure and Human Flow and goes straight to "build me an app." This skill exists to stop that.
+
+## When to Use This Skill
+
+- The user describes a new product/feature idea and wants something built
+- The user asks you to generate code for a feature that doesn't have a filled spec yet
+- The user asks "is this ready to build?" or "is this ready to ship?"
+- You're about to scaffold, design a schema, or write business logic and no `PROJECT.md` / `HUMAN_FLOW.md` exists yet for it
+
+## The Checklist
+
+Work through these gates in order. Do not let scope, urgency, or the user saying "just build it fast" skip a gate without at least naming what's being skipped.
+
+- [ ] **Gate 1 — Structure exists.** Find or create `PROJECT.md` (template: `01-STRUCTURE/PROJECT.md` in this repo, or `docs/PROJECT.md` if this is a `ship-create`-generated project). Vision, Problem Statement, Target Audience, and MVP Scope must be filled — not placeholder brackets.
+- [ ] **Gate 2 — Human Flow exists.** Find or create `HUMAN_FLOW.md`. Every core screen needs a happy path and at least one error/empty state defined before it gets built.
+- [ ] **Gate 3 — Instruction exists.** Functional requirements, data model, and API contract are written somewhere concrete (`AI_BUILD_SPEC.md` / `docs/PROJECT.md`'s feature section) before you generate feature code.
+- [ ] **Gate 4 — Publish readiness.** Before telling the user something is "done," check it against the relevant checklist (`QA_CHECKLIST.md`, `LAUNCH_CHECKLIST.md`) rather than declaring success from a clean build alone.
+
+## How to Apply This
+
+1. **If Gate 1 or 2 is missing or full of `[bracket placeholders]`:** stop, don't generate feature code. Instead, ask the user one specific question at a time to fill the gap — pull questions directly from the relevant template's section headers. Scaffolding, config, and boilerplate are fine to write anytime; business logic and feature code are gated.
+2. **If the user insists on skipping a gate** ("just build it, skip the docs"): comply, but say once, briefly, what's being skipped and the most likely thing that breaks later as a result. Don't refuse repeatedly or lecture.
+3. **If all gates are filled:** proceed normally — generate code straight from the spec, and flag if a code request contradicts what's already written in `PROJECT.md` or `HUMAN_FLOW.md` rather than silently overriding it.
+4. **When asked "is this ready to build/ship?":** walk the checklist above explicitly and report which gates pass/fail, rather than giving a vague yes/no.
+
+## Reference Files (when present in this repo)
+
+| Need | File |
+|---|---|
+| Business goals, scope, MVP | `01-STRUCTURE/PROJECT.md`, `01-STRUCTURE/MVP_SCOPE.md` |
+| User journeys, screens | `02-HUMAN-FLOW/HUMAN_FLOW.md`, `02-HUMAN-FLOW/SCREEN_PLANNING.md` |
+| Specs, prompt chain | `03-INSTRUCTION/AI_BUILD_SPEC.md`, `03-INSTRUCTION/PROMPTS.md` |
+| Pre-launch checks | `04-PUBLISH/QA_CHECKLIST.md`, `04-PUBLISH/LAUNCH_CHECKLIST.md` |
+| Product-type starter pack | `06-TEMPLATES/<TYPE>_TEMPLATE.md` |
+| Design consistency | `12-DESIGN-SYSTEM/DESIGN_SYSTEM.md` |
+| Stack decisions | `13-TECH-STACK/STACK_DECISION_MATRIX.md` |
+
+If this is a project generated by `ship-create`, the same files exist under `docs/` instead of the numbered folders above.