companion-kit
claude-companion: a calm companion pane for Claude Code, with everyday skills.
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Badge for your README
Markdown
[](/listings/melvinedlund--claude-companion)HTML
<a href="/listings/melvinedlund--claude-companion"><img src="/api/listings/melvinedlund--claude-companion/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
These steps run a script from the network that findsafeskills does not scan.
**macOS / Linux**
curl -fsSL https://raw.githubusercontent.com/MelvinEdlund/claude-companion/main/install.sh | sh
**Windows (PowerShell)**
irm https://raw.githubusercontent.com/MelvinEdlund/claude-companion/main/install.ps1 | iex
**Plugin only**, from inside Claude Code:
/plugin install companion-kit --marketplace MelvinEdlund/claude-companion
Next, start `claude` in a terminal at least 110 columns wide and send a prompt. The pane opens beside the chat. You can also open it any time with `/companion`.
<br>
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
.claude-plugin/marketplace.json · Manifest · 6 lines
- {
- "name": "companion-kit",
- "description": "claude-companion: a calm companion pane for Claude Code, with everyday skills.",
- "owner": { "name": "MelvinEdlund" },
- "plugins": [{ "name": "companion-kit", "source": "./" }]
- }
README.md · README · 211 lines · 2 findings marked
- <div align="center">
- <img src=".claude-plugin/icon.png" width="96" height="96" alt="">
- # claude-companion
- **A calm companion pane for Claude Code.** See which files Claude changed, see what it and its helpers are doing, and play a small game while it works.
- Also included: everyday skills, a set of coding rules, and an output style for staying focused.
- [](LICENSE)
- [](https://docs.claude.com/claude-code)
- [](hooks/companion.test.tsx)
- <br>
- <img src="assets/hero.svg" alt="Claude Code with the companion pane docked on the right: changed files with one folded open, two helpers at work, and a ball in flight" width="100%">
- </div>
- <br>
- ## Install
- **macOS / Linux**
- ```sh
- curl -fsSL https://raw.githubusercontent.com/MelvinEdlund/claude-companion/main/install.sh | sh
- Note: Pipes a downloaded script directly into a shell (curl | sh / wget | bash)
- Line 28 on GitHub
- ```
- **Windows (PowerShell)**
- ```powershell
- irm https://raw.githubusercontent.com/MelvinEdlund/claude-companion/main/install.ps1 | iex
- Note: Runs a downloaded PowerShell script (iex / Invoke-Expression)
- Line 34 on GitHub
- ```
- **Plugin only**, from inside Claude Code:
- ```
- /plugin install companion-kit --marketplace MelvinEdlund/claude-companion
- ```
- Next, start `claude` in a terminal at least 110 columns wide and send a prompt. The pane opens beside the chat. You can also open it any time with `/companion`.
- <br>
- ## Why
- While Claude works you mostly wait. You can watch the transcript scroll, switch to another tab and lose your train of thought, or poll `git diff` every minute.
- claude-companion gives that waiting time a place to rest:
- - A narrow pane shows what is happening.
- - It shows what changed and who is working on it.
- - A small game sits below it, in case your hands need something to do.
- The pane stays nearly still: **no notifications, no streaks to keep up, nothing blinking for your attention.** When Claude is done, its speech bubble names the next step.
- <br>
- ## What's in the kit
- | | |
- | --- | --- |
- | 🦀 **Companion pane** | Changed files grouped by folder. Click a file to fold out its change; hover it to see the full path. Two calm status lines, and a focus timer that suggests a break after a long stretch. |
- | 🧑🤝🧑 **Helpers** | Every subagent Claude starts joins the playground: Mike the builder, Oxlong the tester, Hugh the scout and more. Hover one, or Claude, to see its name, level and what it is working on right now. |
- | 🏀 **Two small games** | Hoops and darts, picked at random each session. Skill-based, no timers, best scores kept. |
- | 💬 **Next-step tips** | When an answer ends with `Next step: /something`, Claude shows that command in a speech bubble. |
- | 📈 **Levels from real work** | Tokens Claude spends level it up; helpers level from their own work. A new ball arrives every 100k tokens. |
- | 🛠️ **Skills** | `/commit`, `/pr-check` and `/spec`: safe commits, a pre-flight check before a pull request, and a spec before you build. |
- | 📏 **Coding rules** | Short, general rules Claude follows in every project: read before editing, no duplication, a changed test is a claim, report honestly, confirm before anything destructive. |
- | 🎯 **Focus output style** | Optional. Answers put the next action first, use numbered steps and visible wins, and end with one next step. |
- <br>
- ## The games
- <table>
- <tr>
- <td width="50%"><img src="assets/hoops.svg" alt="Hoops: a ball in flight from the slingshot toward a hoop, its path traced behind it"></td>
- <td width="50%"><img src="assets/darts.svg" alt="Darts: a dart hits the bullseye for 25 and Claude cheers"></td>
- </tr>
- <tr>
- <td>
- **Hoops.** The ball sits in a slingshot at the bottom left. Pull back from it and let go. It flies on a real arc, bounces off the walls, and can bounce off Claude too. Each hoop gives you three tries. A hit moves the hoop to a new height. A swish, or a hit on the first try, scores extra.
- </td>
- <td>
- **Darts.** Ten darts a round, thrown from a peg at a board on the far wall. The rings score more toward the middle, and the bullseye scores 25. Throws that fall short score nothing. Beat your best round.
- </td>
- </tr>
- </table>
- You can pick Claude up in either game and throw it around. It bounces off the walls, lands, and walks back to its spot. Switch games with `/game`.
- <div align="center">
- <img src="assets/tip.svg" alt="The playground with Claude saying next: /commit in a speech bubble" width="50%">
- </div>
- <br>
- ## Meet the helpers
- When Claude starts a subagent, a small character joins the playground. Hover it to see its name, level and what it is working on. Agent types the kit does not know get Al, a plain helper. Some names pair up when their helpers work at the same time.
- | Agent type | Name | Role | Look |
- | --- | --- | --- | --- |
- | `Explore` | Hugh | Scout | deerstalker |
- | `Plan` | Mungus | Planner | top hat |
- | `general-purpose` | Al | Helper | none |
- | `explorer` | Phil | Explorer | safari hat |
- | `implementer` | Mike | Builder | hard hat |
- | `test-writer` | Oxlong | Tester | cap |
- | `code-reviewer` | Ben | Reviewer | glasses |
- | `security-reviewer` | Dover | Security | helmet |
- | `ui-reviewer` | Anita | Designer | beret |
- Helpers keep their levels from one session to the next.
- <br>
- ## Commands and skills
- | Command | What it does |
- | --- | --- |
- | `/companion` | Opens the companion pane. Press Esc to return to the prompt. |
- | `/game` | Switches between hoops and darts. |
- | `/commit` | Commits and pushes safely. It never commits on `main` and never force-pushes or skips hooks. |
- | `/pr-check` | Checks for conflicts and overlapping files against the target branch and runs your checks. It then prints the exact `gh pr create` command. |
- | `/spec` | Writes the goal, testable acceptance criteria and exact changes before any code. Unclear points become questions to you. |
- When a name clashes with a command you already have, the plugin skills are also available with a prefix: `/companion-kit:commit` and so on.
- <br>
- ## What the installer does
- The installer is safe to run again. It updates what it installed and **never overwrites your own files.**
- 1. It clones the kit to `~/.claude/claude-companion`, or updates an existing copy.
- 2. It installs the plugin through Claude Code's plugin marketplace.
- 3. It adds one import line to `~/.claude/CLAUDE.md`, so Claude follows [the coding rules](config/CLAUDE.md). Your own rules stay where they are.
- 4. It sets `"tui": "fullscreen"` in `~/.claude/settings.json`, but only if you have not chosen a `tui` value yourself. The pane docks in the fullscreen view.
- 5. It copies the [Focus output style](config/output-styles/focus.md) to `~/.claude/output-styles/`. Turn it on with `/output-style focus`.
- To skip a step, set its variable when you run the installer:
- ```sh
- KIT_RULES=0 KIT_STYLE=0 sh install.sh # plugin and fullscreen view only
- ```
- <br>
- ## Design principles
- - **Calm over clever.** Motion is slow and small. The pane is something you glance at, not something to watch.
- - **Useful first, fun second.** The game sits below the information, never on top of it.
- - **No pressure.** No streaks to protect, no daily goals, nothing you can lose by stepping away.
- - **Local only.** The kit reads Claude Code's own events and keeps scores and levels in Claude Code's plugin store, on your machine. It makes no network requests and collects no data.
- <br>
- ## FAQ
- <details>
- <summary><b>The pane doesn't show up.</b></summary>
- The pane docks in the fullscreen view, beside the chat, when the terminal is at least 110 columns wide. Widen the window or run `/companion`. Check that `~/.claude/settings.json` has `"tui": "fullscreen"`. In VS Code the pane shows the figure and the status lines without a game.
- </details>
- <details>
- <summary><b>Does it slow Claude down?</b></summary>
- No. The pane only listens to events Claude Code already produces, such as a tool call or a finished turn. It adds nothing to your prompts or to the context Claude sees.
- </details>
- <details>
- <summary><b>Can I use only the pane, and not the rules or the output style?</b></summary>
- Yes. Use the plugin-only install line above, or set `KIT_RULES=0 KIT_STYLE=0` when you run the installer.
- </details>
- <details>
- <summary><b>How do levels work?</b></summary>
- Every 1,000 fresh tokens Claude spends gives it one point; tokens read back from the cache do not count. Level *n* needs 50 × (n−1)² points, so each level takes a little longer than the last. Helpers earn points from their own work.
- </details>
- <br>
- ## Uninstall
- ```sh
- claude plugin uninstall companion-kit
- ```
- If you used the installer, also remove the `@…/claude-companion/config/CLAUDE.md` line from `~/.claude/CLAUDE.md`. Then delete `~/.claude/claude-companion` and, if you added it, `~/.claude/output-styles/focus.md`.
- <br>
- ## Credits
- - The Focus output style is adapted from [ayghri/i-have-adhd](https://github.com/ayghri/i-have-adhd) (MIT).
- - claude-companion is a community project. It is not affiliated with or endorsed by Anthropic.
- ## License
- [MIT](LICENSE) © MelvinEdlund
install.ps1 · Bundled script · 88 lines · 1 finding marked
- # claude-companion installer for Windows (PowerShell 5.1+).
- # Safe to run again: it updates what it installed and never overwrites your own files.
- #
- # irm https://raw.githubusercontent.com/MelvinEdlund/claude-companion/main/install.ps1 | iex
- Note: Runs a downloaded PowerShell script (iex / Invoke-Expression)
- Line 4 on GitHub
- #
- # Options (environment variables):
- # $env:KIT_RULES = '0' skip adding the coding rules to ~/.claude/CLAUDE.md
- # $env:KIT_STYLE = '0' skip the optional Focus output style
- $ErrorActionPreference = 'Stop'
- $Repo = 'MelvinEdlund/claude-companion'
- $ClaudeDir = if ($env:CLAUDE_CONFIG_DIR) { $env:CLAUDE_CONFIG_DIR } else { Join-Path $HOME '.claude' }
- $KitDir = Join-Path $ClaudeDir 'claude-companion'
- $ImportLine = '@' + ((Join-Path $KitDir 'config/CLAUDE.md') -replace '\\', '/')
- function Write-Note($text) { Write-Host " $text" }
- function Write-Step($text) { Write-Host ''; Write-Host $text -ForegroundColor White }
- if (-not (Get-Command claude -ErrorAction SilentlyContinue)) {
- Write-Host 'Claude Code is not installed. Get it first: https://docs.claude.com/claude-code'
- return
- }
- if (-not (Get-Command git -ErrorAction SilentlyContinue)) {
- Write-Host 'git is required.'
- return
- }
- New-Item -ItemType Directory -Force $ClaudeDir | Out-Null
- Write-Step '1/5 Kit files'
- if (Test-Path (Join-Path $KitDir '.git')) {
- git -C $KitDir pull --ff-only --quiet
- Write-Note "updated $KitDir"
- } else {
- git clone --quiet --depth 1 "https://github.com/$Repo.git" $KitDir
- Write-Note "cloned to $KitDir"
- }
- Write-Step '2/5 Plugin (companion pane, games, skills)'
- try { claude plugin marketplace add $Repo *> $null } catch {}
- $installed = $false
- try { claude plugin install 'companion-kit@companion-kit' *> $null; $installed = $LASTEXITCODE -eq 0 } catch {}
- if (-not $installed) {
- try { claude plugin install companion-kit --marketplace $Repo *> $null; $installed = $LASTEXITCODE -eq 0 } catch {}
- }
- if ($installed) {
- Write-Note 'installed companion-kit'
- } else {
- Write-Note 'could not install automatically - inside Claude Code run:'
- Write-Note "/plugin install companion-kit --marketplace $Repo"
- }
- Write-Step '3/5 Coding rules'
- $UserRules = Join-Path $ClaudeDir 'CLAUDE.md'
- if ($env:KIT_RULES -eq '0') {
- Write-Note 'skipped (KIT_RULES=0)'
- } elseif ((Test-Path $UserRules) -and (Select-String -Path $UserRules -SimpleMatch $ImportLine -Quiet)) {
- Write-Note "already imported in $UserRules"
- } else {
- Add-Content -Path $UserRules -Value "`n$ImportLine" -Encoding utf8
- Write-Note "imported into $UserRules (your own rules are untouched)"
- }
- Write-Step '4/5 Fullscreen view (the pane sits beside the chat there)'
- if (Get-Command node -ErrorAction SilentlyContinue) {
- Write-Note (node (Join-Path $KitDir 'scripts/set-fullscreen.mjs') (Join-Path $ClaudeDir 'settings.json'))
- } else {
- Write-Note "node not found - add `"tui`": `"fullscreen`" to $(Join-Path $ClaudeDir 'settings.json')"
- }
- Write-Step '5/5 Focus output style (optional)'
- if ($env:KIT_STYLE -eq '0') {
- Write-Note 'skipped (KIT_STYLE=0)'
- } else {
- $StyleDir = Join-Path $ClaudeDir 'output-styles'
- New-Item -ItemType Directory -Force $StyleDir | Out-Null
- $Style = Join-Path $StyleDir 'focus.md'
- if (Test-Path $Style) {
- Write-Note 'focus.md already exists - left as is'
- } else {
- Copy-Item (Join-Path $KitDir 'config/output-styles/focus.md') $Style
- Write-Note 'added - turn it on with /output-style focus'
- }
- }
- Write-Host ''
- Write-Host 'Done. Start Claude Code in a wide terminal (110+ columns) and the companion pane opens on your first prompt.'
- Write-Host 'Open it any time with /companion.'
install.sh · Bundled script · 76 lines · 1 finding marked
- #!/usr/bin/env sh
- # claude-companion installer for macOS and Linux.
- # Safe to run again: it updates what it installed and never overwrites your own files.
- #
- # curl -fsSL https://raw.githubusercontent.com/MelvinEdlund/claude-companion/main/install.sh | sh
- Note: Pipes a downloaded script directly into a shell (curl | sh / wget | bash)
- Line 5 on GitHub
- #
- # Options (environment variables):
- # KIT_RULES=0 skip adding the coding rules to ~/.claude/CLAUDE.md
- # KIT_STYLE=0 skip the optional Focus output style
- set -eu
- REPO="MelvinEdlund/claude-companion"
- CLAUDE_DIR="${CLAUDE_CONFIG_DIR:-$HOME/.claude}"
- KIT_DIR="$CLAUDE_DIR/claude-companion"
- IMPORT_LINE="@$KIT_DIR/config/CLAUDE.md"
- say() { printf ' %s\n' "$1"; }
- step() { printf '\n\033[1m%s\033[0m\n' "$1"; }
- command -v claude >/dev/null 2>&1 || {
- echo "Claude Code is not installed. Get it first: https://docs.claude.com/claude-code"
- exit 1
- }
- command -v git >/dev/null 2>&1 || { echo "git is required."; exit 1; }
- mkdir -p "$CLAUDE_DIR"
- step "1/5 Kit files"
- if [ -d "$KIT_DIR/.git" ]; then
- git -C "$KIT_DIR" pull --ff-only --quiet && say "updated $KIT_DIR"
- else
- git clone --quiet --depth 1 "https://github.com/$REPO.git" "$KIT_DIR" && say "cloned to $KIT_DIR"
- fi
- step "2/5 Plugin (companion pane, games, skills)"
- claude plugin marketplace add "$REPO" >/dev/null 2>&1 || true
- if claude plugin install companion-kit@companion-kit >/dev/null 2>&1 \
- || claude plugin install companion-kit --marketplace "$REPO" >/dev/null 2>&1; then
- say "installed companion-kit"
- else
- say "could not install automatically - inside Claude Code run:"
- say "/plugin install companion-kit --marketplace $REPO"
- fi
- step "3/5 Coding rules"
- if [ "${KIT_RULES:-1}" = "0" ]; then
- say "skipped (KIT_RULES=0)"
- elif [ -f "$CLAUDE_DIR/CLAUDE.md" ] && grep -qF "$IMPORT_LINE" "$CLAUDE_DIR/CLAUDE.md"; then
- say "already imported in $CLAUDE_DIR/CLAUDE.md"
- else
- printf '\n%s\n' "$IMPORT_LINE" >> "$CLAUDE_DIR/CLAUDE.md"
- say "imported into $CLAUDE_DIR/CLAUDE.md (your own rules are untouched)"
- fi
- step "4/5 Fullscreen view (the pane sits beside the chat there)"
- if command -v node >/dev/null 2>&1; then
- say "$(node "$KIT_DIR/scripts/set-fullscreen.mjs" "$CLAUDE_DIR/settings.json")"
- else
- say "node not found - add \"tui\": \"fullscreen\" to $CLAUDE_DIR/settings.json"
- fi
- step "5/5 Focus output style (optional)"
- if [ "${KIT_STYLE:-1}" = "0" ]; then
- say "skipped (KIT_STYLE=0)"
- else
- mkdir -p "$CLAUDE_DIR/output-styles"
- if [ -e "$CLAUDE_DIR/output-styles/focus.md" ]; then
- say "focus.md already exists - left as is"
- else
- cp "$KIT_DIR/config/output-styles/focus.md" "$CLAUDE_DIR/output-styles/focus.md"
- say "added - turn it on with /output-style focus"
- fi
- fi
- printf '\n\033[1mDone.\033[0m Start Claude Code in a wide terminal (110+ columns) and the companion pane opens on your first prompt.\n'
- printf 'Open it any time with /companion.\n'
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.