plankit-cli 1.0.0 → 1.0.1

package/README.md

@@ -1,71 +1,101 @@
 # `plankit` — AI Coding Agent Workflow Command Suite
 
-> [!IMPORTANT]
-> **PlanKit CLI** is a lightweight, zero-dependency command-line tool that installs the **PlanKit Command Suite** (`plankit.plan`, `plankit.clarify`, `plankit.implement`, `plankit.review`) into any project. Works seamlessly with **Google Antigravity**, **OpenCode**, **Codex**, **Cursor**, and **Claude Code**.
+PlanKit is a lightweight, zero-dependency CLI that installs and manages a multi-phase feature workflow for AI coding assistants.
 
----
+It creates a predictable artifact structure, agent instruction files, phase specs, phase output reports, and archive records.
 
-## Quick Start (Usage without installation)
-
-Run in any project directory:
+## Quick start
 
 ```bash
 npx plankit-cli init
+npx plankit-cli plan my-feature "Add configurable templates"
 ```
 
-This single command sets up all required configuration files and folders:
-- `artifacts/current/` & `artifacts/archived/`
-- `artifacts/PLANKIT.md` (Specification)
-- `.gemini/instructions.md` (Antigravity binding)
-- `.opencode/commands/*.md` (OpenCode Markdown custom commands)
-- `.cursorrules` (Cursor rules)
-- `AGENTS.md` (Codex / Claude Code universal instructions)
+If installed globally:
 
----
+```bash
+npm install -g plankit-cli
+plankit init
+plankit plan my-feature
+```
 
-## Global Installation (Optional)
+## Commands
+
+| Command | Action |
+|---|---|
+| `plankit init` | Create PlanKit config, artifact folders, spec, and selected agent bindings. |
+| `plankit plan <feature> [requirements]` | Create `artifacts/current/<feature>/` with README, phase specs, outputs folder, and state metadata. |
+| `plankit clarify <feature> [phase]` | Create a clarification artifact for requirements and design decisions. |
+| `plankit implement <feature> <phase>` | Validate phase context and prepare `outputs/phase-N-output.md`. |
+| `plankit review <feature>` | Run verification commands, mark the README archived, and move the feature to `artifacts/archived/`. |
+| `plankit status [--json]` | List active and archived features. |
+| `plankit archive <feature>` | Move a feature to archived without running verification. |
+
+## Customization
+
+`plankit init` creates `plankit.config.json`:
+
+```json
+{
+  "artifactsDir": "artifacts",
+  "overwrite": "skip",
+  "agents": {
+    "codex": true,
+    "cursor": true,
+    "opencode": true,
+    "gemini": true
+  },
+  "defaultPhases": [
+    {
+      "title": "Foundation & Setup",
+      "slug": "foundation",
+      "objective": "Establish the base structure, constraints, and integration points.",
+      "tasks": ["Confirm scope and constraints", "Prepare base structure"]
+    }
+  ],
+  "verification": {
+    "testCommand": "npm test",
+    "buildCommand": "npm run build"
+  },
+  "templatesDir": null
+}
+```
 
-Install globally using `npm`:
+Useful options:
 
 ```bash
-npm install -g plankit-cli
+plankit init --agents codex,opencode
+plankit init --force
+plankit plan my-feature --phases 4
+plankit plan my-feature --phases "Design,Build,Test"
+plankit review my-feature --test-command "pnpm test" --build-command "pnpm build"
+plankit review my-feature --skip-build
+plankit status --json
 ```
 
-Then run anywhere:
+## Template overrides
 
-```bash
-plankit init
-plankit plan <feature-name>
-plankit status
-plankit archive <feature-name>
+Default templates live in the package `templates/` directory. To override them in a project:
+
+1. Create a directory such as `.plankit/templates`.
+2. Set `"templatesDir": ".plankit/templates"` in `plankit.config.json`.
+3. Add files matching the built-in template names, for example:
+
+```text
+.plankit/templates/
+  AGENTS.md
+  PLANKIT.md
+  feature-readme.md
+  phase-spec.md
+  opencode/
+    plankit-plan.md
 ```
 
----
+Supported placeholders use `{{name}}` syntax.
 
-## Commands Summary
+## Verification
 
-| Command | Action |
-|---|---|
-| `plankit init` | Scaffolds PlanKit configs & folders in the current directory. |
-| `plankit plan <feature>` | Scaffolds a new feature workspace under `artifacts/current/<feature>/`. |
-| `plankit status` | Lists all active and archived features. |
-| `plankit archive <feature>` | Moves a completed feature to `artifacts/archived/<feature>/`. |
-
----
-
-## Publishing to NPM
-
-To publish this package to the official NPM registry so anyone in the world can run `npx plankit init`:
-
-1. Log in to your NPM account:
-   ```bash
-   npm login
-   ```
-2. Navigate to the `packages/plankit` directory:
-   ```bash
-   cd packages/plankit
-   ```
-3. Publish to NPM:
-   ```bash
-   npm publish --access public
-   ```
+```bash
+npm test
+npm pack --dry-run
+```

package/package.json

@@ -1,12 +1,21 @@
 {
   "name": "plankit-cli",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "PlanKit Command Suite CLI for AI Coding Assistants (Antigravity, OpenCode, Codex, Cursor)",
   "main": "src/cli.js",
   "bin": {
     "plankit": "bin/plankit.js"
   },
   "type": "module",
+  "files": [
+    "bin",
+    "src",
+    "templates",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
   "scripts": {
     "start": "node bin/plankit.js",
     "test": "node --test"