scrumrun 1.5.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/CORE.md +381 -0
- package/DECISIONS.md +212 -0
- package/README.md +123 -0
- package/SPEC.md +324 -0
- package/bin/claude-install.js +147 -0
- package/bin/scrumrun.js +1194 -0
- package/package.json +48 -0
- package/templates/codex/prompts/sc-agent.md +14 -0
- package/templates/codex/prompts/sc-backlog.md +13 -0
- package/templates/codex/prompts/sc-challenge.md +57 -0
- package/templates/codex/prompts/sc-config.md +18 -0
- package/templates/codex/prompts/sc-context.md +24 -0
- package/templates/codex/prompts/sc-decisions.md +8 -0
- package/templates/codex/prompts/sc-feature.md +16 -0
- package/templates/codex/prompts/sc-fix.md +21 -0
- package/templates/codex/prompts/sc-goal.md +14 -0
- package/templates/codex/prompts/sc-golden.md +14 -0
- package/templates/codex/prompts/sc-help.md +12 -0
- package/templates/codex/prompts/sc-init.md +14 -0
- package/templates/codex/prompts/sc-intake.md +22 -0
- package/templates/codex/prompts/sc-know.md +75 -0
- package/templates/codex/prompts/sc-map.md +13 -0
- package/templates/codex/prompts/sc-review.md +13 -0
- package/templates/codex/prompts/sc-sprint.md +28 -0
- package/templates/codex/prompts/sc-study.md +23 -0
- package/templates/codex/prompts/sc-uninstall.md +14 -0
- package/templates/codex/prompts/sc-update.md +6 -0
- package/templates/codex/prompts/sc-vault.md +27 -0
- package/templates/codex/skills/scrumrun/SKILL.md +412 -0
- package/templates/opencode/commands/sc-agent.md +14 -0
- package/templates/opencode/commands/sc-backlog.md +13 -0
- package/templates/opencode/commands/sc-challenge.md +57 -0
- package/templates/opencode/commands/sc-config.md +18 -0
- package/templates/opencode/commands/sc-context.md +24 -0
- package/templates/opencode/commands/sc-decisions.md +8 -0
- package/templates/opencode/commands/sc-feature.md +16 -0
- package/templates/opencode/commands/sc-fix.md +21 -0
- package/templates/opencode/commands/sc-goal.md +14 -0
- package/templates/opencode/commands/sc-golden.md +14 -0
- package/templates/opencode/commands/sc-help.md +12 -0
- package/templates/opencode/commands/sc-init.md +14 -0
- package/templates/opencode/commands/sc-intake.md +22 -0
- package/templates/opencode/commands/sc-know.md +75 -0
- package/templates/opencode/commands/sc-map.md +13 -0
- package/templates/opencode/commands/sc-review.md +13 -0
- package/templates/opencode/commands/sc-sprint.md +28 -0
- package/templates/opencode/commands/sc-study.md +23 -0
- package/templates/opencode/commands/sc-uninstall.md +14 -0
- package/templates/opencode/commands/sc-update.md +6 -0
- package/templates/opencode/commands/sc-vault.md +27 -0
- package/templates/opencode/skills/scrumrun/SKILL.md +412 -0
- package/templates/project/.scrumrun/agents.md +36 -0
- package/templates/project/.scrumrun/backlog.md +7 -0
- package/templates/project/.scrumrun/config.md +13 -0
- package/templates/project/.scrumrun/context.md +61 -0
- package/templates/project/.scrumrun/features/.gitkeep +1 -0
- package/templates/project/.scrumrun/goals/main/decisions.md +9 -0
- package/templates/project/.scrumrun/goals/main/history.md +51 -0
- package/templates/project/.scrumrun/goals/main/sprint.md +54 -0
- package/templates/project/.scrumrun/golden-rules.md +9 -0
- package/templates/project/.scrumrun/knowledge.md +15 -0
- package/templates/project/.scrumrun/map.md +20 -0
- package/templates/project/.scrumrun/project.md +26 -0
- package/templates/project/.scrumrun/reviews/.gitkeep +1 -0
- package/templates/project/.scrumrun/runbook.md +101 -0
- package/templates/project/.scrumrun/token-policy.md +43 -0
- package/templates/project/AGENTS.md +59 -0
package/package.json
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "scrumrun",
|
|
3
|
+
"version": "1.5.0",
|
|
4
|
+
"description": "ScrumRun: portable sprint-driven AI workflow for real software projects.",
|
|
5
|
+
"bin": {
|
|
6
|
+
"scrumrun": "bin/scrumrun.js",
|
|
7
|
+
"sr-claude": "bin/claude-install.js"
|
|
8
|
+
},
|
|
9
|
+
"files": [
|
|
10
|
+
"bin",
|
|
11
|
+
"templates",
|
|
12
|
+
"CORE.md",
|
|
13
|
+
"SPEC.md",
|
|
14
|
+
"DECISIONS.md",
|
|
15
|
+
"README.md"
|
|
16
|
+
],
|
|
17
|
+
"scripts": {
|
|
18
|
+
"test": "node --test tests/*.test.js"
|
|
19
|
+
},
|
|
20
|
+
"keywords": [
|
|
21
|
+
"ai",
|
|
22
|
+
"scrum",
|
|
23
|
+
"codex",
|
|
24
|
+
"opencode",
|
|
25
|
+
"agents",
|
|
26
|
+
"sprints"
|
|
27
|
+
],
|
|
28
|
+
"author": {
|
|
29
|
+
"name": "Leander Costa",
|
|
30
|
+
"email": "leander.dev@proton.me",
|
|
31
|
+
"url": "https://github.com/leandercosta"
|
|
32
|
+
},
|
|
33
|
+
"repository": {
|
|
34
|
+
"type": "git",
|
|
35
|
+
"url": "git+https://github.com/leandercosta/scrumrun.git"
|
|
36
|
+
},
|
|
37
|
+
"homepage": "https://github.com/leandercosta/scrumrun#readme",
|
|
38
|
+
"bugs": {
|
|
39
|
+
"url": "https://github.com/leandercosta/scrumrun/issues"
|
|
40
|
+
},
|
|
41
|
+
"publishConfig": {
|
|
42
|
+
"access": "public"
|
|
43
|
+
},
|
|
44
|
+
"license": "MIT",
|
|
45
|
+
"engines": {
|
|
46
|
+
"node": ">=18"
|
|
47
|
+
}
|
|
48
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Manage review agents — add, list, run
|
|
3
|
+
argument-hint: --add|-a, --list|-l, --run|-r <sprint>
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Manage review agents in `.scrumrun/agents.md`: $ARGUMENTS
|
|
7
|
+
|
|
8
|
+
If no action flag is present in `$ARGUMENTS`, list the actions below and stop without guessing an action.
|
|
9
|
+
|
|
10
|
+
Actions:
|
|
11
|
+
|
|
12
|
+
- `--add` (`-a`): create a new review agent in `.scrumrun/agents.md` by asking role, checks, run order, and optional technology focus first.
|
|
13
|
+
- `--list` (`-l`): list all agents from `.scrumrun/agents.md` and explain their roles and checkpoints. Do not modify files.
|
|
14
|
+
- `--run` (`-r`) `<sprint>`: run review agents from `.scrumrun/agents.md` against the requested sprint — all agents or a specific numbered one — and update the relevant history file with the results.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Manage the sprint backlog — add, list
|
|
3
|
+
argument-hint: --add|-a <sprint number or name>, --list|-l [filter]
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Manage the sprint backlog in `.scrumrun/backlog.md`: $ARGUMENTS
|
|
7
|
+
|
|
8
|
+
If no action flag is present in `$ARGUMENTS`, list the actions below and stop without guessing an action.
|
|
9
|
+
|
|
10
|
+
Actions:
|
|
11
|
+
|
|
12
|
+
- `--add` (`-a`) `<sprint number or name>`: add the requested sprint candidate to `.scrumrun/backlog.md` without executing code or updating sprint history. Read `.scrumrun/golden-rules.md`, `.scrumrun/config.md`, `.scrumrun/goals/main/sprint.md`, `.scrumrun/goals/main/history.md`, and `.scrumrun/backlog.md` if present. Treat the sprint as a candidate, not active work. If it exists in the sprint plan, copy its title or focus; if not, add the label as a manual candidate with details pending. Do not run implementation, agents, tests, or audits; do not change sprint status; if it already exists, report instead of duplicating.
|
|
13
|
+
- `--list` (`-l`) `[filter]`: read `.scrumrun/backlog.md`, `.scrumrun/goals/main/sprint.md`, and `.scrumrun/goals/main/history.md`, then list backlog candidates showing the backlog item, the matching sprint title or focus when discoverable, whether history marks it completed, partial, or blocked, and the exact command to run it, such as `/sc-sprint --run Sprint 01`. Do not modify files.
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Analyze a user challenge and recommend sprint, backlog, feature, discovery, or rejection
|
|
3
|
+
argument-hint: challenge description
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Analyze this challenge against the current project and recommend the safest ScrumRun path. Do not modify files: $ARGUMENTS
|
|
7
|
+
|
|
8
|
+
Read, when present:
|
|
9
|
+
|
|
10
|
+
1. `AGENTS.md`;
|
|
11
|
+
2. `.scrumrun/golden-rules.md`;
|
|
12
|
+
3. `.scrumrun/config.md`;
|
|
13
|
+
4. `.scrumrun/map.md`;
|
|
14
|
+
5. `.scrumrun/project.md`;
|
|
15
|
+
6. `.scrumrun/knowledge.md`;
|
|
16
|
+
7. `.scrumrun/backlog.md`;
|
|
17
|
+
8. `.scrumrun/goals/main/sprint.md`;
|
|
18
|
+
9. `.scrumrun/goals/main/history.md`;
|
|
19
|
+
10. `.scrumrun/goals/main/decisions.md`;
|
|
20
|
+
11. `.scrumrun/features/*/feature.md`;
|
|
21
|
+
12. `.scrumrun/features/*/sprint.md`;
|
|
22
|
+
13. `.scrumrun/features/*/history.md`;
|
|
23
|
+
14. `.scrumrun/features/*/decisions.md`;
|
|
24
|
+
15. relevant source files needed to verify the challenge.
|
|
25
|
+
|
|
26
|
+
Only use the `Approved Knowledge` section of `.scrumrun/knowledge.md` as planning truth. Pending proposals are unapproved context and must be labeled as such.
|
|
27
|
+
|
|
28
|
+
The history read is mandatory when any history file exists. Use it to detect repeated work, failed attempts, blockers, partial implementations, regressions, and completed related sprints.
|
|
29
|
+
|
|
30
|
+
Inspect the repository deeply enough to understand affected areas:
|
|
31
|
+
|
|
32
|
+
1. product behavior;
|
|
33
|
+
2. stack and local commands;
|
|
34
|
+
3. architecture and entry points;
|
|
35
|
+
4. auth, permissions, roles, policies, and access boundaries;
|
|
36
|
+
5. data model, migrations, queues, caches, and external state;
|
|
37
|
+
6. env/config, secrets handling, third-party integrations, and webhooks;
|
|
38
|
+
7. tests, deployment clues, observability, and operational risk.
|
|
39
|
+
|
|
40
|
+
Return:
|
|
41
|
+
|
|
42
|
+
1. Challenge understanding;
|
|
43
|
+
2. Approved knowledge used;
|
|
44
|
+
3. Relevant evidence with file references;
|
|
45
|
+
4. History findings;
|
|
46
|
+
5. Impact analysis;
|
|
47
|
+
6. Risks and unknowns;
|
|
48
|
+
7. Options:
|
|
49
|
+
- create small sprint;
|
|
50
|
+
- add to backlog;
|
|
51
|
+
- create isolated feature lane;
|
|
52
|
+
- run discovery first;
|
|
53
|
+
- reject or defer because it conflicts with architecture, safety, product direction, or missing information;
|
|
54
|
+
8. Recommendation with rationale;
|
|
55
|
+
9. Suggested next command, such as `/sc-backlog --add ...`, `/sc-sprint --add ...`, `/sc-feature --add ...`, or a clarifying question.
|
|
56
|
+
|
|
57
|
+
Do not create backlog items, sprint plans, feature lanes, code changes, commits, tests, or history entries unless the user explicitly asks in a follow-up command.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Manage ScrumRun language, intake, approval, and quick-task preferences
|
|
3
|
+
argument-hint: --show|-s, --lang|-l <language>, --interaction <mode>, --approval <policy>, --quick-tasks <policy>
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Manage ScrumRun preferences in `.scrumrun/config.md`: $ARGUMENTS
|
|
7
|
+
|
|
8
|
+
If no action flag is present in `$ARGUMENTS`, list the actions below and stop without guessing an action.
|
|
9
|
+
|
|
10
|
+
Actions:
|
|
11
|
+
|
|
12
|
+
- `--show` (`-s`): show `.scrumrun/config.md`, including language, intake, approval, quick-task, and sprint automation preferences. Do not modify files.
|
|
13
|
+
- `--lang` (`-l`) `<language>`: set the response language for all ScrumRun commands in `.scrumrun/config.md`. Preserve unrelated preferences.
|
|
14
|
+
- `--interaction` (`-i`) `<guided|concise|autonomous-planning|strict>`: set how natural-language intake responds. `strict` disables automatic intake.
|
|
15
|
+
- `--approval` (`-a`) `<always|implementation-only>`: `always` requires approval before planning records or code changes; `implementation-only` allows the recommended planning record after intake but still requires approval before application changes.
|
|
16
|
+
- `--quick-tasks` (`-q`) `<ask|allow|backlog>`: ask before a quick task, allow clearly scoped low-risk quick tasks after classification, or park them in backlog.
|
|
17
|
+
|
|
18
|
+
Reject unknown values. Preserve every unrelated preference and never weaken golden rules or sprint history checks.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Manage the token-safe ScrumRun context snapshot
|
|
3
|
+
argument-hint: --build|-b, --update|-u, --show|-s, --clear|-c, --policy|-p
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Manage ScrumRun context economy for the current project: $ARGUMENTS
|
|
7
|
+
|
|
8
|
+
If no action flag is present in `$ARGUMENTS`, list the actions below and stop without guessing an action.
|
|
9
|
+
|
|
10
|
+
Actions:
|
|
11
|
+
|
|
12
|
+
- `--build` (`-b`): create or fully refresh `.scrumrun/context.md` from canonical ScrumRun files and targeted source inspection. Read `golden-rules.md`, `config.md`, `token-policy.md`, `map.md`, `project.md`, `knowledge.md`, `runbook.md`, active sprint/feature files, relevant history, and decisions. Do not treat the old snapshot as truth.
|
|
13
|
+
- `--update` (`-u`) `[reason]`: update only the sections affected by recent work, such as current focus, decisions, risks, map pointers, and staleness triggers. Use after study, challenge, sprint creation, sprint execution, review, or knowledge changes.
|
|
14
|
+
- `--show` (`-s`): show `.scrumrun/context.md` as a concise snapshot. Do not modify files.
|
|
15
|
+
- `--clear` (`-c`): reset `.scrumrun/context.md` to a safe placeholder that says it is stale and must be rebuilt. Do not delete canonical project files.
|
|
16
|
+
- `--policy` (`-p`): show `.scrumrun/token-policy.md` and explain how token economy applies to the current task. Do not modify files.
|
|
17
|
+
|
|
18
|
+
Rules:
|
|
19
|
+
|
|
20
|
+
1. `context.md` is a token-saving snapshot, not canonical truth.
|
|
21
|
+
2. Never let `context.md` override golden rules, approved knowledge, sprint history, decisions, or source code.
|
|
22
|
+
3. Never include `.scrumrun/vault.local.md` values.
|
|
23
|
+
4. Prefer short bullets, file references, and "must read" pointers over long pasted content.
|
|
24
|
+
5. If a snapshot is stale or unverifiable, mark it stale and ask whether to rebuild.
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Resolve pending decisions, questions, and risks one by one
|
|
3
|
+
argument-hint: optional scope (default: main goal; or a feature slug)
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Resolve pending decisions, questions, and risks one by one: $ARGUMENTS
|
|
7
|
+
|
|
8
|
+
Default scope is the main goal: read `.scrumrun/goals/main/history.md` and `.scrumrun/goals/main/decisions.md`. If a feature is specified, use that feature lane's `history.md` and `decisions.md` instead. Resolve items one at a time and update the relevant decisions/history file with each resolution.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Manage isolated feature lanes — add, list, show, run, audit
|
|
3
|
+
argument-hint: --add <description>, --list|-l, --show|-s <slug>, --run|-r <slug> <sprint>, --audit|-a <slug> <sprint>
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Manage isolated feature lanes under `.scrumrun/features/`: $ARGUMENTS
|
|
7
|
+
|
|
8
|
+
If no action flag is present in `$ARGUMENTS`, list the actions below and stop without guessing an action.
|
|
9
|
+
|
|
10
|
+
Actions:
|
|
11
|
+
|
|
12
|
+
- `--add` (`--new` and `-n` are legacy aliases) `<description>`: create a new isolated feature lane under `.scrumrun/features/<slug>/`. Read `AGENTS.md`, `.scrumrun/golden-rules.md`, `.scrumrun/config.md`, `.scrumrun/map.md`, `.scrumrun/project.md`, `.scrumrun/agents.md`, and `.scrumrun/goals/main/history.md`. Do not modify `.scrumrun/goals/main/sprint.md` or `.scrumrun/goals/main/history.md`. Create `feature.md`, `sprint.md`, `history.md`, and `decisions.md`. The brief must include name, reason, scope, out of scope, dependencies, risks, and assumptions; the sprint plan must be modular, auditable, and independently executable.
|
|
13
|
+
- `--list` (`-l`) `[filter]`: list feature lanes under `.scrumrun/features/`, summarizing each brief, sprint status, open decisions, and next recommended sprint. Do not modify files.
|
|
14
|
+
- `--show` (`-s`) `<slug>`: read the requested lane and show its `feature.md`, `sprint.md`, `history.md`, and `decisions.md` in a concise status view. Do not modify files.
|
|
15
|
+
- `--run` (`-r`) `<slug> <sprint>`: run one sprint from a feature lane. Read `AGENTS.md`, `.scrumrun/golden-rules.md`, `.scrumrun/config.md`, `.scrumrun/map.md`, `.scrumrun/runbook.md`, `.scrumrun/agents.md`, and the lane's four files. Check feature history first; if the sprint is completed, partial, or blocked, stop and ask how to proceed. Otherwise follow Entenda -> Avalie Impactos -> Tire Duvidas -> Execute -> Teste, run review agents, and update the feature lane history only.
|
|
16
|
+
- `--audit` (`-a`) `<slug> <sprint>`: read the lane's four files plus `AGENTS.md`, `.scrumrun/golden-rules.md`, `.scrumrun/config.md`, `.scrumrun/map.md`, and `.scrumrun/agents.md`. Review changed files from current state, verify acceptance criteria, tests, env/config handling, and safety rules. Report findings ordered by severity. Do not modify application code unless explicitly requested.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Record fixes and browse the fix log for future reference
|
|
3
|
+
argument-hint: --add|-a "what broke", --list|-l, --show|-s <id>, --insight|-i <id>
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Manage the fix log in `.scrumrun/fixes.md`: $ARGUMENTS
|
|
7
|
+
|
|
8
|
+
Each fix entry uses a stable id in the form `F-NNN` (for example `F-001`), assigned sequentially. The log tracks what went wrong and what was done — a corpus for detecting recurring problems.
|
|
9
|
+
|
|
10
|
+
If no action flag is present in `$ARGUMENTS`, list the actions below and stop.
|
|
11
|
+
|
|
12
|
+
Actions:
|
|
13
|
+
|
|
14
|
+
- `--add` (`-a`) `"description"`: register a new fix entry with the next `F-NNN` id, stamped with today's date. Describe what broke, what was done, and optionally reference the relevant sprint or `K-NNN` knowledge entry.
|
|
15
|
+
- `--list` (`-l`): list all entries, most recent first, showing the id, date, and the first line of the description. Do not modify files.
|
|
16
|
+
- `--show` (`-s`) `<id>`: show the full details of a single `F-NNN` entry. Do not modify files.
|
|
17
|
+
- `--insight` (`-i`) `<id>`: read this fix entry and the full fix log to detect recurring patterns. If repeated failures are found, create a pending knowledge proposal (or add an insight to an existing `K-NNN`) so the lesson becomes durable. Ask the user before creating any knowledge entry.
|
|
18
|
+
|
|
19
|
+
When `/sc-sprint --fix` creates a corrective child sprint, it automatically registers an entry in `.scrumrun/fixes.md` — no manual `--add` is needed for sprint-originated fixes.
|
|
20
|
+
|
|
21
|
+
Do not modify application code.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Manage project goal lanes — set, show, list
|
|
3
|
+
argument-hint: --set <goal>, --show|-s [focus], --list|-l [filter]
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Manage the project goal lanes under `.scrumrun/goals/`: $ARGUMENTS
|
|
7
|
+
|
|
8
|
+
If no action flag is present in `$ARGUMENTS`, list the actions below and stop without guessing an action.
|
|
9
|
+
|
|
10
|
+
Actions:
|
|
11
|
+
|
|
12
|
+
- `--set` (`--new` and `-n` are legacy aliases) `<goal>`: plan or replace the main project goal in `.scrumrun/goals/main/sprint.md`. Read `AGENTS.md`, `.scrumrun/golden-rules.md`, `.scrumrun/config.md`, `.scrumrun/map.md`, `.scrumrun/project.md`, `.scrumrun/knowledge.md`, `.scrumrun/agents.md`, and `.scrumrun/goals/main/history.md`. Use only `Approved Knowledge` as planning truth. If `.scrumrun/config.md` says `Sprint Automation: backlog` or `bypass`, treat suggested sprints as backlog candidates and do not generate, modify, or run sprint plans automatically unless the user explicitly requests `/sc-sprint --add` or `/sc-backlog --add`. Ask all blocking architecture and stack questions before writing the plan, then update `.scrumrun/project.md`, `.scrumrun/goals/main/sprint.md`, and `.scrumrun/goals/main/decisions.md` as needed.
|
|
13
|
+
- `--show` (`-s`) `[focus]`: read `.scrumrun/project.md`, `.scrumrun/goals/main/sprint.md`, `.scrumrun/goals/main/history.md`, and `.scrumrun/goals/main/decisions.md`, and show the main goal status, next sprint, blockers, and open decisions. Do not modify files.
|
|
14
|
+
- `--list` (`-l`) `[filter]`: list goal lanes under `.scrumrun/goals/`, including each lane's sprint and history status. The default lane is `main`. Do not modify files.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Manage golden rules — absolute priority, never violated
|
|
3
|
+
argument-hint: --add|-a <rule>, --list|-l, --remove|-r <number>
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Manage golden rules in `.scrumrun/golden-rules.md`; they have absolute priority and are never violated: $ARGUMENTS
|
|
7
|
+
|
|
8
|
+
If no action flag is present in `$ARGUMENTS`, list the actions below and stop without guessing an action.
|
|
9
|
+
|
|
10
|
+
Actions:
|
|
11
|
+
|
|
12
|
+
- `--add` (`-a`) `<rule>`: append a new numbered golden rule to `.scrumrun/golden-rules.md` (create the file if missing) and show the updated list.
|
|
13
|
+
- `--list` (`-l`): read and list the golden rules. Do not modify files.
|
|
14
|
+
- `--remove` (`-r`) `<number>`: remove rule N from `.scrumrun/golden-rules.md` and show the updated list.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Show ScrumRun commands grouped by workflow
|
|
3
|
+
argument-hint: optional command or topic
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Show ScrumRun help for the current project.
|
|
7
|
+
|
|
8
|
+
Read `.scrumrun/config.md` if it exists to honor the response language. Explain commands by category: project, study/challenge intake, local vault, knowledge, context economy, config, golden rules, map, goals, sprint automation, features, sprints, agents, reviews, decisions, and CLI maintenance.
|
|
9
|
+
|
|
10
|
+
If a command or topic is provided, focus on that topic and include examples.
|
|
11
|
+
|
|
12
|
+
Topic: $ARGUMENTS
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Initialize ScrumRun project files locally by default
|
|
3
|
+
argument-hint: optional --local|-l, --shared|-s, --no-agent-hint|-n, or project goal/context
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Initialize the project with ScrumRun control files.
|
|
7
|
+
|
|
8
|
+
By default, recommend `scrumrun init` for existing projects. It behaves like `scrumrun init --local` (`-l`): create `AGENTS.md` and `.scrumrun/`, add both to `.git/info/exclude`, and keep ScrumRun out of commits. Use `--no-agent-hint` (`-n`) to skip `AGENTS.md`.
|
|
9
|
+
|
|
10
|
+
For teams that want ScrumRun committed, use `scrumrun init --shared` (`-s`).
|
|
11
|
+
|
|
12
|
+
If files already exist, ask before overwriting.
|
|
13
|
+
|
|
14
|
+
Project goal or options: $ARGUMENTS
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Route a natural-language request through ScrumRun and ask before acting
|
|
3
|
+
argument-hint: problem, desired change, or idea
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Run ScrumRun natural-language intake for: $ARGUMENTS
|
|
7
|
+
|
|
8
|
+
Read `AGENTS.md`, `.scrumrun/core.md`, `.scrumrun/golden-rules.md`, `.scrumrun/config.md`, `.scrumrun/token-policy.md`, `.scrumrun/context.md`, `.scrumrun/map.md`, `.scrumrun/project.md`, `.scrumrun/knowledge.md`, and only the backlog, plans, history, decisions, feature files, and source areas relevant to classifying this request. Relevant history is mandatory. Use only approved knowledge as planning truth.
|
|
9
|
+
|
|
10
|
+
Determine the desired outcome, urgency, scope, risk, uncertainty, and relationship to the main goal. Route the request to exactly one recommended workflow:
|
|
11
|
+
|
|
12
|
+
- quick task;
|
|
13
|
+
- knowledge or discovery;
|
|
14
|
+
- main-goal sprint;
|
|
15
|
+
- corrective fix linked to prior work;
|
|
16
|
+
- backlog candidate;
|
|
17
|
+
- isolated feature lane;
|
|
18
|
+
- reject or defer.
|
|
19
|
+
|
|
20
|
+
Follow `Interaction Mode`, `Execution Approval`, and `Quick Tasks` from `.scrumrun/config.md`. In guided mode, return the classification, recommendation with rationale, important evidence, material risks or unknowns, and at most two useful alternatives. Ask one clear approval question when required; otherwise state which configured policy authorizes the next transition.
|
|
21
|
+
|
|
22
|
+
Intake is read-only. Do not create or update planning records, modify application code, run tests as implementation verification, execute a sprint, or interpret an ambiguous acknowledgement as approval. After explicit approval, invoke the matching canonical workflow using `--add`, `--set`, `--update`, `--remove`, `--run`, `--audit`, `--approve`, or `--reject` as appropriate.
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Add, approve, reject, update, rename, annotate, remove, show, or list project knowledge
|
|
3
|
+
argument-hint: --add <topic>, --approve <id>, --reject <id>, --update <id>, --rename <id> "title", --insight <id> <text>, --remove <id>, --show [id], --list
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Manage ScrumRun project knowledge in `.scrumrun/knowledge.md`: $ARGUMENTS
|
|
7
|
+
|
|
8
|
+
Read `.scrumrun/golden-rules.md`, `.scrumrun/config.md`, `.scrumrun/map.md`, `.scrumrun/project.md`, `.scrumrun/knowledge.md`, `.scrumrun/goals/main/history.md`, feature histories when relevant, and source files needed to verify the topic.
|
|
9
|
+
|
|
10
|
+
Identifiers:
|
|
11
|
+
|
|
12
|
+
- Each knowledge entry uses a stable id in the form `K-NNN` (for example `K-001`), assigned sequentially.
|
|
13
|
+
|
|
14
|
+
Flags (may be combined):
|
|
15
|
+
|
|
16
|
+
- `--add`: investigate a topic and create a pending proposal. A bare topic is a legacy alias.
|
|
17
|
+
- `--approve`: approve one pending proposal with explicit owner consent. Positional `approve` is a legacy alias.
|
|
18
|
+
- `--reject`: reject one pending proposal. Positional `reject` is a legacy alias.
|
|
19
|
+
- `--deep` (`-d`): study the topic deeply and add a code map (see below).
|
|
20
|
+
- `--update` (`--edit`, `-e` legacy aliases): rewrite an existing `K-NNN` entry; see edit mode.
|
|
21
|
+
- `--rename` (`-rn`): change only the title of an existing `K-NNN` entry; the id never changes.
|
|
22
|
+
- `--insight` (`-i`): append a dated reasoning to an existing `K-NNN` entry without rewriting it.
|
|
23
|
+
- `--remove` (`-r`, or `--delete`): delete an existing `K-NNN` entry.
|
|
24
|
+
- `--show` (`--resume`, `-s` legacy aliases): render knowledge as a clean, readable summary; read-only.
|
|
25
|
+
|
|
26
|
+
Modes:
|
|
27
|
+
|
|
28
|
+
1. `list`: show approved knowledge, pending proposals, and rejected proposals. Do not modify files.
|
|
29
|
+
2. `approve <id>`: move a pending proposal into `Approved Knowledge` only if the user's approval is explicit. Preserve source references, caveats, date, and approver.
|
|
30
|
+
3. `reject <id>`: move a pending proposal into `Rejected Proposals` with the reason when provided.
|
|
31
|
+
4. `remove <id>` or `<id> --remove`: delete that `K-NNN` entry from whichever section it is in, and report what was removed.
|
|
32
|
+
5. `<id> --edit [text]`: recreate the existing `K-NNN` entry under the same id. If text is supplied, use it as the new basis. If no text is supplied, reuse the entry's current title and insight and re-investigate from source. Combine with `--deep` to rewrite it deeply. The rewritten entry becomes a pending proposal under the same id and must be re-approved.
|
|
33
|
+
6. `<id> --rename "new title"`: change only the title of that `K-NNN` entry. The id never changes, and verified facts, code map, status, insights, date, and approver are all preserved. Mention the previous title in the change.
|
|
34
|
+
7. `<id> --insight <text>`: append a new dated insight — a reasoning, observation, or hypothesis — to that `K-NNN` entry under an `Insights` log, without changing its verified facts, code map, or status. Insights accumulate: never overwrite earlier ones, and mark them as insights, not verified facts. Create the `Insights` section if it does not exist yet.
|
|
35
|
+
8. `<id> --resume` or `--resume` (`-s`): render knowledge as a clean, readable summary instead of raw markdown. With a `K-NNN` id, present that single entry; with no id, present an organized overview of the whole base. Read-only — do not modify files. See the resume output format below.
|
|
36
|
+
9. any other text: investigate the topic and create a new pending knowledge proposal with the next `K-NNN` id. Do not put it directly into `Approved Knowledge`. With `--deep`, also build a code map.
|
|
37
|
+
|
|
38
|
+
For a new or rewritten pending proposal, include:
|
|
39
|
+
|
|
40
|
+
1. stable id in `K-NNN` form;
|
|
41
|
+
2. title;
|
|
42
|
+
3. user insight, if supplied;
|
|
43
|
+
4. verified facts with file references;
|
|
44
|
+
5. assumptions and uncertainty;
|
|
45
|
+
6. risks if this knowledge is wrong;
|
|
46
|
+
7. affected modules;
|
|
47
|
+
8. suggested use in future challenges or sprints;
|
|
48
|
+
9. approval prompt;
|
|
49
|
+
10. code map, only when `--deep` is used: key functions or symbols with `file:line` or `file:start-end` references, the main entry points and call sites, and the relevant types, config, or storage touchpoints. Short signatures or excerpts are allowed when they clarify behavior. Treat function and symbol names as the stable anchor and line numbers as point-in-time for the proposal date.
|
|
50
|
+
|
|
51
|
+
Resume output (`--resume`):
|
|
52
|
+
|
|
53
|
+
Render a scannable digest, not the raw file. For a single `K-NNN` entry, use clear sections:
|
|
54
|
+
|
|
55
|
+
- a heading line with the id, title, and a status label (Approved, Pending, or Rejected);
|
|
56
|
+
- **What it is**: one or two plain-language sentences;
|
|
57
|
+
- **Key facts**: bullets, each with its `file:line` reference;
|
|
58
|
+
- **Affected modules**: a short list;
|
|
59
|
+
- **Code map**: only if the entry has one — functions or symbols with `file:line`, entry points, and call sites;
|
|
60
|
+
- **Assumptions & risks**: brief bullets;
|
|
61
|
+
- **Suggested use**: where this should inform challenges or sprints;
|
|
62
|
+
- a compact footer with status, date, and approver when present.
|
|
63
|
+
|
|
64
|
+
For the whole base (no id), group entries under Approved, Pending, and Rejected, and show each as a compact card — `K-NNN — Title`, a one-line summary, and its status — sorted by id. Read-only.
|
|
65
|
+
|
|
66
|
+
Rules:
|
|
67
|
+
|
|
68
|
+
1. Approved knowledge can influence `/sc-challenge`, `/sc-sprint --add`, `/sc-sprint --run`, and feature planning.
|
|
69
|
+
2. Pending proposals are not planning truth. Mention them only as unapproved context.
|
|
70
|
+
3. Rejected proposals must not be used for planning except to avoid repeating a known bad assumption.
|
|
71
|
+
4. Editing an approved entry returns it to pending for re-approval; never silently keep edited content as approved.
|
|
72
|
+
5. Insights are additive, dated annotations: advisory context, not verified planning truth. Adding an insight never rewrites the entry or changes its status. If an insight should become verified knowledge, use `--edit`.
|
|
73
|
+
6. Renaming changes only an entry's title; the `K-NNN` id is permanent and must never change.
|
|
74
|
+
7. Do not change application code.
|
|
75
|
+
8. Do not create sprints, backlog items, feature lanes, or history entries unless the user explicitly asks with another command.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Manage the project map — build, view
|
|
3
|
+
argument-hint: --build|-b, --view|-v
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Manage the project map in `.scrumrun/map.md`: $ARGUMENTS
|
|
7
|
+
|
|
8
|
+
If no action flag is present in `$ARGUMENTS`, list the actions below and stop without guessing an action.
|
|
9
|
+
|
|
10
|
+
Actions:
|
|
11
|
+
|
|
12
|
+
- `--build` (`-b`): build or refresh `.scrumrun/map.md` with the project structure, important paths, modules, and key files. Do not include secrets.
|
|
13
|
+
- `--view` (`-v`): show a concise project structure view using `.scrumrun/map.md` and current folders without modifying files.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Run a ScrumRun review — full codebase or a single file range
|
|
3
|
+
argument-hint: --code|-c [focus], --file|-f <path:start_end>
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Run a ScrumRun review: $ARGUMENTS
|
|
7
|
+
|
|
8
|
+
If no action flag is present in `$ARGUMENTS`, list the actions below and stop without guessing an action.
|
|
9
|
+
|
|
10
|
+
Actions:
|
|
11
|
+
|
|
12
|
+
- `--code` (`-c`) `[focus]`: review the full codebase and save a timestamped report under `.scrumrun/reviews/`. Order findings by severity with file and line references. Do not modify code unless explicitly requested.
|
|
13
|
+
- `--file` (`-f`) `<path:start_end>`: review the requested file range only, without changing code unless explicitly asked.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Manage main-goal sprints — add, list, status, show, rename, run, audit, fix, discuss, bypass, commit-message
|
|
3
|
+
argument-hint: --add [* name], --list|-l, --status|-st [id], --show|-s <id>, --rename|-rn <id> "name", --run|-r [--backlog|-k] <id>, --audit|-a <id>, --fix|-f <id>, --discuss|-d <id>, --bypass|-b, --commit-message|-cm <id>
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Manage main-goal sprints in `.scrumrun/goals/main/`: $ARGUMENTS
|
|
7
|
+
|
|
8
|
+
If no action flag is present in `$ARGUMENTS`, list the actions below and stop without guessing an action.
|
|
9
|
+
|
|
10
|
+
Before any planning or execution action, read `.scrumrun/knowledge.md` and use only `Approved Knowledge` as planning truth.
|
|
11
|
+
|
|
12
|
+
Important: `.scrumrun/goals/main/sprint.md` is the planned catalog — it lists what *should* happen. `.scrumrun/goals/main/history.md` is the executed truth — it records what *did* happen. Sprint execution status (completed, partial, blocked, pending) is determined solely from `history.md`. Never infer status from `sprint.md` alone. Every status query (`--list`, `--status`, `--show`) must cross-reference both files; neither is sufficient on its own.
|
|
13
|
+
|
|
14
|
+
Actions:
|
|
15
|
+
|
|
16
|
+
- `--add` (`--new` and `-n` are legacy aliases) `[*] <name>`: create a new sprint in `.scrumrun/goals/main/sprint.md`; prefix the name with `*` to mark priority. Read `.scrumrun/golden-rules.md`, `.scrumrun/config.md`, `.scrumrun/knowledge.md`, `.scrumrun/goals/main/sprint.md`, and `.scrumrun/goals/main/history.md` first. Assign the next available sprint number and add goal, scope, acceptance criteria, dependencies, and suggested verification.
|
|
17
|
+
- `--list` (`-l`): cross-reference `.scrumrun/goals/main/sprint.md` and `.scrumrun/goals/main/history.md` now — never assume status from sprint.md alone. Show current sprint status (completed, pending, blocked, next steps) as recorded in history.md. Do not use cached context. Do not modify files.
|
|
18
|
+
- `--status` (`-st`) `[id]`: cross-reference `.scrumrun/goals/main/sprint.md` and `.scrumrun/goals/main/history.md` now — status comes from history.md, not sprint.md. Output only a compact Markdown table with exactly three columns: `Sprint | Breve descricao | Status`. If `[id]` is present, show only that sprint; otherwise show one row per sprint. Keep descriptions brief, derived from the sprint title or goal. Use status labels with emojis: `✅ feito` for completed, `🚧 parcial` for partial, `⛔ bloqueado` for blocked, and `⏳ pendente` when no history entry exists. Do not add narrative before or after the table. Do not modify files.
|
|
19
|
+
- `--show` (`-s`) `<id>`: cross-reference both sprint.md and history.md now and show the requested sprint with a clear non-technical Goal first, plus scope, acceptance, and its history entry (the executed truth).
|
|
20
|
+
- `--rename` (`-rn`) `<id> "new name"`: change only the sprint's descriptive label in `.scrumrun/goals/main/sprint.md`; keep its number/id unchanged, since history and backlog reference the number. Note the change in `.scrumrun/goals/main/history.md` as "renamed from X to Y". Do not modify application code.
|
|
21
|
+
- `--run` (`-r`) `<id>`: execute the requested sprint with history check, the ScrumRun protocol, and handoff. If `$ARGUMENTS` also includes `--backlog` (`-k`) or `--to-backlog`, do not execute: add the sprint candidate to `.scrumrun/backlog.md`, report the entry, and stop.
|
|
22
|
+
- `--audit` (`-a`) `<id>`: read `.scrumrun/goals/main/sprint.md`, `.scrumrun/goals/main/history.md`, and the sprint's changed files now, then audit from current file state. Do not use cached context.
|
|
23
|
+
- `--fix` (`-f`) `<id>`: corrective pass on a sprint that went wrong. First ask the user what went wrong and wait for the answer — do not guess. Then propose an executable corrective child sprint and, once the user confirms, create it as `Sprint <id>.M` (a dotted child such as `02.1`, then `02.2`) in `.scrumrun/goals/main/sprint.md`: derive its goal, scope, and acceptance from the problem and link it to parent `<id>`. Leave the parent sprint's recorded plan intact and mark it as patched by the child. Record what happened in `.scrumrun/goals/main/history.md`, capture the lesson in `.scrumrun/knowledge.md` (a pending proposal, or an insight on the relevant `K-NNN` entry — never auto-approved; ask the user to approve it), and log any decision or risk in `.scrumrun/goals/main/decisions.md`. The fix is run later with `/sc-sprint --run <id>.M`. A fix that itself needs fixing becomes a sibling (`<id>.M+1`), not a deeper nest. Also register the fix in `.scrumrun/fixes.md` as `F-NNN` linked to both `<id>` and `<id>.M`. Do not change application code.
|
|
24
|
+
- `--commit-message` (`-cm`) `<id>`: return a single, succinct commit message summarizing what that sprint delivered. Read `.scrumrun/goals/main/sprint.md` and `.scrumrun/goals/main/history.md`, plus the sprint's changed files when helpful. Output only the message: one line, imperative mood, lowercase, no trailing period, and as few characters as possible while staying clear. Do not stage, commit, or modify any files.
|
|
25
|
+
- `--discuss` (`-d`) `<id>`: read the sprint and history, discuss the user's concern about the approach, and explore better paths.
|
|
26
|
+
- `--bypass` (`-b`) `[context]`: set `.scrumrun/config.md` to `Sprint Automation: backlog` for legacy or hand-managed projects, so suggested sprints are treated as backlog candidates until the user chooses what to run. Keep other preferences intact, note the change in `.scrumrun/project.md` or `.scrumrun/goals/main/decisions.md`, and prefer `/sc-backlog --add` and `/sc-backlog --list` for candidate management.
|
|
27
|
+
|
|
28
|
+
Do not modify application code.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Deep-study the project — stack, architecture, permissions, risks, and backlog candidates
|
|
3
|
+
argument-hint: optional focus area
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Run a deep ScrumRun study of the project and produce a complete operational understanding. Do not modify files: $ARGUMENTS
|
|
7
|
+
|
|
8
|
+
Read ScrumRun control files first, then inspect the repository deeply enough to understand:
|
|
9
|
+
|
|
10
|
+
1. product purpose and active goals;
|
|
11
|
+
2. stack, frameworks, package managers, runtime versions, and local commands;
|
|
12
|
+
3. architecture, entry points, routing, controllers, services, jobs, and important modules;
|
|
13
|
+
4. auth, authorization, roles, permissions, policies, guards, and access boundaries;
|
|
14
|
+
5. data model, migrations, seeds, storage, queues, caches, and external state;
|
|
15
|
+
6. env/config requirements, secret handling, third-party integrations, and webhooks;
|
|
16
|
+
7. deployment/infrastructure clues, CI, test strategy, and observability;
|
|
17
|
+
8. legacy risks, security concerns, performance hotspots, brittle areas, and unknowns;
|
|
18
|
+
9. current sprint plan, history, decisions, feature lanes, review agents, and backlog.
|
|
19
|
+
10. approved knowledge, pending knowledge proposals, and rejected assumptions from `.scrumrun/knowledge.md`.
|
|
20
|
+
|
|
21
|
+
Prefer precise file references over generic statements. If an area cannot be verified from the repo, say it is unknown and explain what evidence is missing.
|
|
22
|
+
|
|
23
|
+
When recommending sprints, present them as backlog candidates. Do not create, run, or mark sprints unless the user explicitly asks for `/sc-sprint --add`, `/sc-backlog --add`, or `/sc-sprint --run`.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Remove ScrumRun from the current project
|
|
3
|
+
argument-hint: optional --force|-f
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Remove ScrumRun from the current project.
|
|
7
|
+
|
|
8
|
+
Default behavior is conservative: remove ScrumRun entries from `.git/info/exclude` and show what would be removed.
|
|
9
|
+
|
|
10
|
+
With `--force` (`-f`), remove `.scrumrun/` and remove `AGENTS.md` only if it is recognized as ScrumRun-generated.
|
|
11
|
+
|
|
12
|
+
Do not remove application code or unrelated project files.
|
|
13
|
+
|
|
14
|
+
Options: $ARGUMENTS
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: Manage local development secrets in .scrumrun/vault.local.md
|
|
3
|
+
argument-hint: --add|-a <name:value>, --list|-l, --show|-s <name>, --remove|-r <name>
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Manage the local development vault in `.scrumrun/vault.local.md`: $ARGUMENTS
|
|
7
|
+
|
|
8
|
+
This vault is for development-only credentials and local test values. It is plaintext Markdown, not encrypted storage, and must never be committed or used for production secrets.
|
|
9
|
+
|
|
10
|
+
Rules:
|
|
11
|
+
|
|
12
|
+
1. Store values only in `.scrumrun/vault.local.md`.
|
|
13
|
+
2. Ensure `.scrumrun/vault.local.md` is listed in `.git/info/exclude` when the project is a Git repository.
|
|
14
|
+
3. Never copy vault values into sprint history, backlog, knowledge, reviews, decisions, commits, logs, or normal answers.
|
|
15
|
+
4. For `--list`, show ids/names only and redact values.
|
|
16
|
+
5. For `--show`, reveal only the explicitly requested local value.
|
|
17
|
+
6. For `--add`, accept either `<name:value>`, `<name=value>`, or `<name> <value>`.
|
|
18
|
+
7. For `--remove`, delete the requested entry.
|
|
19
|
+
8. Do not modify application code.
|
|
20
|
+
|
|
21
|
+
Actions:
|
|
22
|
+
|
|
23
|
+
- `--add` (`-a`) `<name:value>`: add or append a local development secret.
|
|
24
|
+
- `--list` (`-l`): list local vault entries with values redacted.
|
|
25
|
+
- `--show` (`-s`) `<id|name>`: show one local value.
|
|
26
|
+
- `--remove` (`-r`) `<id|name>`: remove one local value.
|
|
27
|
+
- `--path`: show the vault file path.
|