Skip to content
Back to search

companion-kit

MarketplaceWorks with Claude CodeGitHub

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.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/melvinedlund--claude-companion/badge.svg)](/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
  1. {
  2. "name": "companion-kit",
  3. "description": "claude-companion: a calm companion pane for Claude Code, with everyday skills.",
  4. "owner": { "name": "MelvinEdlund" },
  5. "plugins": [{ "name": "companion-kit", "source": "./" }]
  6. }
README.md · README · 211 lines · 2 findings marked
  1. <div align="center">
  2. <img src=".claude-plugin/icon.png" width="96" height="96" alt="">
  3. # claude-companion
  4. **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.
  5. Also included: everyday skills, a set of coding rules, and an output style for staying focused.
  6. [![MIT License](https://img.shields.io/badge/license-MIT-D97757?style=flat-square)](LICENSE)
  7. [![Claude Code plugin](https://img.shields.io/badge/Claude%20Code-plugin-D97757?style=flat-square)](https://docs.claude.com/claude-code)
  8. [![Tests](https://img.shields.io/badge/tests-28%20passing-7CC38A?style=flat-square)](hooks/companion.test.tsx)
  9. <br>
  10. <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%">
  11. </div>
  12. <br>
  13. ## Install
  14. **macOS / Linux**
  15. ```sh
  16. 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
  17. ```
  18. **Windows (PowerShell)**
  19. ```powershell
  20. irm https://raw.githubusercontent.com/MelvinEdlund/claude-companion/main/install.ps1 | iex
  21. ```
  22. **Plugin only**, from inside Claude Code:
  23. ```
  24. /plugin install companion-kit --marketplace MelvinEdlund/claude-companion
  25. ```
  26. 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`.
  27. <br>
  28. ## Why
  29. 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.
  30. claude-companion gives that waiting time a place to rest:
  31. - A narrow pane shows what is happening.
  32. - It shows what changed and who is working on it.
  33. - A small game sits below it, in case your hands need something to do.
  34. 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.
  35. <br>
  36. ## What's in the kit
  37. | | |
  38. | --- | --- |
  39. | 🦀 **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. |
  40. | 🧑‍🤝‍🧑 **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. |
  41. | 🏀 **Two small games** | Hoops and darts, picked at random each session. Skill-based, no timers, best scores kept. |
  42. | 💬 **Next-step tips** | When an answer ends with `Next step: /something`, Claude shows that command in a speech bubble. |
  43. | 📈 **Levels from real work** | Tokens Claude spends level it up; helpers level from their own work. A new ball arrives every 100k tokens. |
  44. | 🛠️ **Skills** | `/commit`, `/pr-check` and `/spec`: safe commits, a pre-flight check before a pull request, and a spec before you build. |
  45. | 📏 **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. |
  46. | 🎯 **Focus output style** | Optional. Answers put the next action first, use numbered steps and visible wins, and end with one next step. |
  47. <br>
  48. ## The games
  49. <table>
  50. <tr>
  51. <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>
  52. <td width="50%"><img src="assets/darts.svg" alt="Darts: a dart hits the bullseye for 25 and Claude cheers"></td>
  53. </tr>
  54. <tr>
  55. <td>
  56. **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.
  57. </td>
  58. <td>
  59. **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.
  60. </td>
  61. </tr>
  62. </table>
  63. 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`.
  64. <div align="center">
  65. <img src="assets/tip.svg" alt="The playground with Claude saying next: /commit in a speech bubble" width="50%">
  66. </div>
  67. <br>
  68. ## Meet the helpers
  69. 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.
  70. | Agent type | Name | Role | Look |
  71. | --- | --- | --- | --- |
  72. | `Explore` | Hugh | Scout | deerstalker |
  73. | `Plan` | Mungus | Planner | top hat |
  74. | `general-purpose` | Al | Helper | none |
  75. | `explorer` | Phil | Explorer | safari hat |
  76. | `implementer` | Mike | Builder | hard hat |
  77. | `test-writer` | Oxlong | Tester | cap |
  78. | `code-reviewer` | Ben | Reviewer | glasses |
  79. | `security-reviewer` | Dover | Security | helmet |
  80. | `ui-reviewer` | Anita | Designer | beret |
  81. Helpers keep their levels from one session to the next.
  82. <br>
  83. ## Commands and skills
  84. | Command | What it does |
  85. | --- | --- |
  86. | `/companion` | Opens the companion pane. Press Esc to return to the prompt. |
  87. | `/game` | Switches between hoops and darts. |
  88. | `/commit` | Commits and pushes safely. It never commits on `main` and never force-pushes or skips hooks. |
  89. | `/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. |
  90. | `/spec` | Writes the goal, testable acceptance criteria and exact changes before any code. Unclear points become questions to you. |
  91. 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.
  92. <br>
  93. ## What the installer does
  94. The installer is safe to run again. It updates what it installed and **never overwrites your own files.**
  95. 1. It clones the kit to `~/.claude/claude-companion`, or updates an existing copy.
  96. 2. It installs the plugin through Claude Code's plugin marketplace.
  97. 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.
  98. 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.
  99. 5. It copies the [Focus output style](config/output-styles/focus.md) to `~/.claude/output-styles/`. Turn it on with `/output-style focus`.
  100. To skip a step, set its variable when you run the installer:
  101. ```sh
  102. KIT_RULES=0 KIT_STYLE=0 sh install.sh # plugin and fullscreen view only
  103. ```
  104. <br>
  105. ## Design principles
  106. - **Calm over clever.** Motion is slow and small. The pane is something you glance at, not something to watch.
  107. - **Useful first, fun second.** The game sits below the information, never on top of it.
  108. - **No pressure.** No streaks to protect, no daily goals, nothing you can lose by stepping away.
  109. - **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.
  110. <br>
  111. ## FAQ
  112. <details>
  113. <summary><b>The pane doesn't show up.</b></summary>
  114. 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.
  115. </details>
  116. <details>
  117. <summary><b>Does it slow Claude down?</b></summary>
  118. 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.
  119. </details>
  120. <details>
  121. <summary><b>Can I use only the pane, and not the rules or the output style?</b></summary>
  122. Yes. Use the plugin-only install line above, or set `KIT_RULES=0 KIT_STYLE=0` when you run the installer.
  123. </details>
  124. <details>
  125. <summary><b>How do levels work?</b></summary>
  126. 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.
  127. </details>
  128. <br>
  129. ## Uninstall
  130. ```sh
  131. claude plugin uninstall companion-kit
  132. ```
  133. 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`.
  134. <br>
  135. ## Credits
  136. - The Focus output style is adapted from [ayghri/i-have-adhd](https://github.com/ayghri/i-have-adhd) (MIT).
  137. - claude-companion is a community project. It is not affiliated with or endorsed by Anthropic.
  138. ## License
  139. [MIT](LICENSE) © MelvinEdlund
install.ps1 · Bundled script · 88 lines · 1 finding marked
  1. # claude-companion installer for Windows (PowerShell 5.1+).
  2. # Safe to run again: it updates what it installed and never overwrites your own files.
  3. #
  4. # 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
  5. #
  6. # Options (environment variables):
  7. # $env:KIT_RULES = '0' skip adding the coding rules to ~/.claude/CLAUDE.md
  8. # $env:KIT_STYLE = '0' skip the optional Focus output style
  9. $ErrorActionPreference = 'Stop'
  10. $Repo = 'MelvinEdlund/claude-companion'
  11. $ClaudeDir = if ($env:CLAUDE_CONFIG_DIR) { $env:CLAUDE_CONFIG_DIR } else { Join-Path $HOME '.claude' }
  12. $KitDir = Join-Path $ClaudeDir 'claude-companion'
  13. $ImportLine = '@' + ((Join-Path $KitDir 'config/CLAUDE.md') -replace '\\', '/')
  14. function Write-Note($text) { Write-Host " $text" }
  15. function Write-Step($text) { Write-Host ''; Write-Host $text -ForegroundColor White }
  16. if (-not (Get-Command claude -ErrorAction SilentlyContinue)) {
  17. Write-Host 'Claude Code is not installed. Get it first: https://docs.claude.com/claude-code'
  18. return
  19. }
  20. if (-not (Get-Command git -ErrorAction SilentlyContinue)) {
  21. Write-Host 'git is required.'
  22. return
  23. }
  24. New-Item -ItemType Directory -Force $ClaudeDir | Out-Null
  25. Write-Step '1/5 Kit files'
  26. if (Test-Path (Join-Path $KitDir '.git')) {
  27. git -C $KitDir pull --ff-only --quiet
  28. Write-Note "updated $KitDir"
  29. } else {
  30. git clone --quiet --depth 1 "https://github.com/$Repo.git" $KitDir
  31. Write-Note "cloned to $KitDir"
  32. }
  33. Write-Step '2/5 Plugin (companion pane, games, skills)'
  34. try { claude plugin marketplace add $Repo *> $null } catch {}
  35. $installed = $false
  36. try { claude plugin install 'companion-kit@companion-kit' *> $null; $installed = $LASTEXITCODE -eq 0 } catch {}
  37. if (-not $installed) {
  38. try { claude plugin install companion-kit --marketplace $Repo *> $null; $installed = $LASTEXITCODE -eq 0 } catch {}
  39. }
  40. if ($installed) {
  41. Write-Note 'installed companion-kit'
  42. } else {
  43. Write-Note 'could not install automatically - inside Claude Code run:'
  44. Write-Note "/plugin install companion-kit --marketplace $Repo"
  45. }
  46. Write-Step '3/5 Coding rules'
  47. $UserRules = Join-Path $ClaudeDir 'CLAUDE.md'
  48. if ($env:KIT_RULES -eq '0') {
  49. Write-Note 'skipped (KIT_RULES=0)'
  50. } elseif ((Test-Path $UserRules) -and (Select-String -Path $UserRules -SimpleMatch $ImportLine -Quiet)) {
  51. Write-Note "already imported in $UserRules"
  52. } else {
  53. Add-Content -Path $UserRules -Value "`n$ImportLine" -Encoding utf8
  54. Write-Note "imported into $UserRules (your own rules are untouched)"
  55. }
  56. Write-Step '4/5 Fullscreen view (the pane sits beside the chat there)'
  57. if (Get-Command node -ErrorAction SilentlyContinue) {
  58. Write-Note (node (Join-Path $KitDir 'scripts/set-fullscreen.mjs') (Join-Path $ClaudeDir 'settings.json'))
  59. } else {
  60. Write-Note "node not found - add `"tui`": `"fullscreen`" to $(Join-Path $ClaudeDir 'settings.json')"
  61. }
  62. Write-Step '5/5 Focus output style (optional)'
  63. if ($env:KIT_STYLE -eq '0') {
  64. Write-Note 'skipped (KIT_STYLE=0)'
  65. } else {
  66. $StyleDir = Join-Path $ClaudeDir 'output-styles'
  67. New-Item -ItemType Directory -Force $StyleDir | Out-Null
  68. $Style = Join-Path $StyleDir 'focus.md'
  69. if (Test-Path $Style) {
  70. Write-Note 'focus.md already exists - left as is'
  71. } else {
  72. Copy-Item (Join-Path $KitDir 'config/output-styles/focus.md') $Style
  73. Write-Note 'added - turn it on with /output-style focus'
  74. }
  75. }
  76. Write-Host ''
  77. Write-Host 'Done. Start Claude Code in a wide terminal (110+ columns) and the companion pane opens on your first prompt.'
  78. Write-Host 'Open it any time with /companion.'
install.sh · Bundled script · 76 lines · 1 finding marked
  1. #!/usr/bin/env sh
  2. # claude-companion installer for macOS and Linux.
  3. # Safe to run again: it updates what it installed and never overwrites your own files.
  4. #
  5. # 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
  6. #
  7. # Options (environment variables):
  8. # KIT_RULES=0 skip adding the coding rules to ~/.claude/CLAUDE.md
  9. # KIT_STYLE=0 skip the optional Focus output style
  10. set -eu
  11. REPO="MelvinEdlund/claude-companion"
  12. CLAUDE_DIR="${CLAUDE_CONFIG_DIR:-$HOME/.claude}"
  13. KIT_DIR="$CLAUDE_DIR/claude-companion"
  14. IMPORT_LINE="@$KIT_DIR/config/CLAUDE.md"
  15. say() { printf ' %s\n' "$1"; }
  16. step() { printf '\n\033[1m%s\033[0m\n' "$1"; }
  17. command -v claude >/dev/null 2>&1 || {
  18. echo "Claude Code is not installed. Get it first: https://docs.claude.com/claude-code"
  19. exit 1
  20. }
  21. command -v git >/dev/null 2>&1 || { echo "git is required."; exit 1; }
  22. mkdir -p "$CLAUDE_DIR"
  23. step "1/5 Kit files"
  24. if [ -d "$KIT_DIR/.git" ]; then
  25. git -C "$KIT_DIR" pull --ff-only --quiet && say "updated $KIT_DIR"
  26. else
  27. git clone --quiet --depth 1 "https://github.com/$REPO.git" "$KIT_DIR" && say "cloned to $KIT_DIR"
  28. fi
  29. step "2/5 Plugin (companion pane, games, skills)"
  30. claude plugin marketplace add "$REPO" >/dev/null 2>&1 || true
  31. if claude plugin install companion-kit@companion-kit >/dev/null 2>&1 \
  32. || claude plugin install companion-kit --marketplace "$REPO" >/dev/null 2>&1; then
  33. say "installed companion-kit"
  34. else
  35. say "could not install automatically - inside Claude Code run:"
  36. say "/plugin install companion-kit --marketplace $REPO"
  37. fi
  38. step "3/5 Coding rules"
  39. if [ "${KIT_RULES:-1}" = "0" ]; then
  40. say "skipped (KIT_RULES=0)"
  41. elif [ -f "$CLAUDE_DIR/CLAUDE.md" ] && grep -qF "$IMPORT_LINE" "$CLAUDE_DIR/CLAUDE.md"; then
  42. say "already imported in $CLAUDE_DIR/CLAUDE.md"
  43. else
  44. printf '\n%s\n' "$IMPORT_LINE" >> "$CLAUDE_DIR/CLAUDE.md"
  45. say "imported into $CLAUDE_DIR/CLAUDE.md (your own rules are untouched)"
  46. fi
  47. step "4/5 Fullscreen view (the pane sits beside the chat there)"
  48. if command -v node >/dev/null 2>&1; then
  49. say "$(node "$KIT_DIR/scripts/set-fullscreen.mjs" "$CLAUDE_DIR/settings.json")"
  50. else
  51. say "node not found - add \"tui\": \"fullscreen\" to $CLAUDE_DIR/settings.json"
  52. fi
  53. step "5/5 Focus output style (optional)"
  54. if [ "${KIT_STYLE:-1}" = "0" ]; then
  55. say "skipped (KIT_STYLE=0)"
  56. else
  57. mkdir -p "$CLAUDE_DIR/output-styles"
  58. if [ -e "$CLAUDE_DIR/output-styles/focus.md" ]; then
  59. say "focus.md already exists - left as is"
  60. else
  61. cp "$KIT_DIR/config/output-styles/focus.md" "$CLAUDE_DIR/output-styles/focus.md"
  62. say "added - turn it on with /output-style focus"
  63. fi
  64. fi
  65. 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'
  66. printf 'Open it any time with /companion.\n'

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.