@3lineas/grooveskills 1.1.0 → 1.3.1

package/README.md

@@ -1,81 +1,147 @@
-# GrooveSkills 🚀
+<div align="center">
 
-> **Multi-Agent AI Skills & Architectural Standards Installer**  
-> Empower your AI coding pairs (Antigravity, Claude Code, Cursor, Gemini) with your team's real-world architectural habits, clean code patterns, and non-negotiables.
+# GrooveSkills
 
----
+**Architectural Standards & Persistent Project Memory for AI Coding Assistants**
+
+[![npm version](https://img.shields.io/npm/v/@3lineas/grooveskills.svg?style=flat-square&color=cb3837)](https://www.npmjs.com/package/@3lineas/grooveskills) [![TypeScript](https://img.shields.io/badge/TypeScript-5.9-3178c6?style=flat-square&logo=typescript&logoColor=white)](https://www.typescriptlang.org/) [![License: MIT](https://img.shields.io/badge/License-MIT-10b981?style=flat-square)](https://opensource.org/licenses/MIT)
+
+Empower **Antigravity**, **Claude Code**, **Cursor**, and **Gemini** to collaborate like seasoned members of your engineering team—aligned with your clean code standards, aware of your architectural decisions, and ready to deliver verified code from the very first prompt.
 
-## 🌟 Features
-
-- **⚡ Zero Configuration (`npx @3lineas/grooveskills`)**: Run inside any project root to inspect the environment and synchronize AI skills instantly.
-- **🎯 Smart Stack Detection**: Automatically inspects `package.json` dependencies and pre-selects matching skills (e.g. Hono, Valibot, React, Next.js).
-- **🤖 Multi-Agent Compatibility**:
-  - **Antigravity**: `.agents/skills/<skill-name>/`
-  - **Claude Code**: `.claude/skills/<skill-name>/`
-  - **Cursor IDE**: `.cursor/rules/<skill-name>.mdc` (auto-adapted to Cursor rules format)
-  - **Gemini Code Assist**: `.gemini/skills/<skill-name>/`
-- **✨ Interactive & Friendly CLI**: Clean terminal experience built with `@clack/prompts` and courteous, persuasive feedback.
-- **🔗 Centralized Global Store & Symlinks**: Skills are synced globally to `~/.grooveskills/` and linked into local projects via symlinks. Updates to global skills instantly reflect across all your projects with zero file duplication.
-- **🛡️ Battle-tested Architectural Standards**:
-  - **Universal Best Practices**: Multi-language clean code (TypeScript, PHP, Dart, Rust, etc.), early returns, zero barrel files, strict typing, <200 lines per file.
-  - **Hono API Architecture**: Independent routes by domain, isolated Actions layer, database queries exclusively inside Actions, strict Valibot validation, and Cloudflare/Hono RPC.
+[Overview](#-overview) • [How It Works](#-how-it-works) • [Quick Start](#-quick-start) • [Project Structure](#-project-structure) • [Skills Catalog](#-skills-catalog)
+
+</div>
 
 ---
 
-## 🚀 Usage
+## ✨ Overview
 
-### 1. Interactive Mode (Recommended)
+AI coding assistants perform at their highest potential when they share your team's context, architectural habits, and empirical quality standards across every session.
 
-Run directly in the root of any project:
+**GrooveSkills** (`@3lineas/grooveskills`) equips any repository with a unified AI engineering control plane through two complementary layers:
 
-```bash
-npx @3lineas/grooveskills
-```
+| Layer | Purpose | Key Benefit |
+| :--- | :--- | :--- |
+| **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. |
+| **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. |
+
+---
 
-GrooveSkills will automatically:
-1. Detect any active AI agent folders (`.agents`, `.claude`, `.cursor`, `.gemini`).
-2. Scan your project dependencies (`package.json`) and pre-select the recommended skills.
-3. Guide you through an interactive multi-select menu.
-4. Install and configure the skills for all chosen AI agents.
+## 🎯 How It Works
+
+### 1. Smart Stack Detection & Multi-Agent Adaptation
+GrooveSkills inspects dependencies (`hono`, `react`, `valibot`, `typescript`, `vitest`, `rust`, `python`) and pre-selects recommended skills, linking them automatically:
+- **Antigravity**: `.agents/skills/<skill>/SKILL.md`
+- **Claude Code**: `.claude/skills/<skill>/SKILL.md`
+- **Gemini Code Assist**: `.gemini/skills/<skill>/SKILL.md`
+- **Cursor IDE**: `.cursor/rules/<skill>.mdc`
+
+### 2. Persistent Project Memory (`.grooveskills/memory/`)
+Enabling the harness creates an encapsulated knowledge plane and configures `AGENTS.md` and `CLAUDE.md`:
+- **`context.md`**: Summarizes your stack, conventions, and essential commands.
+- **`decisions.md`**: An append-only Architecture Decision Record (ADR) log.
+- **`tasks/<slug>.md`**: Feature records tracking outcome hypotheses and verification receipts.
+
+### 3. Organic & Outcome-Driven Development (ODD) & 3-Lane Workflow
+Through the built-in `odd-ai` and `groove-harness` skills, GrooveSkills guides your AI assistant with a hybrid **Organic & Outcome-Driven Development (ODD)** methodology:
+- **Organic Adaptability**: Exploration, documentation, and planning scale proportionally to the complexity of each request—keeping minor tweaks nimble while giving major features solid structure.
+- **Outcome Accountability**: Instead of stopping as soon as code is generated (*Output-Driven*), the assistant defines a testable **Outcome Hypothesis** and verifies it with empirical proof (*Outcome-Driven*).
+
+#### The 7-Step ODD Lifecycle
+1. **Authorize (Permission Gate)**: Evaluates whether your prompt authorizes code modifications. Questions, audits, and reviews remain strictly **read-only**.
+2. **Explore Proportionately**: Consults `.grooveskills/memory/context.md` and inspects only the files relevant to the active domain, preserving your token budget and context window.
+3. **Resolve Uncertainty Early**: Answers technical unknowns by reading the codebase and asks concise, thoughtful questions only when product or design decisions are open.
+4. **Classify Semantic Scope**: Routes the request into one of three execution lanes based on architectural impact and reversibility rather than line counts.
+5. **Track Before First Write & Outcome Hypothesis**: Before editing source files on non-trivial tasks, records the plan and a formal hypothesis in `.grooveskills/memory/tasks/<slug>.md`:
+   > *"By delivering `[Output / Technical Change]`, `[Outcome / Verifiable Behavior]` will occur, proven by `[Evidence / Test / Build Command]`."*
+6. **Execute Proportionate Clean Code**: Writes clean, modular code following strict typing (zero `any`), guard clauses (zero nested `if`s), direct imports, and `<200` lines per file.
+7. **Verify Against Outcomes (Empirical Receipt)**: Runs deterministic checks (typecheck, test suite, linter, or build), logs the real output under `## Evidence`, and updates `## Next` for effortless session continuity.
+
+| Execution Lane | When It Activates | Agent Behavior |
+| :--- | :--- | :--- |
+| **Lane 1 — Answer** | Questions, code reviews, audits, or architectural inquiries. | **Read-only exploration.** Inspects context and answers clearly with zero files modified. |
+| **Lane 2 — Task** | Well-defined features, refactors, or bugfixes. | **Outcome-driven implementation.** Declares an Outcome Hypothesis in `memory/tasks/<slug>.md` and checks off items only after verifying empirical proof under `## Evidence`. |
+| **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. |
+
+### 4. Multilingual, Empathetic UX Communication
+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.
+
+### 5. Clean & 100% Portable Repository Layout
+All assets reside in `.grooveskills/` and connect to agent directories via **relative symlinks** (`../../.grooveskills/...`), making the environment instantly portable upon `git clone`.
 
 ---
 
-### 2. Direct / Automated Mode (CI / Scripting)
+## 🚀 Quick Start
 
-Install specific skills for targeted agents without interactive prompts:
+### Interactive Wizard (Recommended)
+```bash
+npx @3lineas/grooveskills
+```
 
+### Non-Interactive Mode (CI & Scripting)
 ```bash
-# Install specific skills for selected agents
-npx @3lineas/grooveskills --skills best-practices hono --agents antigravity claude
+# Install skills and initialize harness in Spanish for Claude and Antigravity
+npx @3lineas/grooveskills --skills odd-ai best-practices hono --agents antigravity claude --harness -l es -y
 
-# Automatically confirm overwrite of existing skills
-npx @3lineas/grooveskills --skills best-practices hono --agents antigravity claude cursor gemini --yes
+# Initialize harness across all supported AI assistants
+npx @3lineas/grooveskills --harness --agents antigravity claude cursor gemini -l es -y
 ```
 
-#### CLI Options
+### CLI Options Reference
 
 | Flag | Description | Example |
 | :--- | :--- | :--- |
-| `-s, --skills` | Space-separated list of skill IDs to install | `--skills best-practices hono` |
-| `-a, --agents` | Target AI agents (`antigravity`, `claude`, `cursor`, `gemini`) | `--agents antigravity cursor` |
-| `-y, --yes` | Automatically overwrite existing skills | `--yes` |
-| `-h, --help` | Display command help and options | `--help` |
-| `-V, --version` | Display the installed version of GrooveSkills | `--version` |
+| `-s, --skills <skills...>` | Space-separated list of skill IDs to install | `--skills odd-ai best-practices` |
+| `-a, --agents <agents...>` | Target AI assistants (`antigravity`, `claude`, `cursor`, `gemini`) | `--agents antigravity cursor` |
+| `--harness` | Initialize or update the GrooveSkills Harness in `.grooveskills/` | `--harness` |
+| `--no-harness` | Install selected skills without initializing the project harness | `--no-harness` |
+| `-l, --language <lang>` | Set the language for user-facing copy (`es`, `en`, `pt`, `it`, `fr`) | `-l es` |
+| `-y, --yes` | Automatically confirm updating existing skill links | `-y` |
+
+---
+
+## 📂 Project Structure
+
+```text
+my-project/
+├── .grooveskills/
+│   ├── config.json                  # Manifest of active skills, agents, language & harness state
+│   ├── skills/                      # Self-contained copy of installed skills
+│   ├── cursor-rules/                # Generated .mdc rules (when Cursor IDE is selected)
+│   └── memory/                      # Persistent project memory (when Harness is enabled)
+│       ├── context.md               # Stack overview, conventions & essential commands
+│       ├── decisions.md             # Architecture Decision Records (ADR)
+│       └── tasks/                   # Tasks with Outcome Hypotheses & Evidence receipts
+├── .agents/skills/*                 # Relative symlinks -> ../../.grooveskills/skills/*
+├── .claude/skills/*                 # Relative symlinks -> ../../.grooveskills/skills/*
+├── .cursor/rules/*.mdc              # Relative symlinks -> ../../.grooveskills/cursor-rules/*.mdc
+└── AGENTS.md / CLAUDE.md            # Concise harness pointer <!-- grooveskills:harness -->
+```
 
 ---
 
-## 📦 Available Skills
+## 📦 Skills Catalog
 
-| Skill ID | Name | Description | Suggested When |
+| Skill ID | Name | Architectural Focus | Auto-Selection Rule |
 | :--- | :--- | :--- | :--- |
-| `best-practices` | **Universal Best Practices** | Multi-language clean code, early returns, no barrel files, strict typing, <200 lines. | **Always suggested by default** (Any language/file) |
-| `hono` | **Hono Architecture (Valibot)** | Enterprise Hono standard: Valibot validation, Actions layer, RPC bindings, AppError. | Detected `hono`, `@hono/valibot-validator`, etc. |
-| `react-core` | **React Core Fundamentals** | Opinionated React fundamentals: function components, JSX, immutable state, core hooks, lists, and controlled inputs. | Detected `react`, `react-dom` |
-| `react-advanced` | **React 19 Advanced & Compiler Architecture** | React 19 platform features: React Compiler 1.0, concurrent rendering, `use()`, Actions, virtualization, and RSC boundaries. | Detected `react`, `react-dom` |
-| `react-create-page` | **React Page & View Architecture** | Declarative page coordinators, domain hooks, isolated API actions, Valibot + Formisch forms, and atomic co-location. | Detected `react`, `react-dom` |
+| `groove-harness` | **GrooveSkills Harness** | ODD 3-lane workflow (Answer, Task, Spec), ADR logging, and task checklists in `.grooveskills/memory/`. | Included with `--harness` |
+| `odd-ai` | **Organic & Outcome-Driven (ODD)** | 7-step ODD protocol for AI agents: authorize, explore, classify, outcome hypotheses, and evidence receipts. | Included with `--harness` |
+| `best-practices` | **Universal Best Practices** | Multi-language clean code, strict typing (zero `any`), guard clauses, and `<200` lines per file. | **Default (Universal)** |
+| `ux-writing` | **UX Writing & Microcopy** | Warm, empathetic, conversion-oriented microcopy for validations, CTAs, toasts, and empty states. | **Default (Universal)** |
+| `error-handling-logging` | **Error Handling & Logging** | Predictable error flows with typed `AppError`, `ActionResponse` contracts, and structured logging. | **Default (Universal)** |
+| `clean-architecture-ddd` | **Clean Architecture & DDD** | Domain-driven module boundaries, single-purpose Actions, pure functions, and immutable data models. | **Default (Universal)** |
+| `typescript-clean` | **TypeScript Clean Code (5.5+)** | Modern TypeScript (`satisfies`, discriminated unions, `const` generics, `unknown` narrowing). | `typescript` in `package.json` |
+| `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 |
+| `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` |
+| `valibot-validation` | **Valibot Schema Validation** | Boundary validation with modular Valibot schemas (`* as v from "valibot"`) and courteous errors. | `valibot` in `package.json` |
+| `testing-vitest` | **Vitest Testing Standards** | Fast, deterministic test suites using Arrange-Act-Assert (AAA) and in-memory fakes. | `vitest` in `package.json` |
+| `hono` | **Hono Architecture (Valibot)** | Scalable Hono APIs with domain-split routes, isolated Actions, and end-to-end Hono RPC types. | `hono` in `package.json` |
+| `react-core` | **React Core Fundamentals** | Pure components, immutable state, clean hook composition, and controlled inputs. | `react` in `package.json` |
+| `react-advanced` | **React 19 Advanced & Compiler** | React Compiler auto-memoization, concurrent rendering, `use()`, Actions, and RSC boundaries. | `react` in `package.json` |
+| `react-create-page` | **React Page & View Architecture** | Declarative page coordinators (`<50` lines), custom domain hooks, and Valibot + Formisch forms. | `react` in `package.json` |
 
 ---
 
 ## 📄 License
 
-MIT © [3-Lineas](https://github.com/3-Lineas)
+Released under the [MIT License](https://opensource.org/licenses/MIT) © [3-Lineas](https://3lineas.com/)