runboard 0.1.0
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/AGENTS.md +54 -0
- package/LICENSE +21 -0
- package/README.md +59 -0
- package/dist/chunk-U4SVYBXI.js +904 -0
- package/dist/cli.js +102 -0
- package/dist/mcp.js +137 -0
- package/examples/.runboard/assessments/2026-01-15.md +17 -0
- package/examples/.runboard/assessments/2026-03-15.md +15 -0
- package/examples/.runboard/assessments/2026-05-15.md +15 -0
- package/examples/.runboard/config.yaml +2 -0
- package/examples/.runboard/rubric.yaml +95 -0
- package/package.json +50 -0
- package/rubric/rubric.yaml +95 -0
- package/skills/assess/SKILL.md +56 -0
- package/skills/board-update/SKILL.md +34 -0
- package/skills/pulse/SKILL.md +31 -0
- package/skills/roadmap/SKILL.md +33 -0
- package/templates/baseline.eta +10 -0
- package/templates/board-update.eta +22 -0
- package/templates/monthly.eta +8 -0
- package/templates/pulse.eta +21 -0
- package/templates/roadmap.eta +20 -0
package/AGENTS.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# Runboard for AI agents
|
|
2
|
+
|
|
3
|
+
This file tells any AI agent (Claude, Cursor, Codex, Copilot, Gemini, ChatGPT, …) how to
|
|
4
|
+
drive the `runboard` CLI on a user's behalf.
|
|
5
|
+
|
|
6
|
+
## The one rule
|
|
7
|
+
|
|
8
|
+
**The CLI computes; you converse.** Runboard's credibility depends on a deterministic
|
|
9
|
+
core: all scores, averages, deltas, auto-triggers, and constraints are computed by the
|
|
10
|
+
CLI. Your job is elicitation and interpretation — never calculate or invent a number.
|
|
11
|
+
|
|
12
|
+
## What Runboard is
|
|
13
|
+
|
|
14
|
+
A local-first maturity instrument scored on nine dimensions — Build / Run / Plan × Team /
|
|
15
|
+
Tools / Techniques — each 1–5 with a trajectory (`up`/`flat`/`down`/`volatile`). Data
|
|
16
|
+
lives in `.runboard/` in the user's repo. Nothing leaves the machine.
|
|
17
|
+
|
|
18
|
+
## Commands you can run
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
runboard init # scaffold .runboard/ (idempotent)
|
|
22
|
+
runboard assess --set <dim>=<level>:<traj>:"<evidence>" ... # record (all 9 dims)
|
|
23
|
+
runboard board [--html] # heatmap + average + binding constraint
|
|
24
|
+
runboard pulse # compare the two latest assessments
|
|
25
|
+
runboard roadmap # Now/Next/Later from the binding constraint
|
|
26
|
+
runboard report --type board-update|baseline|monthly
|
|
27
|
+
runboard status # one-screen current state
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Dimension keys: `build.team`, `build.tools`, `build.techniques`, `run.team`, `run.tools`,
|
|
31
|
+
`run.techniques`, `plan.team`, `plan.tools`, `plan.techniques`.
|
|
32
|
+
|
|
33
|
+
## Typical flows
|
|
34
|
+
|
|
35
|
+
- **Assess**: read anchors from `.runboard/rubric.yaml`, ask the leader per dimension,
|
|
36
|
+
then persist with a single `runboard assess --set ... ` call. See `skills/assess/`.
|
|
37
|
+
- **Pulse / Roadmap / Board update**: run the matching command, read the generated file
|
|
38
|
+
under `.runboard/`, and read it back in business language. See the other `skills/`.
|
|
39
|
+
|
|
40
|
+
## MCP
|
|
41
|
+
|
|
42
|
+
For tool-calling clients, run `npx runboard-mcp` to expose the same capabilities as tools
|
|
43
|
+
(`runboard_assess`, `runboard_board`, `runboard_pulse`, `runboard_roadmap`,
|
|
44
|
+
`runboard_report`, `runboard_status`). These are thin wrappers over the same core, so
|
|
45
|
+
their results match the CLI exactly.
|
|
46
|
+
|
|
47
|
+
## Portable skills
|
|
48
|
+
|
|
49
|
+
`skills/*/SKILL.md` are written to the open SKILL.md standard and run unmodified across
|
|
50
|
+
agent platforms. They own the conversation; the CLI owns the computation.
|
|
51
|
+
|
|
52
|
+
> Note: in published installs, `CLAUDE.md` is provided as a copy/symlink of this file so
|
|
53
|
+
> Claude Code reads the same guidance. In this source repo, `CLAUDE.md` is the
|
|
54
|
+
> contributor/Spec-Kit guide instead — this AGENTS.md is the end-user agent guide.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Runboard contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# Runboard
|
|
2
|
+
|
|
3
|
+
**See your technical-leadership maturity scorecard in five minutes — local-first, no signup, nothing leaves your machine.**
|
|
4
|
+
|
|
5
|
+
Runboard is a CLI that runs the Runboard framework: a nine-dimension maturity instrument
|
|
6
|
+
(Build / Run / Plan × Team / Tools / Techniques), scored 1–5 with trajectory indicators.
|
|
7
|
+
It renders your scorecard as a heatmap, tells you your single biggest constraint, and
|
|
8
|
+
tracks whether things are getting better over time.
|
|
9
|
+
|
|
10
|
+
## Quickstart
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npx runboard@latest init # scaffold .runboard/ in your repo
|
|
14
|
+
npx runboard@latest assess # guided 9-dimension self-assessment
|
|
15
|
+
npx runboard@latest board # your heatmap + average + biggest constraint
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Then, once you have data:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npx runboard@latest roadmap # Now / Next / Later plan from your constraint
|
|
22
|
+
npx runboard@latest board --html # a shareable, self-contained board.html
|
|
23
|
+
npx runboard@latest pulse # (after a 2nd assessment) what moved since last time
|
|
24
|
+
npx runboard@latest status # one-screen current state
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Local-first, no phone-home
|
|
28
|
+
|
|
29
|
+
Every command runs entirely on your machine. **No account, no network calls, no
|
|
30
|
+
telemetry.** Your data lives in `.runboard/` in your own repo — commit it, and its git
|
|
31
|
+
history becomes your trajectory record.
|
|
32
|
+
|
|
33
|
+
## Commands
|
|
34
|
+
|
|
35
|
+
| Command | What it does |
|
|
36
|
+
|---------|--------------|
|
|
37
|
+
| `runboard init` | Scaffold `.runboard/` (config, rubric, assessments). Idempotent. |
|
|
38
|
+
| `runboard assess` | Record a 9-dimension assessment (interactive, or `--set` for agents). |
|
|
39
|
+
| `runboard board [--html]` | Render the heatmap; `--html` writes a shareable file. |
|
|
40
|
+
| `runboard pulse` | Compare the two latest assessments; flag stuck dimensions. |
|
|
41
|
+
| `runboard roadmap` | Now/Next/Later plan from your binding constraint. |
|
|
42
|
+
| `runboard report --type <t>` | Render a board-ready report from a template. |
|
|
43
|
+
| `runboard status` | One-screen current state. |
|
|
44
|
+
|
|
45
|
+
## Use it from your AI assistant
|
|
46
|
+
|
|
47
|
+
Portable `skills/` (SKILL.md) and an MCP server (`npx runboard-mcp`) let Claude, Cursor,
|
|
48
|
+
Codex, Copilot, Gemini, and other agents run the assessment conversation and persist
|
|
49
|
+
results through the same core — the numbers are always computed by the tool, never by the
|
|
50
|
+
model.
|
|
51
|
+
|
|
52
|
+
## Contributing
|
|
53
|
+
|
|
54
|
+
See [CONTRIBUTING.md](./CONTRIBUTING.md). This is a public project; work starts from
|
|
55
|
+
GitHub issues.
|
|
56
|
+
|
|
57
|
+
## License
|
|
58
|
+
|
|
59
|
+
[MIT](./LICENSE)
|