@slope-dev/slope 1.5.3 → 1.5.4
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.
- package/README.md +13 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,8 +7,12 @@ A framework for measuring and improving sprint execution quality. Replace subjec
|
|
|
7
7
|
## Quick Start
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
# Install
|
|
11
|
-
npm install -g @
|
|
10
|
+
# Install globally (makes `slope` available everywhere)
|
|
11
|
+
npm install -g @slope-dev/slope
|
|
12
|
+
|
|
13
|
+
# Or install locally in your project and use npx
|
|
14
|
+
npm install @slope-dev/slope
|
|
15
|
+
npx slope init
|
|
12
16
|
|
|
13
17
|
# Initialize in your project (auto-detects your AI tool)
|
|
14
18
|
slope init
|
|
@@ -28,6 +32,8 @@ slope briefing
|
|
|
28
32
|
slope report --html
|
|
29
33
|
```
|
|
30
34
|
|
|
35
|
+
> **Note:** If installed locally (without `-g`), prefix commands with `npx` — e.g., `npx slope card`.
|
|
36
|
+
|
|
31
37
|
## What is SLOPE?
|
|
32
38
|
|
|
33
39
|
SLOPE maps sprint execution to a scoring metaphor. Every sprint has a **par** (expected ticket count), every ticket is a **shot** with an approach complexity and outcome. Over time, your **handicap** reveals patterns: Do you over-engineer? Under-scope? Pick the wrong approach?
|
|
@@ -62,14 +68,11 @@ Configure in `.slope/config.json`:
|
|
|
62
68
|
|
|
63
69
|
Or per-command: `slope review --metaphor=tennis`
|
|
64
70
|
|
|
65
|
-
##
|
|
71
|
+
## Package
|
|
66
72
|
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
| [`@srbryers/store-sqlite`](packages/store-sqlite) | SQLite storage adapter — sessions, claims, events, scorecards |
|
|
71
|
-
| [`@srbryers/cli`](packages/cli) | CLI tool — 22 commands for the full sprint lifecycle |
|
|
72
|
-
| [`@srbryers/mcp-tools`](packages/mcp-tools) | Code-mode MCP server — `search` + `execute` + session/claim tools |
|
|
73
|
+
Published as a single package: [`@slope-dev/slope`](https://www.npmjs.com/package/@slope-dev/slope)
|
|
74
|
+
|
|
75
|
+
Includes the core scoring engine, SQLite store, CLI (22 commands), and MCP server.
|
|
73
76
|
|
|
74
77
|
## CLI Commands
|
|
75
78
|
|
|
@@ -216,7 +219,7 @@ import {
|
|
|
216
219
|
generateHtmlReport,
|
|
217
220
|
getMetaphor,
|
|
218
221
|
loadScorecards,
|
|
219
|
-
} from '@
|
|
222
|
+
} from '@slope-dev/slope';
|
|
220
223
|
|
|
221
224
|
// Build a scorecard
|
|
222
225
|
const card = buildScorecard({
|
package/package.json
CHANGED