@3lineas/grooveskills 1.4.0 → 1.6.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 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. Curated Architectural Skills** | Battle-tested engineering standards covering Clean Code, TypeScript 5.5+, Valibot, Hono RPC, React 19, Vitest, and UX Writing. | Your AI assistant writes clean, modular, strictly typed code matching your conventions. |
26
- | **2. Encapsulated Project Harness (`.grooveskills/`)** | Lightweight memory and an Organic & Outcome-Driven (ODD) 3-lane workflow stored inside your repository. | Every session starts oriented on your stack, ADR records, outcome hypotheses, and verified checklists. |
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. Smart Stack Detection & Multi-Agent Adaptation
33
- GrooveSkills inspects dependencies (`hono`, `react`, `valibot`, `typescript`, `vitest`, `rust`, `python`) and pre-selects recommended skills, linking them automatically:
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,36 +64,38 @@ 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 setup so every validation message, toast, and agent interaction remains warm, persuasive, and professional.
68
-
69
- ### 5. Clean & 100% Portable Repository Layout
70
- All canonical skills and project memory reside in `.grooveskills/`. Agent directories (`.agents/`, `.claude/`, `.gemini/`, `.cursor/`) contain **lightweight reference files** that preserve original trigger metadata and instruct each AI agent to consult the canonical specification in `.grooveskills/skills/<skill>/SKILL.md`.
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 (Recommended)
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
- # Install skills and configure harness in Spanish for Claude and Antigravity
85
+ # Install skills and initialize harness in Spanish for Claude and Antigravity
84
86
  npx @3lineas/grooveskills --skills odd-ai best-practices hono --agents antigravity claude -l es -y
85
87
 
86
- # Configure harness and skills across all supported AI assistants
87
- npx @3lineas/grooveskills --agents antigravity claude cursor gemini -l es -y
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 GrooveSkills project harness in `.grooveskills/` | `--harness` |
97
99
  | `-l, --language <lang>` | Set the language for user-facing copy (`es`, `en`, `pt`, `it`, `fr`) | `-l es` |
98
100
  | `-y, --yes` | Automatically confirm updating existing skills | `-y` |
99
101
 
@@ -106,10 +108,10 @@ my-project/
106
108
  ├── .grooveskills/
107
109
  │ ├── config.json # Manifest of active skills, agents, language & harness state
108
110
  │ ├── skills/ # Canonical single source of truth for installed skills
109
- │ └── memory/ # Persistent project memory (Harness control plane)
110
- │ ├── context.md # Stack overview, conventions & essential commands
111
+ │ └── memory/ # Persistent project memory (Core Harness control plane)
112
+ │ ├── context.md # Auto-scanned stack, scripts, aliases & architecture map
111
113
  │ ├── decisions.md # Architecture Decision Records (ADR)
112
- │ └── tasks/ # Tasks with Outcome Hypotheses & Evidence receipts
114
+ │ └── tasks/ # 00-onboarding.md & tasks with Outcome Hypotheses
113
115
  ├── .agents/skills/<skill>/SKILL.md # Lightweight reference pointer -> .grooveskills/skills/<skill>/SKILL.md
114
116
  ├── .claude/skills/<skill>/SKILL.md # Lightweight reference pointer -> .grooveskills/skills/<skill>/SKILL.md
115
117
  ├── .gemini/skills/<skill>/SKILL.md # Lightweight reference pointer -> .grooveskills/skills/<skill>/SKILL.md
@@ -123,12 +125,19 @@ my-project/
123
125
 
124
126
  | Skill ID | Name | Architectural Focus | Auto-Selection Rule |
125
127
  | :--- | :--- | :--- | :--- |
126
- | `groove-harness` | **GrooveSkills Harness** | ODD 3-lane workflow (Answer, Task, Spec), ADR logging, and task checklists in `.grooveskills/memory/`. | Included with `--harness` |
127
- | `odd-ai` | **Organic & Outcome-Driven (ODD)** | 7-step ODD protocol for AI agents: authorize, explore, classify, outcome hypotheses, and evidence receipts. | Included with `--harness` |
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)** |
128
130
  | `best-practices` | **Universal Best Practices** | Multi-language clean code, strict typing (zero `any`), guard clauses, and `<200` lines per file. | **Default (Universal)** |
129
131
  | `ux-writing` | **UX Writing & Microcopy** | Warm, empathetic, conversion-oriented microcopy for validations, CTAs, toasts, and empty states. | **Default (Universal)** |
130
132
  | `error-handling-logging` | **Error Handling & Logging** | Predictable error flows with typed `AppError`, `ActionResponse` contracts, and structured logging. | **Default (Universal)** |
131
133
  | `clean-architecture-ddd` | **Clean Architecture & DDD** | Domain-driven module boundaries, single-purpose Actions, pure functions, and immutable data models. | **Default (Universal)** |
134
+ | `external-service-adapters` | **External Service Adapters & Wrappers** | Decoupled domain ports, vendor SDK wrappers, and swappable adapters for payment gateways, emails, and APIs. | **Default (Universal)** |
135
+ | `storage-file-adapters` | **Storage & File Adapters (S3, R2, Supabase)** | Object storage ports, uploads, presigned URLs, and streaming without repository abstractions. | **Default (Universal)** |
136
+ | `auth-rbac-policies` | **Auth Adapters & RBAC/ABAC Policies** | Authentication adapter ports with `AuthenticatedActor` and side-effect-free pure authorization policies. | **Default (Universal)** |
137
+ | `controller-orchestration-queues` | **Controller Orchestration & Queues** | Atomic Actions, Controller sequence/transactions, and swappable background Queue adapters. | **Default (Universal)** |
138
+ | `webhook-idempotency` | **Webhook Verifiers & Idempotency** | Cryptographic HMAC webhook verifiers (Stripe, Svix, MercadoPago) and atomic idempotency guards. | **Default (Universal)** |
139
+ | `caching-rate-limiting` | **Cache-Aside & Rate Limiting** | Declarative `cache.remember` wrappers and sliding-window rate limiting adapters (Redis, KV, Memory). | **Default (Universal)** |
140
+ | `env-feature-flags` | **Fail-Fast Env & Feature Flags** | Boot-time fail-fast Valibot environment validation and decoupled feature flag adapters (PostHog, LD). | **Default (Universal)** |
132
141
  | `typescript-clean` | **TypeScript Clean Code (5.5+)** | Modern TypeScript (`satisfies`, discriminated unions, `const` generics, `unknown` narrowing). | `typescript` in `package.json` |
133
142
  | `rust-clean` | **Rust Clean Code (Rust 2024)** | Idiomatic Rust: `let-else` guard clauses, zero `.unwrap()`, `thiserror` typed errors, and Newtypes. | `Cargo.toml` in project root |
134
143
  | `python-clean` | **Python Clean Code (Python 3.12+)** | Modern Python: guard clauses (no nested ifs), strict typing (zero `Any`), uv, Ruff, and Pyright. | `pyproject.toml` / `requirements.txt` |