@firatcand/roster 0.1.0 → 1.0.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/README.md +77 -215
- package/agents/lesson-drafter.md +3 -8
- package/agents/pattern-detector.md +0 -1
- package/bin/roster.js +7233 -1197
- package/data/plan-ceilings.yaml +57 -0
- package/package.json +8 -3
- package/skills/chief-of-staff/SKILL.md +199 -59
- package/skills/dreamer/SKILL.md +8 -7
- package/skills/roster-orchestrator/SKILL.md +53 -25
- package/templates/CLAUDE.project.template.md +1 -1
- package/templates/CONTEXT.template.md +2 -2
- package/templates/gitignore-defaults.txt +2 -0
- package/templates/hooks/banner.sh +47 -0
- package/templates/scaffold/chief-of-staff/README.md +16 -24
- package/templates/scaffold/chief-of-staff/agent.md +22 -32
- package/templates/scaffold/chief-of-staff/plans/audit-agent.yaml +4 -4
- package/templates/scaffold/chief-of-staff/plans/audit-repo.yaml +5 -4
- package/templates/scaffold/chief-of-staff/plans/create-agent.yaml +5 -34
- package/templates/scaffold/config/project.yaml.template +10 -0
- package/templates/scaffold/conventions.md +188 -173
- package/templates/scaffold/dreamer/README.md +2 -2
- package/templates/scaffold/dreamer/agent.md +0 -1
- package/templates/scaffold/dreamer/plans/nightly-reflection.yaml +23 -37
- package/templates/scaffold/dreamer/subagents/lesson-drafter.md +2 -7
- package/templates/scaffold/{projects/_demo/guidelines → guidelines}/asset-links.md +4 -0
- package/templates/scaffold/{projects/_demo/guidelines → guidelines}/brand-book.md +4 -0
- package/templates/scaffold/{projects/_demo/guidelines → guidelines}/messaging.md +4 -0
- package/templates/scaffold/{projects/_demo/guidelines → guidelines}/voice.md +4 -0
- package/templates/scaffold/logs/cron/.gitkeep +1 -0
- package/templates/scaffold/ops/EXPERT.md +5 -5
- package/templates/scaffold/scripts/audit-agent.sh +326 -0
- package/templates/scaffold/scripts/audit-repo.sh +218 -0
- package/templates/scaffold/scripts/create-function.sh +267 -0
- package/templates/scaffold/scripts/lib/README.md +6 -1
- package/templates/scaffold/scripts/lib/bindings-prompt.sh +53 -0
- package/templates/scaffold/scripts/lib/functions.sh +17 -5
- package/templates/scaffold/scripts/new-agent.sh +416 -0
- package/templates/scaffold/scripts/rename-agent.sh +91 -0
- package/templates/scaffold/scripts/save-state.sh +32 -0
- package/agents/critic.md +0 -74
- package/agents/enricher.md +0 -56
- package/agents/promotion-arbiter.md +0 -71
- package/agents/prospector.md +0 -51
- package/agents/writer.md +0 -58
- package/skills/sdr/SKILL.md +0 -147
- package/templates/scaffold/chief-of-staff/plans/add-agent-to-project.yaml +0 -45
- package/templates/scaffold/chief-of-staff/plans/archive-project.yaml +0 -51
- package/templates/scaffold/chief-of-staff/plans/audit-project.yaml +0 -34
- package/templates/scaffold/chief-of-staff/plans/create-project.yaml +0 -65
- package/templates/scaffold/chief-of-staff/plans/remove-agent-from-project.yaml +0 -50
- package/templates/scaffold/chief-of-staff/plans/rename-project.yaml +0 -62
- package/templates/scaffold/chief-of-staff/plans/unarchive-project.yaml +0 -41
- package/templates/scaffold/dreamer/subagents/promotion-arbiter.md +0 -64
- package/templates/scaffold/gtm/sdr/.claude/settings.json +0 -3
- package/templates/scaffold/gtm/sdr/.mcp.json +0 -21
- package/templates/scaffold/gtm/sdr/README.md +0 -46
- package/templates/scaffold/gtm/sdr/agent.md +0 -136
- package/templates/scaffold/gtm/sdr/plans/cold-outreach.yaml +0 -92
- package/templates/scaffold/gtm/sdr/projects/_demo/asset-references.md +0 -7
- package/templates/scaffold/gtm/sdr/projects/_demo/config/default.yaml +0 -69
- package/templates/scaffold/gtm/sdr/projects/_demo/log/feedback/.gitkeep +0 -0
- package/templates/scaffold/gtm/sdr/projects/_demo/log/runs/.gitkeep +0 -0
- package/templates/scaffold/gtm/sdr/projects/_demo/playbook/.gitkeep +0 -0
- package/templates/scaffold/gtm/sdr/subagents/critic.md +0 -67
- package/templates/scaffold/gtm/sdr/subagents/enricher.md +0 -49
- package/templates/scaffold/gtm/sdr/subagents/prospector.md +0 -44
- package/templates/scaffold/gtm/sdr/subagents/writer.md +0 -51
- package/templates/scaffold/projects/_demo/CLAUDE.md +0 -35
- package/templates/scaffold/projects/_demo/README.md +0 -16
- package/templates/scaffold/projects/_demo/assets/.gitkeep +0 -0
- package/templates/scaffold/projects/_demo/config/default.yaml +0 -28
- package/templates/scaffold/projects/_demo/state.md +0 -11
- package/templates/scaffold/scripts/new-project.sh +0 -125
- /package/templates/scaffold/gtm/{sdr/playbook/.gitkeep → .gitkeep} +0 -0
- /package/templates/scaffold/{projects/_demo/guidelines → guidelines}/icps/_persona-template.md +0 -0
package/README.md
CHANGED
|
@@ -2,271 +2,133 @@
|
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
[](LICENSE)
|
|
5
|
+
[](https://www.npmjs.com/package/@firatcand/roster)
|
|
5
6
|
|
|
6
7
|
# Roster
|
|
7
8
|
|
|
8
|
-
> A
|
|
9
|
+
> **A lightweight operator agent framework.** A CLI that scaffolds role-based agents — GTM, product, design, ops — into your existing AI coding tool, and runs them on schedules with human approval before anything ships.
|
|
9
10
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
11
|
+
```
|
|
12
|
+
● 7am Monday. Three agents have already run while you slept.
|
|
13
|
+
│
|
|
14
|
+
● gtm/sdr last night's signups triaged · 5 personalized intros queued
|
|
15
|
+
● product/pm 3 competitor changelogs summarized · LinkedIn post drafted
|
|
16
|
+
● design/critic yesterday's PR screenshots audited · 2 contrast issues flagged
|
|
17
|
+
│
|
|
18
|
+
✓ All parked in your approval queue. You approve, edit, or reject over coffee.
|
|
19
|
+
```
|
|
18
20
|
|
|
19
|
-
|
|
21
|
+
| Pillar | What it means |
|
|
22
|
+
|---|---|
|
|
23
|
+
| **Lightweight** | One npm install. No servers, no databases, no SaaS layer. Tiny tarball, no proprietary DSL — your workspace is just markdown and YAML you own and can hand-edit. |
|
|
24
|
+
| **Subscription-safe** | Runs on the flat-rate [Claude Code](https://claude.com/code) or [Codex CLI](https://github.com/openai/codex) subscription you already pay for. No per-token API bills, no third-party agent platform. |
|
|
25
|
+
| **Operator-first** | Built by someone running a real business. GTM, product, design, and ops are first-class roles — not a chatbot wrapped in marketing copy. |
|
|
26
|
+
| **Schedule-native** | Agents run on cron-like schedules through your host tool's native scheduler. Daily morning runs, weekly competitor sweeps, PR-triggered design QA. |
|
|
27
|
+
| **HITL by default** | Risky outputs (emails, PR comments, social posts) land in `pending/` queues. Nothing ships until you say so. |
|
|
20
28
|
|
|
21
|
-
|
|
29
|
+
---
|
|
22
30
|
|
|
23
|
-
|
|
31
|
+
## Quick Install
|
|
24
32
|
|
|
25
33
|
```bash
|
|
26
|
-
# 1. Install skills + agents into your AI tool's config dir
|
|
27
34
|
npx @firatcand/roster install
|
|
28
|
-
|
|
29
|
-
# 2. Scaffold a workspace in a fresh directory
|
|
30
|
-
mkdir my-team && cd my-team
|
|
31
|
-
npx @firatcand/roster init
|
|
32
|
-
|
|
33
|
-
# 3. Open Claude Code in that directory
|
|
34
|
-
claude
|
|
35
|
-
|
|
36
|
-
# 4. Run the demo SDR plan
|
|
37
|
-
/sdr run cold-outreach for _demo
|
|
38
|
-
|
|
39
|
-
# 5. Read the run log and provide feedback — lessons surface
|
|
40
|
-
# in dreamer/pending/ on the next nightly reinforcement pass.
|
|
41
35
|
```
|
|
42
36
|
|
|
43
|
-
|
|
37
|
+
Detects Claude Code, Codex CLI, and Gemini, then copies skills + agents into each tool's config dir. macOS, Linux, and Windows.
|
|
44
38
|
|
|
45
|
-
|
|
39
|
+
## Setup prompt
|
|
46
40
|
|
|
47
|
-
|
|
41
|
+
Want the agent to do the install for you? Paste this into Claude Code, Codex, or Cursor:
|
|
48
42
|
|
|
49
43
|
```
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
roster v0.1.0
|
|
53
|
-
Multi-agent workspace scaffolder for Claude Code, Codex CLI, and Gemini.
|
|
54
|
-
|
|
55
|
-
✓ Claude Code — 3 skills → ~/.claude/skills, 7 agents → ~/.claude/agents
|
|
56
|
-
✓ Codex CLI — 4 skills → ~/.codex/skills, 7 agents → ~/.codex/agents
|
|
57
|
-
✓ Gemini CLI — 3 skills → ~/.gemini/extensions, 7 agents → ~/.gemini/agents
|
|
58
|
-
|
|
59
|
-
Next: roster init to scaffold a workspace.
|
|
44
|
+
Set up https://github.com/firatcand/roster for me. Read install.md and follow
|
|
45
|
+
the steps to install roster and scaffold a workspace in this directory.
|
|
60
46
|
```
|
|
61
47
|
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
## Subcommands
|
|
65
|
-
|
|
66
|
-
| Command | What it does |
|
|
67
|
-
|---|---|
|
|
68
|
-
| `roster install` | Detect installed AI tools, prompt for selection, copy skills + agents into each tool's config dir. Idempotent. |
|
|
69
|
-
| `roster install --all` | Install to every detected tool, non-interactive (good for CI / scripted migration). |
|
|
70
|
-
| `roster install --tool <name>` | Install to a single named tool (`claude`, `codex`, or `gemini`), non-interactive. |
|
|
71
|
-
| `roster init [name]` | Scaffold the agent-team workspace into CWD. Substitutes `{{PROJECT_NAME}}`. |
|
|
72
|
-
| `roster doctor` | Audit installed skills/agents per AI tool; exits non-zero on drift. Includes a Scheduling section that runs `schedule validate` against the current workspace. |
|
|
73
|
-
| `roster schedule validate` | Validate every `roster/<function>/schedules.yaml` file in the workspace. `--json` / `--silent` / `--cwd <dir>`. Exits non-zero on schema or cron errors. |
|
|
74
|
-
| `roster --help` / `--version` | Usage + version from `package.json`. |
|
|
75
|
-
|
|
76
|
-
## Tool support
|
|
48
|
+
The agent reads [install.md](install.md), runs the install, scaffolds your workspace, verifies with `roster doctor`, and tells you the next command.
|
|
77
49
|
|
|
78
|
-
|
|
79
|
-
|---|---|---|---|
|
|
80
|
-
| Claude Code | Supported | `~/.claude/skills/<skill>/` (directory per skill) | `~/.claude/agents/<agent>.md` |
|
|
81
|
-
| Codex CLI | Supported | `~/.codex/skills/<skill>/` (directory per skill) | `~/.codex/agents/<agent>.md` |
|
|
82
|
-
| Gemini CLI | Supported | `~/.gemini/extensions/<skill>/` (directory per skill) | `~/.gemini/agents/<agent>.md` |
|
|
83
|
-
| Cursor | **Out of scope** — see [docs/roadmap.md](docs/roadmap.md) | — | — |
|
|
50
|
+
---
|
|
84
51
|
|
|
85
|
-
|
|
52
|
+
## Getting Started
|
|
86
53
|
|
|
87
|
-
|
|
54
|
+
```bash
|
|
55
|
+
mkdir my-team && cd my-team
|
|
56
|
+
npx @firatcand/roster init my-team # scaffold workspace (config/, guidelines/, function dirs)
|
|
57
|
+
$EDITOR config/project.yaml # fill workspace identity (stage, audience, motion)
|
|
58
|
+
$EDITOR guidelines/voice.md # plus messaging.md, brand-book.md, icps/<persona>.md
|
|
59
|
+
cp templates/env.example .env # then chmod 600 .env and fill secrets
|
|
60
|
+
claude # or `codex`, or open Cursor
|
|
61
|
+
/chief-of-staff create-agent gtm sdr
|
|
62
|
+
```
|
|
88
63
|
|
|
89
|
-
`
|
|
64
|
+
The guided dialogue reads your `config/project.yaml` + `guidelines/` and interviews you for the gaps a stub can't fill — subagents, tools, plan names, failure modes — then writes a populated `agent.md`. Worked example in [docs/HOWTO.md](docs/HOWTO.md).
|
|
90
65
|
|
|
91
|
-
|
|
66
|
+
### Common commands
|
|
92
67
|
|
|
93
|
-
|
|
|
68
|
+
| Command | What it does |
|
|
94
69
|
|---|---|
|
|
95
|
-
| `
|
|
96
|
-
| `
|
|
97
|
-
| `
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
|
102
|
-
|---|---|---|
|
|
103
|
-
| `critic` | `sdr` | Reviews drafts for tone, brand fit, risk, compliance. Returns pass/fail with specific feedback. Does not rewrite. |
|
|
104
|
-
| `enricher` | `sdr` | Fills missing fields on prospects (recent posts, company news) via Apollo, HeyReach, web search. Does not score or contact. |
|
|
105
|
-
| `prospector` | `sdr` | Finds prospects matching ICP criteria. Read-only — no enrichment beyond search, no contact, no CRM writes. |
|
|
106
|
-
| `writer` | `sdr` | Drafts a single first-touch message for a single prospect using enrichment context and lessons. Does not send. |
|
|
107
|
-
| `lesson-drafter` | `dreamer` | Takes a candidate pattern and drafts a lesson file in the schema defined by `conventions.md`. One lesson per invocation. |
|
|
108
|
-
| `pattern-detector` | `dreamer` | Reads runs + matched feedback, returns raw candidate patterns with cited evidence. Returns everything that recurs. |
|
|
109
|
-
| `promotion-arbiter` | `dreamer` | Decides whether a project-validated lesson should be promoted to global, kept project-specific, or marked as conflicting. Decisions only. |
|
|
70
|
+
| `roster install` | Install skills + agents into detected AI tools (idempotent) |
|
|
71
|
+
| `roster init` | Scaffold an agent-team workspace in CWD |
|
|
72
|
+
| `roster doctor` | Audit installation; exits non-zero on drift |
|
|
73
|
+
| `roster schedule validate` | Validate every `roster/<function>/schedules.yaml` |
|
|
74
|
+
| `roster schedule install` | Install a schedule into your host tool's native scheduler |
|
|
75
|
+
| `roster review [function]` | Walk pending HITL items interactively (approve / reject / defer) |
|
|
76
|
+
| `roster hooks install` | Wire SessionStart banners so chat sessions surface pending counts |
|
|
110
77
|
|
|
111
|
-
|
|
78
|
+
Full subcommand reference in [docs/HOWTO.md](docs/HOWTO.md). Scheduling rules, UI hand-off, and platform matrix in [docs/SCHEDULING.md](docs/SCHEDULING.md).
|
|
112
79
|
|
|
113
|
-
|
|
80
|
+
---
|
|
114
81
|
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
```
|
|
118
|
-
my-team/ ← full layout
|
|
119
|
-
├── CLAUDE.md, conventions.md ← workspace-level context
|
|
120
|
-
├── gtm/, product/, design/, ops/ ← functions (top-level domains)
|
|
121
|
-
│ ├── EXPERT.md ← function-level expert (substrate-shaping)
|
|
122
|
-
│ └── <agent-role>/ ← role-based agents (sdr, ux-designer, ...)
|
|
123
|
-
│ ├── agent.md ← contract: purpose, inputs, plans, outputs
|
|
124
|
-
│ ├── plans/*.yaml ← named workflows the agent can run
|
|
125
|
-
│ ├── subagents/*.md ← reusable building blocks
|
|
126
|
-
│ └── projects/<project>/ ← per-project instance with config + logs
|
|
127
|
-
├── projects/<project>/ ← project-level shared substrate
|
|
128
|
-
│ └── CLAUDE.md, guidelines/ ← voice, ICPs, messaging, brand-book
|
|
129
|
-
├── chief-of-staff/ ← cross-cutting maintenance agent
|
|
130
|
-
├── dreamer/ ← cross-cutting reinforcement agent
|
|
131
|
-
├── scripts/ ← backing scripts (create/archive/audit/rename)
|
|
132
|
-
└── .claude/commands/ ← workspace-level slash commands
|
|
133
|
-
```
|
|
134
|
-
|
|
135
|
-
The two big ideas behind the layout:
|
|
136
|
-
|
|
137
|
-
1. **Substrate vs artifacts**: experts shape substrate (project guidelines), agents produce artifacts (specific outputs). Don't conflate them.
|
|
138
|
-
2. **Plans**: each agent has named plans (YAML workflow recipes). Cron-friendly. Auditable. Reusable.
|
|
139
|
-
|
|
140
|
-
## Migrating from agent-team
|
|
141
|
-
|
|
142
|
-
If you've been running the original `~/repos/agent-team` layout, here's the verbatim migration. Project substrate and `.env` carry over; the framework (skills, agents, scripts, conventions) comes from `roster init`.
|
|
143
|
-
|
|
144
|
-
```bash
|
|
145
|
-
# 1. Install roster (locally until v0.1 publishes; npx after)
|
|
146
|
-
npx @firatcand/roster install
|
|
82
|
+
## How it works
|
|
147
83
|
|
|
148
|
-
|
|
149
|
-
mkdir ~/repos/my-agent-team && cd ~/repos/my-agent-team
|
|
150
|
-
npx @firatcand/roster init
|
|
84
|
+
Roster scaffolds an opinionated **function → agent → plan** tree. Functions are top-level domains (`gtm/`, `product/`, `design/`, `ops/`). Each function holds named agents (`gtm/sdr/`, `design/critic/`). Each agent has named YAML **plans** — the schedulable, auditable workflow recipes.
|
|
151
85
|
|
|
152
|
-
|
|
153
|
-
cp -r ~/repos/agent-team/projects/{athelea,firatdogan} projects/
|
|
86
|
+
The opinion that keeps it useful at week 12 is **substrate vs artifacts**: long-lived context (voice, ICPs, messaging, brand) lives at the workspace root in `guidelines/`. Daily tactical output (emails, posts, PR comments) lands in `<function>/<agent>/logs/runs/`; anything that needs human approval first lands in `<agent>/pending/`. Experts shape substrate. Agents produce artifacts. Don't conflate them.
|
|
154
87
|
|
|
155
|
-
|
|
156
|
-
cp -r ~/repos/agent-team/gtm/sdr/projects/* gtm/sdr/projects/
|
|
88
|
+
A nightly **reinforcement** pass (the `dreamer` skill) reads runs + feedback, detects recurring patterns, and proposes lessons to the agent that produced them. You approve before anything is written. Quality compounds.
|
|
157
89
|
|
|
158
|
-
|
|
159
|
-
cp ~/repos/agent-team/.env .env
|
|
90
|
+
---
|
|
160
91
|
|
|
161
|
-
|
|
162
|
-
mv ~/repos/agent-team ~/repos/_archived/agent-team
|
|
163
|
-
```
|
|
92
|
+
## Tool support
|
|
164
93
|
|
|
165
|
-
|
|
94
|
+
| Tool | Status | Skills → | Agents → |
|
|
95
|
+
|---|---|---|---|
|
|
96
|
+
| Claude Code | Supported | `~/.claude/skills/<skill>/` | `~/.claude/agents/<agent>.md` |
|
|
97
|
+
| Codex CLI | Supported | `~/.codex/skills/<skill>/` | `~/.codex/agents/<agent>.md` |
|
|
98
|
+
| Gemini CLI | Supported | `~/.gemini/extensions/<skill>/` | `~/.gemini/agents/<agent>.md` |
|
|
99
|
+
| Cursor | On the roadmap | — | — |
|
|
166
100
|
|
|
167
|
-
|
|
101
|
+
Detection is presence-only — roster considers a tool installed if its config root exists. Override via `ROSTER_CLAUDE_HOME` / `ROSTER_CODEX_HOME` / `ROSTER_GEMINI_HOME` (used by the test suite).
|
|
168
102
|
|
|
169
|
-
|
|
170
|
-
roster doctor # confirms skills + agents are in place
|
|
171
|
-
```
|
|
103
|
+
---
|
|
172
104
|
|
|
173
105
|
## Security
|
|
174
106
|
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
- **
|
|
178
|
-
- **
|
|
179
|
-
- **npm provenance.** Releases are signed via `npm publish --provenance` from GitHub Actions on `v*` tag push. Verify the signature with `npm info @firatcand/roster dist.integrity` or the provenance badge on the npm page.
|
|
180
|
-
|
|
181
|
-
Path-traversal guards on `install` / `init` were audited under ROS-30 — see `test/security.test.ts` for the regression suite.
|
|
182
|
-
|
|
183
|
-
## v0.2 roadmap
|
|
107
|
+
- **No `preinstall` / `install` / `postinstall` scripts.** `npm install -g @firatcand/roster` writes files and stops. Asserted in `test/security.test.ts`.
|
|
108
|
+
- **No telemetry.** Nothing is collected — no analytics, no error reporting, no usage pings. Any future telemetry will be opt-in, gated behind a flag, and disclosed here before the release that introduces it.
|
|
109
|
+
- **npm provenance.** Releases are signed via `npm publish --provenance` from GitHub Actions on tag push. Verify with `npm info @firatcand/roster dist.integrity` or the provenance badge on the npm page.
|
|
110
|
+
- **Path-traversal guards** on `install` / `init` audited under ROS-30 — regression suite in `test/security.test.ts`.
|
|
184
111
|
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
- **Companion-skill installers.** Install GTM / product / design domain expertise alongside the framework, similar to forge's `companions`. Will point at `firatcand/founder-skills`.
|
|
188
|
-
- **Per-skill versioning gate in `doctor`.** Skills already ship with `version:` in frontmatter; `roster doctor` will surface drift between installed and shipped versions, mirroring how npm handles outdated globals.
|
|
189
|
-
- **`roster sync`.** Pull the latest skills from the installed roster package into existing tool config dirs without re-running the full `install` flow.
|
|
190
|
-
- **`roster migrate <path>`.** Replace the manual `cp`-based migration documented in [Migrating from agent-team](#migrating-from-agent-team) with a single command that copies project substrate + `.env` and runs `roster init`.
|
|
191
|
-
- **Cursor support.** Promoted from "out of scope" once the Cursor skill API stabilizes — the layout maps cleanly to `~/.cursor/`.
|
|
112
|
+
---
|
|
192
113
|
|
|
193
114
|
## Documentation
|
|
194
115
|
|
|
195
|
-
- [docs/HOWTO.md](docs/HOWTO.md) —
|
|
196
|
-
- [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) —
|
|
197
|
-
- [docs/
|
|
116
|
+
- [docs/HOWTO.md](docs/HOWTO.md) — install, init, create-agent, run a plan, audit
|
|
117
|
+
- [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) — substrate-vs-artifacts, lessons protocol, reinforcement loop
|
|
118
|
+
- [docs/SCHEDULING.md](docs/SCHEDULING.md) — schedule install/validate, UI hand-off, Codex subagent workaround, subscription-billing rules
|
|
119
|
+
- [docs/API.md](docs/API.md) — every script, config schema, convention
|
|
198
120
|
- [docs/roadmap.md](docs/roadmap.md) — what's shipped, what's next
|
|
199
121
|
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
The CLI ships a curated set of skills and agent definitions — these are starting points, not law.
|
|
122
|
+
---
|
|
203
123
|
|
|
204
|
-
|
|
205
|
-
- The example experts reflect one founder's judgment. Replace freely.
|
|
206
|
-
- The demo project (`projects/_demo/`) is safe to delete after init.
|
|
124
|
+
## Contributing
|
|
207
125
|
|
|
208
|
-
|
|
126
|
+
Bug reports, fixes, and docs improvements welcome. Read [CONTRIBUTING.md](CONTRIBUTING.md) for the development setup, PR process, release pipeline, and the CI gates a PR has to clear. Contributors working on the CLI itself should also read [CLAUDE.md](CLAUDE.md) for build/test/layout conventions.
|
|
209
127
|
|
|
210
|
-
|
|
211
|
-
- Not a build/CI tool — for that, see [forge](https://github.com/firatcand/forge) (complementary, not bundled).
|
|
212
|
-
- Not a substitute for thinking — it's a structure for organizing your thinking.
|
|
128
|
+
---
|
|
213
129
|
|
|
214
130
|
## License
|
|
215
131
|
|
|
216
132
|
MIT. See [LICENSE](LICENSE).
|
|
217
133
|
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
See [CONTRIBUTING.md](CONTRIBUTING.md). Contributors working on the CLI itself should read [CLAUDE.md](CLAUDE.md) for build/test/layout conventions.
|
|
221
|
-
|
|
222
|
-
### CI / branch protection
|
|
223
|
-
|
|
224
|
-
PRs into `main` run [`.github/workflows/ci.yml`](.github/workflows/ci.yml) — typecheck, test, build, `npm pack --dry-run`, `pnpm smoke`, `pnpm e2e`. Repo admins should enable branch protection on `main` (one-time manual step in **Settings → Branches → Branch protection rules → Add rule**):
|
|
225
|
-
|
|
226
|
-
- Require status checks to pass before merging: `CI / verify`
|
|
227
|
-
- Require branches to be up-to-date before merging
|
|
228
|
-
- (Optional) Require linear history
|
|
229
|
-
|
|
230
|
-
All third-party actions in `ci.yml` and `publish.yml` are pinned to 40-character commit SHAs (with a trailing `# vX.Y.Z` comment) and auto-updated weekly via [Dependabot](.github/dependabot.yml).
|
|
231
|
-
|
|
232
|
-
### Publishing / Releases
|
|
233
|
-
|
|
234
|
-
Releases are triggered by pushing a version tag:
|
|
235
|
-
|
|
236
|
-
```bash
|
|
237
|
-
git tag v0.1.0 && git push origin v0.1.0
|
|
238
|
-
```
|
|
239
|
-
|
|
240
|
-
The [publish workflow](.github/workflows/publish.yml) runs the full quality gate (`typecheck`, `test`, `build`), asserts the tag matches `package.json` version, publishes to npm with provenance, and creates a GitHub Release with auto-generated notes.
|
|
241
|
-
|
|
242
|
-
**One-time setup — `NPM_TOKEN` secret:**
|
|
243
|
-
|
|
244
|
-
1. Mint a Granular Access Token at [npmjs.com](https://www.npmjs.com/) → Account → Access Tokens → Generate New Token → Granular.
|
|
245
|
-
- Permissions: **Read and write** scoped to `@firatcand/roster` (publish; deprecation is intentionally kept manual — see rollback note below).
|
|
246
|
-
- Set an expiry (90–365 days recommended).
|
|
247
|
-
2. In this repo: **Settings → Secrets and variables → Actions → New repository secret**.
|
|
248
|
-
- Name: `NPM_TOKEN`
|
|
249
|
-
- Value: the token from step 1.
|
|
250
|
-
|
|
251
|
-
No additional setup is needed for provenance — the workflow's `id-token: write` permission handles OIDC attestation automatically.
|
|
252
|
-
|
|
253
|
-
**One-time setup — `production` environment (manual `workflow_dispatch` approval gate):**
|
|
254
|
-
|
|
255
|
-
The publish workflow's `workflow_dispatch` trigger lets a maintainer manually run a publish against an existing tag (used for partial-publish recovery). To prevent anyone with `Actions: write` from triggering an unreviewed publish, manual dispatches are gated behind a GitHub environment named `production` that requires maintainer approval. Tag-push releases (the canonical `git tag vX.Y.Z && git push --tags` path) are **not** gated — they run immediately.
|
|
256
|
-
|
|
257
|
-
1. GitHub repo → **Settings → Environments → New environment**, name: `production`.
|
|
258
|
-
2. **Required reviewers:** add the maintainer (Firat). **Do NOT enable "Prevent self-review"** — this is a solo-maintainer project and enabling it would leave every dispatch permanently stuck.
|
|
259
|
-
3. **Wait timer:** 0.
|
|
260
|
-
4. **Deployment branches and tags:** leave on the default "All branches and tags." A `v*` tag rule sounds appealing as belt-and-suspenders but actually blocks `workflow_dispatch` — on dispatch, `github.ref` is the default branch, not the tag (which is supplied separately via the `tag` input and checked out later in the job).
|
|
261
|
-
|
|
262
|
-
Because self-approval is allowed, the maintainer account becomes the only barrier between an `Actions: write` actor and an npm publish. **Enable TOTP-based 2FA on the GitHub account** (and on the npm account that owns `NPM_TOKEN`) as the compensating control.
|
|
263
|
-
|
|
264
|
-
After this, any manual `workflow_dispatch` of the publish workflow will pause in "Waiting for review" state until approved in the Actions UI.
|
|
265
|
-
|
|
266
|
-
**Pre-release tags** (e.g. `v0.1.0-rc.1`) are detected by suffix and automatically published to the `next` dist-tag on npm and marked as pre-release on GitHub. Stable tags publish to `latest`.
|
|
267
|
-
|
|
268
|
-
If a bad version ships, `npm deprecate @firatcand/roster@<version> "<reason>"` and publish a fix as the next patch — never reuse a version number.
|
|
269
|
-
|
|
270
|
-
## Acknowledgments
|
|
271
|
-
|
|
272
|
-
Built on top of [Claude Code](https://claude.com/code) and the broader AI-coding-tool ecosystem.
|
|
134
|
+
Built on top of [Claude Code](https://claude.com/code), [Codex CLI](https://github.com/openai/codex), and the broader AI-coding-tool ecosystem.
|
package/agents/lesson-drafter.md
CHANGED
|
@@ -14,20 +14,17 @@ A focused subagent invoked by the **dreamer** skill during reflection passes. Gi
|
|
|
14
14
|
- `pattern` (object): output from the dreamer's pattern-detector
|
|
15
15
|
- `existing_lesson` (object, optional): if extending an existing lesson, the current version
|
|
16
16
|
- `agent` (string): which agent generated the source signals
|
|
17
|
-
- `project` (string): which project sourced the signals (or `—` for global lessons)
|
|
18
17
|
|
|
19
18
|
## Output
|
|
20
19
|
|
|
21
20
|
```yaml
|
|
22
21
|
suggested_filename: L-2026-04-26-001.md
|
|
23
|
-
suggested_path: <function>/<agent>/
|
|
22
|
+
suggested_path: <function>/<agent>/playbook/
|
|
24
23
|
status: candidate
|
|
25
24
|
lesson_markdown: |
|
|
26
25
|
---
|
|
27
26
|
id: L-2026-04-26-001
|
|
28
27
|
source: dreamer
|
|
29
|
-
scope: project # or global
|
|
30
|
-
project: _demo # or "—" if scope=global
|
|
31
28
|
agent: sdr
|
|
32
29
|
...full frontmatter per conventions...
|
|
33
30
|
---
|
|
@@ -36,7 +33,6 @@ lesson_markdown: |
|
|
|
36
33
|
|
|
37
34
|
## Pattern observed
|
|
38
35
|
## Recommendation
|
|
39
|
-
## Why this might be project-specific
|
|
40
36
|
## Retirement criteria
|
|
41
37
|
```
|
|
42
38
|
|
|
@@ -44,9 +40,8 @@ lesson_markdown: |
|
|
|
44
40
|
|
|
45
41
|
- Use the exact schema in `conventions.md`. Do not invent fields.
|
|
46
42
|
- Always set `source: dreamer`.
|
|
47
|
-
- Default to `scope: project` unless explicitly handling a promotion case from the arbiter.
|
|
48
43
|
- Cite evidence in the body, not just frontmatter.
|
|
49
|
-
- The body has exactly
|
|
44
|
+
- The body has exactly three sections: pattern, recommendation, retirement criteria.
|
|
50
45
|
|
|
51
46
|
## Quality bar
|
|
52
47
|
|
|
@@ -59,6 +54,6 @@ Every drafted lesson must be:
|
|
|
59
54
|
|
|
60
55
|
## What this subagent does NOT do
|
|
61
56
|
|
|
62
|
-
- Promote
|
|
57
|
+
- Promote lessons to a different scope. v1 has a single playbook per agent.
|
|
63
58
|
- Write to `playbook/` directly. The orchestrator (dreamer) does that after HITL approval.
|
|
64
59
|
- Edit existing lessons in place without a clear `existing_lesson` input.
|