|
| 1 | +# @effect-patterns/ep-cli |
| 2 | + |
| 3 | +> End-user CLI for the Effect Patterns Hub |
| 4 | +
|
| 5 | +[](../../LICENSE) |
| 6 | +[](https://www.typescriptlang.org/) |
| 7 | +[](https://effect.website/) |
| 8 | + |
| 9 | +Search, browse, and install Effect-TS patterns directly from your terminal. Built with `@effect/cli` for type-safe command parsing and Effect-native error handling. |
| 10 | + |
| 11 | +## Installation |
| 12 | + |
| 13 | +```bash |
| 14 | +# npm |
| 15 | +npm install -g @effect-patterns/ep-cli |
| 16 | + |
| 17 | +# bun |
| 18 | +bun add -g @effect-patterns/ep-cli |
| 19 | + |
| 20 | +# pnpm |
| 21 | +pnpm add -g @effect-patterns/ep-cli |
| 22 | +``` |
| 23 | + |
| 24 | +## Commands |
| 25 | + |
| 26 | +### Pattern Discovery |
| 27 | + |
| 28 | +```bash |
| 29 | +# Search patterns by keyword |
| 30 | +ep search "retry" |
| 31 | + |
| 32 | +# List all patterns with optional filters |
| 33 | +ep list --difficulty intermediate --category error-handling |
| 34 | + |
| 35 | +# Show detailed pattern information |
| 36 | +ep show retry-with-backoff |
| 37 | +``` |
| 38 | + |
| 39 | +### Install Rules |
| 40 | + |
| 41 | +Install Effect pattern rules into your AI tool configuration. |
| 42 | + |
| 43 | +```bash |
| 44 | +# Add rules for a specific AI tool |
| 45 | +ep install add --tool cursor |
| 46 | +ep install add --tool cursor --skill-level intermediate --use-case error-handling |
| 47 | + |
| 48 | +# Interactive rule selection |
| 49 | +ep install add --tool cursor -i |
| 50 | + |
| 51 | +# List supported AI tools |
| 52 | +ep install list |
| 53 | + |
| 54 | +# Show installed rules |
| 55 | +ep install list --installed |
| 56 | +``` |
| 57 | + |
| 58 | +Supported tools: `agents`, `cursor`, `vscode`, `windsurf` |
| 59 | + |
| 60 | +### Pattern Authoring |
| 61 | + |
| 62 | +```bash |
| 63 | +# Scaffold a new pattern (interactive wizard) |
| 64 | +ep pattern new |
| 65 | +``` |
| 66 | + |
| 67 | +### Skills Management |
| 68 | + |
| 69 | +Manage and validate Claude Skills built from patterns. |
| 70 | + |
| 71 | +```bash |
| 72 | +# List all available skills |
| 73 | +ep skills list |
| 74 | + |
| 75 | +# Preview a skill's content |
| 76 | +ep skills preview error-management |
| 77 | + |
| 78 | +# Validate all skills |
| 79 | +ep skills validate |
| 80 | + |
| 81 | +# Show skill statistics |
| 82 | +ep skills stats |
| 83 | +``` |
| 84 | + |
| 85 | +### Release Management |
| 86 | + |
| 87 | +```bash |
| 88 | +# Preview next release version and changelog |
| 89 | +ep release preview |
| 90 | + |
| 91 | +# Create a release (version bump, changelog, tag, push) |
| 92 | +ep release create |
| 93 | +``` |
| 94 | + |
| 95 | +### Admin / Publishing Pipeline |
| 96 | + |
| 97 | +```bash |
| 98 | +# Lint patterns for Effect-TS best practices |
| 99 | +ep admin lint |
| 100 | +ep admin lint --fix |
| 101 | + |
| 102 | +# Validate pattern files |
| 103 | +ep admin validate -v |
| 104 | + |
| 105 | +# Run example tests |
| 106 | +ep admin test |
| 107 | + |
| 108 | +# Generate documentation |
| 109 | +ep admin generate |
| 110 | + |
| 111 | +# Run the full publishing pipeline (test -> validate -> generate -> ingest) |
| 112 | +ep admin pipeline |
| 113 | +``` |
| 114 | + |
| 115 | +## Environment Variables |
| 116 | + |
| 117 | +| Variable | Description | Default | |
| 118 | +|----------|-------------|---------| |
| 119 | +| `LOG_LEVEL` | Set log level (`debug`, `info`, `warn`, `error`) | `info` | |
| 120 | +| `DEBUG` | Enable debug logging | - | |
| 121 | +| `VERBOSE` | Enable verbose logging | - | |
| 122 | + |
| 123 | +## License |
| 124 | + |
| 125 | +MIT |
0 commit comments