@3lineas/grooveskills 1.3.1 β 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/README.md +33 -32
- package/dist/{chunk-M7ZPBGQE.js β chunk-PLMYUKGW.js} +445 -193
- package/dist/chunk-PLMYUKGW.js.map +1 -0
- package/dist/cli.js +6 -4
- package/dist/cli.js.map +1 -1
- package/dist/main.d.ts +1 -0
- package/dist/main.js +1 -1
- package/package.json +1 -1
- package/skills/groove-harness/SKILL.md +1 -0
- package/dist/chunk-M7ZPBGQE.js.map +0 -1
package/README.md
CHANGED
|
@@ -22,26 +22,26 @@ AI coding assistants perform at their highest potential when they share your tea
|
|
|
22
22
|
|
|
23
23
|
| Layer | Purpose | Key Benefit |
|
|
24
24
|
| :--- | :--- | :--- |
|
|
25
|
-
| **1.
|
|
26
|
-
| **2.
|
|
25
|
+
| **1. Core Project Harness (`.grooveskills/`)** | Built-in project onboarding, persistent memory, and an Organic & Outcome-Driven (ODD) 3-lane workflow installed automatically. | Every session starts oriented on your stack, real scripts, ADR records, outcome hypotheses, and verified checklists. |
|
|
26
|
+
| **2. Curated Architectural Skills** | Battle-tested engineering standards covering Clean Code, TypeScript 5.5+, Rust, Python, Valibot, Hono RPC, React 19, Vitest, and UX Writing. | Your AI assistant writes clean, modular, strictly typed code matching your team's conventions. |
|
|
27
27
|
|
|
28
28
|
---
|
|
29
29
|
|
|
30
30
|
## π― How It Works
|
|
31
31
|
|
|
32
|
-
### 1.
|
|
33
|
-
GrooveSkills
|
|
32
|
+
### 1. Automatic Project Onboarding & Persistent Memory (`.grooveskills/memory/`)
|
|
33
|
+
The **GrooveSkills Harness** is installed automatically as the foundation of your projectβnever an optional checkbox:
|
|
34
|
+
- **First-Time Setup (Automatic Onboarding)**: Scans your repository (package manager, real `package.json` scripts, `tsconfig.json` path aliases, and `src/` modules), asks for your preferred communication language, and populates `.grooveskills/memory/context.md`, `decisions.md`, `tasks/00-onboarding.md`, `AGENTS.md`, and `CLAUDE.md`.
|
|
35
|
+
- **Subsequent Runs (Smart Skill Updates)**: Detects your existing harness, preserves your memory and language settings untouched, and **only updates the skills you select**.
|
|
36
|
+
- **Re-Onboarding on Demand (`init`)**: Run `npx @3lineas/grooveskills init` anytime to re-scan your project stack and refresh the onboarding context.
|
|
37
|
+
|
|
38
|
+
### 2. Smart Stack Detection & Lightweight Agent References
|
|
39
|
+
GrooveSkills inspects your project manifests (`package.json`, `Cargo.toml`, `pyproject.toml`) to pre-select recommended skills. All canonical skill files live in `.grooveskills/skills/<skill>/`, while agent folders receive **lightweight reference files** (~13 lines) that preserve trigger metadata without duplicating trees in your IDE:
|
|
34
40
|
- **Antigravity**: `.agents/skills/<skill>/SKILL.md`
|
|
35
41
|
- **Claude Code**: `.claude/skills/<skill>/SKILL.md`
|
|
36
42
|
- **Gemini Code Assist**: `.gemini/skills/<skill>/SKILL.md`
|
|
37
43
|
- **Cursor IDE**: `.cursor/rules/<skill>.mdc`
|
|
38
44
|
|
|
39
|
-
### 2. Persistent Project Memory (`.grooveskills/memory/`)
|
|
40
|
-
Enabling the harness creates an encapsulated knowledge plane and configures `AGENTS.md` and `CLAUDE.md`:
|
|
41
|
-
- **`context.md`**: Summarizes your stack, conventions, and essential commands.
|
|
42
|
-
- **`decisions.md`**: An append-only Architecture Decision Record (ADR) log.
|
|
43
|
-
- **`tasks/<slug>.md`**: Feature records tracking outcome hypotheses and verification receipts.
|
|
44
|
-
|
|
45
45
|
### 3. Organic & Outcome-Driven Development (ODD) & 3-Lane Workflow
|
|
46
46
|
Through the built-in `odd-ai` and `groove-harness` skills, GrooveSkills guides your AI assistant with a hybrid **Organic & Outcome-Driven Development (ODD)** methodology:
|
|
47
47
|
- **Organic Adaptability**: Exploration, documentation, and planning scale proportionally to the complexity of each requestβkeeping minor tweaks nimble while giving major features solid structure.
|
|
@@ -64,39 +64,40 @@ Through the built-in `odd-ai` and `groove-harness` skills, GrooveSkills guides y
|
|
|
64
64
|
| **Lane 3 β Spec** | High-impact or multi-domain architectural changes. | **Collaborative design.** Drafts a specification and Outcome Hypothesis in `memory/tasks/<slug>.md` and aligns with you before writing implementation code. |
|
|
65
65
|
|
|
66
66
|
### 4. Multilingual, Empathetic UX Communication
|
|
67
|
-
Select your preferred language (**EspaΓ±ol, English, PortuguΓͺs, Italiano, or FranΓ§ais**) during
|
|
68
|
-
|
|
69
|
-
### 5. Clean & 100% Portable Repository Layout
|
|
70
|
-
All assets reside in `.grooveskills/` and connect to agent directories via **relative symlinks** (`../../.grooveskills/...`), making the environment instantly portable upon `git clone`.
|
|
67
|
+
Select your preferred language (**EspaΓ±ol, English, PortuguΓͺs, Italiano, or FranΓ§ais**) during onboarding so every validation message, toast, and agent interaction remains warm, persuasive, and professional.
|
|
71
68
|
|
|
72
69
|
---
|
|
73
70
|
|
|
74
71
|
## π Quick Start
|
|
75
72
|
|
|
76
|
-
### Interactive Wizard (
|
|
73
|
+
### Interactive Wizard (Install or Update Skills)
|
|
77
74
|
```bash
|
|
78
75
|
npx @3lineas/grooveskills
|
|
79
76
|
```
|
|
80
77
|
|
|
78
|
+
### Force Full Project Re-Onboarding (`init`)
|
|
79
|
+
```bash
|
|
80
|
+
npx @3lineas/grooveskills init
|
|
81
|
+
```
|
|
82
|
+
|
|
81
83
|
### Non-Interactive Mode (CI & Scripting)
|
|
82
84
|
```bash
|
|
83
85
|
# Install skills and initialize harness in Spanish for Claude and Antigravity
|
|
84
|
-
npx @3lineas/grooveskills --skills odd-ai best-practices hono --agents antigravity claude
|
|
86
|
+
npx @3lineas/grooveskills --skills odd-ai best-practices hono --agents antigravity claude -l es -y
|
|
85
87
|
|
|
86
|
-
#
|
|
87
|
-
npx @3lineas/grooveskills
|
|
88
|
+
# Re-run full project onboarding non-interactively across all AI assistants
|
|
89
|
+
npx @3lineas/grooveskills init --agents antigravity claude cursor gemini -l es -y
|
|
88
90
|
```
|
|
89
91
|
|
|
90
92
|
### CLI Options Reference
|
|
91
93
|
|
|
92
|
-
| Flag | Description | Example |
|
|
94
|
+
| Command / Flag | Description | Example |
|
|
93
95
|
| :--- | :--- | :--- |
|
|
96
|
+
| `init` | Force re-run of project onboarding, stack scan & memory context | `npx @3lineas/grooveskills init` |
|
|
94
97
|
| `-s, --skills <skills...>` | Space-separated list of skill IDs to install | `--skills odd-ai best-practices` |
|
|
95
98
|
| `-a, --agents <agents...>` | Target AI assistants (`antigravity`, `claude`, `cursor`, `gemini`) | `--agents antigravity cursor` |
|
|
96
|
-
| `--harness` | Initialize or update the GrooveSkills Harness in `.grooveskills/` | `--harness` |
|
|
97
|
-
| `--no-harness` | Install selected skills without initializing the project harness | `--no-harness` |
|
|
98
99
|
| `-l, --language <lang>` | Set the language for user-facing copy (`es`, `en`, `pt`, `it`, `fr`) | `-l es` |
|
|
99
|
-
| `-y, --yes` | Automatically confirm updating existing
|
|
100
|
+
| `-y, --yes` | Automatically confirm updating existing skills | `-y` |
|
|
100
101
|
|
|
101
102
|
---
|
|
102
103
|
|
|
@@ -106,15 +107,15 @@ npx @3lineas/grooveskills --harness --agents antigravity claude cursor gemini -l
|
|
|
106
107
|
my-project/
|
|
107
108
|
βββ .grooveskills/
|
|
108
109
|
β βββ config.json # Manifest of active skills, agents, language & harness state
|
|
109
|
-
β βββ skills/ #
|
|
110
|
-
β
|
|
111
|
-
β
|
|
112
|
-
β βββ context.md # Stack overview, conventions & essential commands
|
|
110
|
+
β βββ skills/ # Canonical single source of truth for installed skills
|
|
111
|
+
β βββ memory/ # Persistent project memory (Core Harness control plane)
|
|
112
|
+
β βββ context.md # Auto-scanned stack, scripts, aliases & architecture map
|
|
113
113
|
β βββ decisions.md # Architecture Decision Records (ADR)
|
|
114
|
-
β βββ tasks/ #
|
|
115
|
-
βββ .agents/skills
|
|
116
|
-
βββ .claude/skills
|
|
117
|
-
βββ .
|
|
114
|
+
β βββ tasks/ # 00-onboarding.md & tasks with Outcome Hypotheses
|
|
115
|
+
βββ .agents/skills/<skill>/SKILL.md # Lightweight reference pointer -> .grooveskills/skills/<skill>/SKILL.md
|
|
116
|
+
βββ .claude/skills/<skill>/SKILL.md # Lightweight reference pointer -> .grooveskills/skills/<skill>/SKILL.md
|
|
117
|
+
βββ .gemini/skills/<skill>/SKILL.md # Lightweight reference pointer -> .grooveskills/skills/<skill>/SKILL.md
|
|
118
|
+
βββ .cursor/rules/<skill>.mdc # Lightweight reference rule -> .grooveskills/skills/<skill>/SKILL.md
|
|
118
119
|
βββ AGENTS.md / CLAUDE.md # Concise harness pointer <!-- grooveskills:harness -->
|
|
119
120
|
```
|
|
120
121
|
|
|
@@ -124,8 +125,8 @@ my-project/
|
|
|
124
125
|
|
|
125
126
|
| Skill ID | Name | Architectural Focus | Auto-Selection Rule |
|
|
126
127
|
| :--- | :--- | :--- | :--- |
|
|
127
|
-
| `groove-harness` | **GrooveSkills Harness** | ODD 3-lane workflow (Answer, Task, Spec), ADR logging, and
|
|
128
|
-
| `odd-ai` | **Organic & Outcome-Driven (ODD)** | 7-step ODD protocol for AI agents: authorize, explore, classify, outcome hypotheses, and evidence receipts. |
|
|
128
|
+
| `groove-harness` | **GrooveSkills Harness** | ODD 3-lane workflow (Answer, Task, Spec), onboarding protocol, ADR logging, and `.grooveskills/memory/`. | **Core Harness (Always Installed)** |
|
|
129
|
+
| `odd-ai` | **Organic & Outcome-Driven (ODD)** | 7-step ODD protocol for AI agents: authorize, explore, classify, outcome hypotheses, and evidence receipts. | **Default (Universal)** |
|
|
129
130
|
| `best-practices` | **Universal Best Practices** | Multi-language clean code, strict typing (zero `any`), guard clauses, and `<200` lines per file. | **Default (Universal)** |
|
|
130
131
|
| `ux-writing` | **UX Writing & Microcopy** | Warm, empathetic, conversion-oriented microcopy for validations, CTAs, toasts, and empty states. | **Default (Universal)** |
|
|
131
132
|
| `error-handling-logging` | **Error Handling & Logging** | Predictable error flows with typed `AppError`, `ActionResponse` contracts, and structured logging. | **Default (Universal)** |
|