Getting started
Adopt soloscrum into a new repository in four steps. After this page you will have the plugin installed, a tracker profile selected, optional repo-level rules configured, and your first Issue filed via /refine.
Prerequisites
Section titled “Prerequisites”- Claude Code installed and authenticated.
- GitHub CLI (
gh) installed, authenticated against the GitHub account that owns the repo, and able to read / create / edit Issues and PRs. - Repository on GitHub — soloscrum treats GitHub as the canonical Issue store regardless of tracker profile.
- (Optional) CodeRabbit CLI authenticated.
/reviewruns CodeRabbit as part of the multi-agent pipeline; without it the local quality gate is weaker but still runs. - (Optional) Linear MCP connected with GitHub→Linear native sync configured. Required only for the
linear+githubtracker profile.
Step 1 — install the plugin
Section titled “Step 1 — install the plugin”soloscrum ships as a Claude Code plugin via its marketplace. From inside Claude Code:
/plugin marketplace add mew-ton/soloscrum/plugin install soloscrumIf you installed it before in a different repo, run /plugin marketplace update soloscrum to pull the latest version.
After install, the soloscrum commands (/refine, /breakdown, /develop, /review) are available in any Claude Code session against the repo.
Step 2 — choose a tracker profile
Section titled “Step 2 — choose a tracker profile”A tracker profile controls where Subtasks, SP, dependencies, and state are stored.
| Profile | When to use |
|---|---|
github-only | Default. Repo allows only GitHub Issues (organisation constraint, public OSS, etc.). Subtasks use native GitHub Sub-issues; SP lives in a GitHub Projects v2 number field. |
linear+github | Repo has Linear MCP available and GitHub→Linear native sync configured. Issues remain canonical on GitHub; Subtasks and SP live on Linear and sync back. |
For the full contract, see tracker profile.
The plugin user config exposes a tracker_profile setting captured at install time. To override it for a specific repo (e.g. you default to linear+github globally but a particular OSS repo only allows GitHub), drop .claude/rules/tracker.md at the repo root with frontmatter:
---profile: github-only---The repo-local override takes precedence over the user-level default. Without either, github-only is the built-in fallback.
Step 3 — configure repo rules (optional)
Section titled “Step 3 — configure repo rules (optional)”soloscrum reads optional repo-specific rules from .claude/rules/. None are required; each one tightens the agent’s behaviour for that repo.
| File | What it controls |
|---|---|
.claude/rules/tracker.md | Tracker profile override (see Step 2). |
.claude/rules/stack.md | Tech stack, directory layout, and naming conventions Dev consults during /develop. |
.claude/rules/branch.md | Branch strategy specific to this repo (e.g. trunk-based vs gitflow), if it diverges from the default <type>/<issue-id>-<slug> form. |
.claude/rules/dod-extra.md | Extra DoD items appended to the core checklist — e.g. “Storybook story exists for every new component”, “i18n strings registered in both locales”. |
.claude/rules/pr.md | Optional override of the always-draft PR default (rarely needed; see PR lifecycle). |
.claude/rules/agent-overrides.md | Repo-specific tweaks to the agent ownership matrix — almost never needed. |
Each file is plain Markdown. Add only the overrides you want; missing files mean the soloscrum defaults apply.
Step 4 — file your first Issue with /refine
Section titled “Step 4 — file your first Issue with /refine”Open a Claude Code session in the repo and run:
/refine "<your idea here>"The first line of output is the janitor sweep — on a brand-new repo this is No stale Issues found. The PO agent then structures your idea into a four-section Issue body (Background / Goal / AC / Out of Scope), assigns a priority label, and computes a size-check SP. You confirm; the Issue is created.
From there, the lifecycle is:
- If the size-check SP is 5 or below and the work fits a single PR, run
/developon the Issue directly. - If the SP exceeds 5 or the change spans multiple subsystems, run
/breakdownfirst to slice the Issue into Subtasks, then/developeach one. - After
/developopens the draft PR, run/reviewon it. On Pass,/reviewpromotes the PR to ready and surfaces thegh pr mergecommand — that final merge is your gate, not the agent’s.
Where to go next
Section titled “Where to go next”- Concept section — tracker profile, agent ownership rules, PR lifecycle, code review process.
- Policies section — the rules
/refineand/reviewdecide against (Issue format, priority, story points, issue size, DoD). - Commands section — per-command walkthroughs for
/refine,/breakdown,/develop,/review. - Canonical specs:
skills/,agents/,commands/.