Skip to content

Commit c1fc23f

Browse files
PaulJPhilpclaude
andcommitted
feat: publish ep-cli to npm and update install docs
Publish @effect-patterns/ep-cli@0.3.1 to npm (with toolkit@0.4.2 and ep-shared-services@1.0.1 as dependencies). Add npm install option to docs, fix package name in ABOUT.md, add missing @effect/cluster peer deps to prevent runtime errors. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 72bc931 commit c1fc23f

4 files changed

Lines changed: 26 additions & 27 deletions

File tree

docs/getting-started/ABOUT.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ ep show retry-based-on-specific-errors
4747
ep install add --tool cursor --skill-level intermediate
4848

4949
# List all patterns
50-
ep list --skill-level advanced
50+
ep list --difficulty advanced
5151
```
5252

5353
### Effect Patterns Toolkit
@@ -117,37 +117,27 @@ bun test
117117

118118
### Using the CLI
119119

120-
#### Option 1: Install CLI Package Globally (Recommended)
120+
#### Install CLI Globally (Recommended)
121121

122-
The CLI is published as a standalone npm package:
122+
The `ep` CLI is published on npm as `@effect-patterns/ep-cli`:
123123

124124
```bash
125-
# Install globally with bun
126-
bun install -g @effect-patterns/cli
125+
# Install globally with bun (recommended)
126+
bun add -g @effect-patterns/ep-cli
127127

128128
# Or with npm
129-
npm install -g @effect-patterns/cli
129+
npm install -g @effect-patterns/ep-cli
130130

131131
# Verify installation
132132
ep --version
133133

134134
# Use anywhere
135135
ep search "error handling"
136-
ep list --skill-level intermediate
136+
ep list --difficulty intermediate
137137
ep show handle-errors-with-catch
138138
ep install add --tool cursor
139139
```
140140

141-
#### Option 2: Run from Project Directory
142-
143-
If you prefer to run from the development repository:
144-
145-
```bash
146-
# From the project root
147-
bun run ep --version
148-
bun run ep search "error handling"
149-
```
150-
151141
## Usage
152142

153143
### Search Patterns

packages/ep-cli/QUICK_START.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
## Install
44

55
```bash
6+
# Install globally with bun (recommended)
67
bun add -g @effect-patterns/ep-cli
8+
9+
# Or with npm
10+
npm install -g @effect-patterns/ep-cli
711
```
812

913
## First Commands

packages/ep-cli/README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,14 @@ Maintainer workflows are intentionally out of scope and live in `ep-admin`.
2424

2525
## Installation
2626

27-
Requires Bun (package declares `bun >= 1.0.0`).
27+
Published on npm as `@effect-patterns/ep-cli`:
2828

2929
```bash
30+
# Install globally with bun (recommended)
3031
bun add -g @effect-patterns/ep-cli
32+
33+
# Or with npm
34+
npm install -g @effect-patterns/ep-cli
3135
```
3236

3337
Verify:
@@ -123,7 +127,7 @@ If stdin is empty, command fails with:
123127
| `PATTERN_API_KEY` | API key sent as `x-api-key` to pattern API | unset |
124128
| `EP_API_KEY_FILE` | File containing API key text | unset |
125129
| `EP_CONFIG_FILE` | Path to JSON config (expects `{"apiKey":"..."}`) | `${XDG_CONFIG_HOME:-~/.config}/ep-cli/config.json` |
126-
| `EFFECT_PATTERNS_API_URL` | Base URL for pattern API | `https://effect-patterns-mcp.vercel.app` |
130+
| `EFFECT_PATTERNS_API_URL` | Base URL for pattern API | `https://effect-patterns-mcp-server-buddybuilder.vercel.app` |
127131
| `EP_API_TIMEOUT_MS` | Request timeout in ms | `10000` |
128132
| `EP_INSTALLED_STATE_FILE` | Installed-rules state file path override | `${XDG_STATE_HOME:-~/.local/state}/ep-cli/installed-rules.json` |
129133
| `EP_SKILLS_DIR` | Explicit skills directory override | auto-discovered from cwd upward |
@@ -281,7 +285,7 @@ Supported tool values:
281285

282286
Target files:
283287

284-
- `agents` -> `AGENTS.md`
288+
- `agents` -> rule content is written to `docs/Effect-Patterns-Rules.md`; `AGENTS.md` (in cwd) is updated with a managed block that points to that file.
285289
- `cursor` -> `.cursor/rules.md`
286290
- `vscode` -> `.vscode/rules.md`
287291
- `windsurf` -> `.windsurf/rules.md`
@@ -300,10 +304,7 @@ Notes:
300304
- `--interactive` opens multi-select prompt.
301305
- `--skill-level` maps to pattern difficulty filter.
302306
- `--use-case` filters results client-side by use case tag.
303-
- For `agents`, managed block markers are used:
304-
- `<!-- EP_RULES_START -->`
305-
- `<!-- EP_RULES_END -->`
306-
- Existing managed block in `AGENTS.md` is replaced in place.
307+
- For `agents`, rule content is written to `docs/Effect-Patterns-Rules.md`; `AGENTS.md` is then updated with a managed block (`<!-- EP_RULES_START -->` / `<!-- EP_RULES_END -->`) that references that file. An existing managed block in `AGENTS.md` is replaced in place.
307308
- State is recorded in installed-rules state JSON file.
308309

309310
Unsupported tool behavior:
@@ -560,7 +561,8 @@ Defaults:
560561

561562
`agents` tool install target:
562563

563-
- `AGENTS.md` in current working directory
564+
- Rule content: `docs/Effect-Patterns-Rules.md`
565+
- `AGENTS.md` in current working directory is updated with a managed block that points to `docs/Effect-Patterns-Rules.md`
564566

565567
Other install targets:
566568

@@ -624,7 +626,7 @@ Expected when non-TTY or when `NO_COLOR`, `CI`, or `TERM=dumb` is set.
624626
This document tracks behavior for:
625627

626628
- CLI name: `ep`
627-
- Version: `0.3.0`
629+
- Version: `0.3.1`
628630

629631
When command surface or behavior changes, update this file first, then derivative docs.
630632

packages/ep-cli/package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@effect-patterns/ep-cli",
3-
"version": "0.3.0",
3+
"version": "0.3.1",
44
"description": "End-user CLI for Effect Patterns Hub",
55
"private": false,
66
"type": "module",
@@ -22,7 +22,10 @@
2222
"@effect-patterns/toolkit": "workspace:*",
2323
"@effect/cli": "0.73.2",
2424
"@effect/platform": "0.94.5",
25+
"@effect/cluster": "0.56.1",
2526
"@effect/platform-node": "0.104.1",
27+
"@effect/rpc": "0.73.0",
28+
"@effect/sql": "0.49.0",
2629
"effect": "3.19.19",
2730
"effect-cli-tui": "^2.2.0",
2831
"effect-env": "^0.4.1"

0 commit comments

Comments
 (0)