@rpamis/comet 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +150 -15
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,8 +1,19 @@
1
1
  # @rpamis/comet
2
2
 
3
- OpenSpec + Superpowers dual-star development workflow for Claude Code.
3
+ ```
4
+ ██████╗ ██████╗ ███╗ ███╗███████╗████████╗
5
+ ██╔════╝██╔═══██╗████╗ ████║██╔════╝╚══██╔══╝
6
+ ██║ ██║ ██║██╔████╔██║█████╗ ██║
7
+ ██║ ██║ ██║██║╚██╔╝██║██╔══╝ ██║
8
+ ╚██████╗╚██████╔╝██║ ╚═╝ ██║███████╗ ██║
9
+ ╚═════╝ ╚═════╝ ╚═╝ ╚═╝╚══════╝ ╚═╝
10
+ ```
11
+
12
+ **OpenSpec + Superpowers dual-star development workflow** — one command from idea to archive.
4
13
 
5
- ## Installation
14
+ OpenSpec handles **WHAT** (outlines, proposals, spec lifecycle, archiving). Superpowers handles **HOW** (technical design, planning, execution, wrap-up). Comet chains both into a five-phase automated pipeline.
15
+
16
+ ## Install
6
17
 
7
18
  ```bash
8
19
  npm install -g @rpamis/comet
@@ -16,10 +27,13 @@ comet init
16
27
  ```
17
28
 
18
29
  `comet init` will:
19
- 1. Install Comet skills to `.claude/skills/`
20
- 2. Set up OpenSpec (if not already installed)
21
- 3. Set up Superpowers (if not already installed)
22
- 4. Create `docs/superpowers/` working directories
30
+
31
+ 1. Prompt you to select AI platforms (auto-detects existing configs)
32
+ 2. Choose install scope: project-level (current directory) or global (home directory)
33
+ 3. Install [OpenSpec](https://github.com/Fission-AI/OpenSpec) skills
34
+ 4. Install [Superpowers](https://github.com/obra/superpowers) skills
35
+ 5. Deploy Comet skills to selected platforms
36
+ 6. Create `docs/superpowers/specs/` and `docs/superpowers/plans/` working directories
23
37
 
24
38
  ## Commands
25
39
 
@@ -29,20 +43,141 @@ comet init
29
43
  | `comet --help` | Show help |
30
44
  | `comet --version` | Show version |
31
45
 
46
+ ### init Options
47
+
48
+ | Option | Description |
49
+ |--------|-------------|
50
+ | `--yes` | Non-interactive mode, auto-select detected platforms |
51
+ | `--skip-existing` | Skip already installed components |
52
+ | `--overwrite` | Overwrite already installed components |
53
+
54
+ ## Supported Platforms
55
+
56
+ `comet init` supports 28 AI coding platforms:
57
+
58
+ | Platform | Skills Dir | Platform | Skills Dir |
59
+ |----------|-----------|----------|-----------|
60
+ | Claude Code | `.claude/` | Cursor | `.cursor/` |
61
+ | Codex | `.codex/` | OpenCode | `.opencode/` |
62
+ | Windsurf | `.windsurf/` | Cline | `.cline/` |
63
+ | RooCode | `.roo/` | Continue | `.continue/` |
64
+ | GitHub Copilot | `.github/` | Gemini CLI | `.gemini/` |
65
+ | Amazon Q Developer | `.amazonq/` | Qwen Code | `.qwen/` |
66
+ | Kilo Code | `.kilocode/` | Auggie | `.augment/` |
67
+ | Kiro | `.kiro/` | Lingma | `.lingma/` |
68
+ | Junie | `.junie/` | CodeBuddy | `.codebuddy/` |
69
+ | CoStrict | `.cospec/` | Crush | `.crush/` |
70
+ | Factory Droid | `.factory/` | iFlow | `.iflow/` |
71
+ | Pi | `.pi/` | Qoder | `.qoder/` |
72
+ | Antigravity | `.agent/` | Bob Shell | `.bob/` |
73
+ | ForgeCode | `.forge/` | Trae | `.trae/` |
74
+
32
75
  ## Skills
33
76
 
34
- After `comet init`, these skills are available in Claude Code:
77
+ After `comet init`, three groups of skills are installed to the selected platform's `skills/` directory:
78
+
79
+ ### Comet Skills
35
80
 
36
81
  | Skill | Description |
37
82
  |-------|-------------|
38
- | `/comet` | Main entry — auto-detects phase and dispatches |
39
- | `/comet-open` | Phase 1: Open change |
40
- | `/comet-design` | Phase 2: Deep design |
41
- | `/comet-build` | Phase 3: Plan and build |
42
- | `/comet-verify` | Phase 4: Verify and finish |
43
- | `/comet-archive` | Phase 5: Archive |
44
- | `/comet-hotfix` | Preset: Bug fix (skip brainstorming) |
45
- | `/comet-tweak` | Preset: Small change (skip brainstorming and plan) |
83
+ | `/comet` | Main entry — auto-detects phase and dispatches to sub-commands |
84
+ | `/comet-open` | Phase 1: Open a change (proposal, design, task breakdown) |
85
+ | `/comet-design` | Phase 2: Deep design (brainstorming, Design Doc) |
86
+ | `/comet-build` | Phase 3: Plan and build (implementation plan, code commits) |
87
+ | `/comet-verify` | Phase 4: Verify and finish (testing, verification report) |
88
+ | `/comet-archive` | Phase 5: Archive (delta spec sync, status annotation) |
89
+ | `/comet-hotfix` | Preset: Quick bug fix (skips brainstorming) |
90
+ | `/comet-tweak` | Preset: Small change (skips brainstorming and full plan) |
91
+
92
+ ### OpenSpec Skills
93
+
94
+ Spec lifecycle management: propose, explore, sync, verify, archive, and more.
95
+
96
+ ### Superpowers Skills
97
+
98
+ Development methodology: brainstorming, TDD, subagent-driven development, code review, plan writing, and more.
99
+
100
+ ## Workflow
101
+
102
+ ```
103
+ /comet
104
+ ↓ auto-detect
105
+ /comet-open ──→ /comet-design ──→ /comet-build ──→ /comet-verify ──→ /comet-archive
106
+ (OpenSpec) (Superpowers) (Superpowers) (Both) (OpenSpec)
107
+
108
+ /comet-hotfix (preset path, skips brainstorming)
109
+ open ──→ build ──→ verify ──→ archive
110
+
111
+ /comet-tweak (preset path, skips brainstorming and full plan)
112
+ open ──→ lightweight build ──→ light verify ──→ archive
113
+ ```
114
+
115
+ ### Five Phases
116
+
117
+ | Phase | Command | Owner | Artifacts |
118
+ |-------|---------|-------|-----------|
119
+ | 1. Open | `/comet-open` | OpenSpec | proposal.md, design.md, tasks.md |
120
+ | 2. Deep Design | `/comet-design` | Superpowers | Design Doc, delta spec |
121
+ | 3. Plan & Build | `/comet-build` | Superpowers | Implementation plan, code commits |
122
+ | 4. Verify & Finish | `/comet-verify` | Both | Verification report, branch handling |
123
+ | 5. Archive | `/comet-archive` | OpenSpec | delta→main spec sync, archive |
124
+
125
+ ### Core Principles
126
+
127
+ - **Brainstorming is non-skippable** — every change must go through deep design (except hotfix/tweak)
128
+ - **Delta specs are living documents** — freely editable during Phase 3, synced at archive
129
+ - **Keep tasks.md in sync** — check off each task as completed
130
+ - **Commit frequently** — one commit per task, message reflects design intent
131
+ - **Verify before archive** — `/comet-verify` must pass before `/comet-archive`
132
+
133
+ ## Project Structure
134
+
135
+ ```
136
+ your-project/
137
+ ├── .claude/skills/ # Platform skills dir (Comet + OpenSpec + Superpowers)
138
+ │ ├── comet/SKILL.md
139
+ │ ├── comet-*/SKILL.md
140
+ │ ├── openspec-*/SKILL.md
141
+ │ └── brainstorming/SKILL.md
142
+ ├── openspec/ # OpenSpec — WHAT
143
+ │ ├── config.yaml
144
+ │ └── changes/
145
+ │ └── <name>/
146
+ │ ├── .openspec.yaml
147
+ │ ├── proposal.md
148
+ │ ├── design.md
149
+ │ ├── specs/<capability>/spec.md
150
+ │ └── tasks.md
151
+ └── docs/superpowers/ # Superpowers — HOW
152
+ ├── specs/ # Design documents
153
+ └── plans/ # Implementation plans
154
+ ```
155
+
156
+ ## Development
157
+
158
+ ```bash
159
+ # Clone
160
+ git clone https://github.com/benym/comet.git
161
+ cd comet
162
+
163
+ # Install dependencies
164
+ pnpm install
165
+
166
+ # Dev mode (watch)
167
+ pnpm dev
168
+
169
+ # Build
170
+ pnpm build
171
+
172
+ # Test
173
+ pnpm test
174
+ ```
175
+
176
+ ## Security
177
+
178
+ - Pre-publish scan for API keys, secrets, tokens, and private keys
179
+ - `.npmignore` prevents source code and config files from entering the npm package
180
+ - `.gitignore` covers secrets, credentials, IDE configs, and more
46
181
 
47
182
  ## License
48
183
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rpamis/comet",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "description": "OpenSpec + Superpowers dual-star development workflow",
5
5
  "keywords": [
6
6
  "comet",
@@ -32,7 +32,7 @@
32
32
  "test": "vitest run",
33
33
  "test:watch": "vitest",
34
34
  "prepare": "pnpm run build",
35
- "prepublishOnly": "pnpm run build",
35
+ "prepublishOnly": "node scripts/prepublish-check.js && pnpm run build",
36
36
  "postinstall": "node scripts/postinstall.js"
37
37
  },
38
38
  "engines": {