Skip to content

Commit 94dccf8

Browse files
PaulJPhilpclaude
andcommitted
docs: fix ep-cli user-facing documentation
- Fix wrong flag --skill-level → --difficulty for ep list in ABOUT.md - Fix non-existent --tool claude → --tool vscode in ABOUT.md - Fix non-existent --dry-run and install list-tools commands in ABOUT.md - Add CHANGELOG entries for v0.3.1 and v0.3.2 - Update RELEASE_CHECKLIST with manual publish steps (CI workflow removed) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 9edf6bd commit 94dccf8

3 files changed

Lines changed: 54 additions & 22 deletions

File tree

docs/getting-started/ABOUT.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -146,8 +146,8 @@ ep install add --tool cursor
146146
# Search by keyword
147147
ep search "error handling"
148148

149-
# Filter by skill level
150-
ep list --skill-level intermediate
149+
# Filter by difficulty
150+
ep list --difficulty intermediate
151151

152152
# Show pattern details
153153
ep show handle-errors-with-catch
@@ -159,14 +159,14 @@ ep show handle-errors-with-catch
159159
# Install rules for Cursor
160160
ep install add --tool cursor
161161

162-
# Install intermediate-level rules
163-
ep install add --tool claude --skill-level intermediate
162+
# Install intermediate-level rules for VS Code
163+
ep install add --tool vscode --skill-level intermediate
164164

165-
# Preview without installing
166-
ep install add --tool windsurf --dry-run
165+
# Interactive rule selection for Windsurf
166+
ep install add --tool windsurf -i
167167

168168
# List supported tools
169-
ep install list-tools
169+
ep install list
170170
```
171171

172172
### Create New Patterns

packages/ep-cli/CHANGELOG.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,30 @@ All notable changes to `@effect-patterns/ep-cli` will be documented in this file
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [0.3.2] - 2026-02-26
9+
10+
### Fixed
11+
- Resolve Effect version mismatch warnings by bumping `@effect/cluster` to 0.56.4 and `@effect/rpc` to 0.73.2
12+
- Fix default API URL to point to correct Vercel deployment
13+
14+
## [0.3.1] - 2026-02-26
15+
16+
### Added
17+
- Published `@effect-patterns/ep-cli` to npm for global installation (`bun add -g @effect-patterns/ep-cli`)
18+
- Added `@effect/cluster`, `@effect/rpc`, and `@effect/sql` as dependencies to satisfy `@effect/platform-node` peer requirements
19+
20+
### Fixed
21+
- Fix missing peer dependencies that caused `Cannot find module '@effect/cluster/RunnerStorage'` at runtime
22+
823
## [0.3.0] - 2026-02-10
924

1025
### Added
11-
- **First public npm release**
1226
- **Pattern Discovery**: `search`, `list`, `show` commands for browsing 700+ Effect-TS patterns
1327
- **Rule Installation**: `install add/list` for installing Effect pattern rules into AI tools (Cursor, VS Code, Windsurf, Agents)
1428
- **Skills Management**: `skills list/preview/validate/stats` for Claude Skills
1529

16-
### Security
17-
- Strict API key validation for MCP transport
18-
- OAuth/PKCE hardening for authentication flows
19-
2030
### Dependencies
21-
- effect ^3.19.14
22-
- @effect/cli ^0.73.0
23-
- @effect/platform ^0.94.1
31+
- effect 3.19.19
32+
- @effect/cli 0.73.2
33+
- @effect/platform 0.94.5
34+
- @effect/platform-node 0.104.1

packages/ep-cli/RELEASE_CHECKLIST.md

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,41 @@
2323

2424
## Publish
2525

26-
1. Go to GitHub Actions → "Publish to npm" → Run workflow
27-
2. First run with `dry-run: true` to verify
28-
3. Then run with `dry-run: false` to publish
26+
Publish order: toolkit → ep-shared-services → ep-cli
2927

30-
Publish order (handled by workflow): toolkit → ep-shared-services → ep-cli
28+
1. Build all packages:
29+
```bash
30+
bun run build
31+
```
32+
2. Publish dependencies first (skip if versions haven't changed):
33+
```bash
34+
cd packages/toolkit && npm publish --access public
35+
cd ../ep-shared-services && npm publish --access public
36+
```
37+
3. Temporarily pin workspace deps in `packages/ep-cli/package.json`:
38+
```diff
39+
- "@effect-patterns/ep-shared-services": "workspace:*",
40+
- "@effect-patterns/toolkit": "workspace:*",
41+
+ "@effect-patterns/ep-shared-services": "<version>",
42+
+ "@effect-patterns/toolkit": "<version>",
43+
```
44+
4. Publish ep-cli:
45+
```bash
46+
cd packages/ep-cli && npm publish --access public
47+
```
48+
5. Revert workspace deps back to `workspace:*`
3149

3250
## Post-Publish Verification
3351

3452
- [ ] Verify package is on npm:
3553
```bash
3654
npm view @effect-patterns/ep-cli
3755
```
38-
- [ ] Install and test:
56+
- [ ] Install globally and test:
3957
```bash
40-
bunx @effect-patterns/ep-cli --version
41-
bunx @effect-patterns/ep-cli search "error handling"
58+
bun add -g @effect-patterns/ep-cli
59+
ep --version
60+
ep list
61+
ep search "retry"
4262
```
63+
- [ ] Update CHANGELOG.md with new version entry

0 commit comments

Comments
 (0)