groove-utilities-onboard — Claude Code skill: GROOVE.md guide
Writes a GROOVE.md at the project root so a new contributor knows which commands to run and where logs live. Handy when someone joins a groove project.
npx skills add andreadellacorte/groove --skill groove-utilities-onboard -a claude-codeWhat groove-utilities-onboard does
The skill reads .groove/index.md and pulls live values from it: tasks.backend, memory.review_days and the git.* settings. Memory and specs paths are substituted as .groove/memory/ and .groove/memory/specs/. Then it asks whether you want project-specific context added — which tasks to pick up, team conventions. Press enter and that step is skipped.
The result is a GROOVE.md with quick start, daily workflow, compound loop and a config table. If the project has a CONTRIBUTING.md without the <!-- groove:onboard --> marker, the skill appends a "Using groove" section linking back to the guide. It will not create CONTRIBUTING.md from scratch.
When GROOVE.md already exists, the skill asks first: overwrite, update or skip. The <custom-context> block gets your text or is dropped if you gave none. The file is meant to be short — a couple of minutes of reading.
What it helps with
- tell a new contributor which groove commands to run each day
- collect log, memory and spec paths for the project in one file
- fill the template with real config values instead of placeholders
- append a groove section to an existing
CONTRIBUTING.mdwithout editing by hand - avoid overwriting a finished
GROOVE.mdby accident
Example prompts for the agent
- generate GROOVE.md for this project
- write the groove onboarding guide and add a section to CONTRIBUTING.md
- update GROOVE.md to match the current config
How to install groove-utilities-onboard
1Skills CLI (Vercel)
npx skills add andreadellacorte/groove --skill groove-utilities-onboard -a claude-code2Manually: put the files in place
~/.claude/skills/groove-utilities-onboard/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/groove-utilities-onboard/
1Skills CLI (Vercel)
npx skills add andreadellacorte/groove --skill groove-utilities-onboard -a codex2Manually: put the files in place
.agents/skills/groove-utilities-onboard/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add andreadellacorte/groove --skill groove-utilities-onboard -a cursor2Manually: put the files in place
.cursor/skills/groove-utilities-onboard/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install andreadellacorte/groove groove-utilities-onboard2Manually: put the files in place
.github/skills/groove-utilities-onboard/SKILL.md1Skills CLI (Vercel)
npx skills add andreadellacorte/groove --skill groove-utilities-onboard -a gemini-cli2Platform CLI
gemini skills install https://github.com/andreadellacorte/groove --path skills/groove-utilities-onboardManually: put the files in place
.devin/skills/groove-utilities-onboard/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add andreadellacorte/groove --skill groove-utilities-onboard -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about groove-utilities-onboard
How do I install groove-utilities-onboard in Claude?
Run npx skills add andreadellacorte/groove --skill groove-utilities-onboard -a claude-code. The skill then lands in ~/.claude/skills/groove-utilities-onboard/SKILL.md.
What does groove-utilities-onboard do?
It creates GROOVE.md at the project root with commands, log paths and compound loop conventions. If CONTRIBUTING.md exists, it appends a section linking to the guide.
What does the skill need to work?
A .groove/index.md file with your settings, since the config table is built from it. If GROOVE.md is already there, the skill asks what to do with it.
Source text
SKILL.md · MIT
---
name: groove-utilities-onboard
description: "Generate a GROOVE.md onboarding guide for contributors to a groove-enabled project. Explains the compound loop, commands, and conventions."
license: MIT
allowed-tools: Read Write Edit Glob AskUserQuestion
metadata:
author: andreadellacorte
---
# groove-utilities-onboard
Generate a `GROOVE.md` file at the project root — a concise onboarding guide for contributors joining a project that uses groove. Also optionally appends a groove section to `CONTRIBUTING.md` if it exists.
## Outcome
New contributors understand how groove works in this project: which commands to run, where logs live, and what the compound loop expects of them.
## Acceptance Criteria
- `GROOVE.md` exists at the project root with project-specific config values substituted
- If `CONTRIBUTING.md` exists, it contains a "## Using groove" section linking to `GROOVE.md`
- Content reflects actual configured values (task backend, git strategy)
## Steps
1. Read `tasks.backend`, `memory.review_days`, `git.*` from `.groove/index.md`; memory is always `.groove/memory/`, specs is always `.groove/memory/specs/`
2. Ask: "Any project-specific context to include? (e.g. which tasks to pick up, team conventions) — enter to skip"
3. Write `GROOVE.md` from the template below, substituting live config values
4. If `CONTRIBUTING.md` exists and does not already contain `<!-- groove:onboard -->`:
- Append the following section:
```markdown
<!-- groove:onboard -->
## Using groove
This project uses [groove](https://github.com/andreadellacorte/groove) for AI-assisted engineering workflow. See [GROOVE.md](./GROOVE.md) for setup and commands.
<!-- groove:onboard:end -->
```
5. Report: "GROOVE.md written" and whether CONTRIBUTING.md was updated
## GROOVE.md template
```markdown
# Groove Workflow
This project uses [groove](https://github.com/andreadellacorte/groove) — an AI-assisted engineering workflow companion.
## Quick start
```bash
npx skills add andreadellacorte/groove
/groove-admin-install
```
Then start every session with:
```
/groove-utilities-prime
```
## Daily workflow
```
/groove-daily-start — review yesterday, load tasks, set agenda
/groove-daily-end — write memory, commit logs
```
## Compound loop (for any feature or fix)
```
/groove-work-brainstorm — clarify scope
/groove-work-plan — research and plan
/groove-work-exec — implement
/groove-work-review — evaluate output
/groove-work-compound — capture lessons
```
## Config
| Key | Value |
|---|---|
| Task backend | `<tasks.backend>` |
| Memory path | `.groove/memory/` |
| Specs path | `.groove/memory/specs/` |
| Git strategy (memory) | `<git.memory>` |
## Conventions
- Stage tasks are named `YYYY-MM-DD, <Stage>` — no numbers
- Task completion requires a "Summary of Changes" in the task body before marking done
- Archive is always user-triggered — never automatic
## Where things live
- **Config**: `.groove/index.md`
- **Daily logs**: `.groove/memory/daily/`
- **Learned insights**: `.groove/memory/learned/`
- **Specs**: `.groove/memory/specs/`
- **Hooks**: `.groove/hooks/` (start.md, end.md)
<custom-context>
</custom-context>
```
## Constraints
- Read `.groove/index.md` and substitute all placeholder values before writing
- If `GROOVE.md` already exists: ask "GROOVE.md exists — overwrite, update, or skip?" before touching it
- The `<custom-context>` block is replaced with user-provided context or removed if none
- Do not create `CONTRIBUTING.md` if it doesn't exist — only append to existing files
- `GROOVE.md` should be short enough to read in 2 minutes
© andreadellacorte · MIT · andreadellacorte/groove