@alessandroraffa/tangyr 0.0.2 → 0.9.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alessandro Raffa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,5 +1,111 @@
-# tangyr
+# @alessandroraffa/tangyr
 
-A Software Engineering Discipline for Agent Coding.
+CLI for the Tangyr discipline — install and manage operating kits for AI coding tools.
 
-This package is not yet released. See [github.com/alessandroraffa/tangyr](https://github.com/araffa/tangyr).
+An operating kit is a self-contained package of agents, skills, commands, rules, and templates that implements the Tangyr discipline for a specific AI coding context. The CLI places kit artifacts into the environments consumed by supported tools.
+
+## Install / run
+
+```sh
+npx @alessandroraffa/tangyr <command>
+```
+
+Or install globally:
+
+```sh
+npm install -g @alessandroraffa/tangyr
+tangyr <command>
+```
+
+## Commands
+
+### Kit management
+
+| Command                       | Description                                                         |
+| ----------------------------- | ------------------------------------------------------------------- |
+| `tangyr install --kit <name>` | Install a kit; runs assess, resolves conflicts, writes artifacts    |
+| `tangyr uninstall`            | Remove Tangyr from the target scope                                 |
+| `tangyr sync`                 | Synchronize installed kit to the latest version                     |
+| `tangyr verify`               | Check installation integrity against the manifest                   |
+| `tangyr cleanup`              | Remove managed artifacts; delegates to uninstall if manifest exists |
+| `tangyr assess`               | Pre-installation conflict analysis                                  |
+| `tangyr list`                 | Display available and installed kits                                |
+
+### Authentication
+
+| Command              | Description                           |
+| -------------------- | ------------------------------------- |
+| `tangyr auth login`  | Store a license key for the Full tier |
+| `tangyr auth status` | Show current authentication state     |
+| `tangyr auth logout` | Remove stored credentials             |
+
+### Environment
+
+| Command         | Description                                        |
+| --------------- | -------------------------------------------------- |
+| `tangyr detect` | Detect supported AI tool runtimes                  |
+| `tangyr status` | Show managed artifact status per tool              |
+| `tangyr doctor` | Run environment diagnostics with optional auto-fix |
+| `tangyr probe`  | Probe configured platform paths                    |
+
+### Configuration
+
+| Command           | Description                                           |
+| ----------------- | ----------------------------------------------------- |
+| `tangyr init`     | Create a tangyr.config.yaml interactively             |
+| `tangyr config`   | Display or edit Tangyr configuration                  |
+| `tangyr validate` | Validate the kit against kitFormat 1 conformity rules |
+
+## Global flags
+
+| Flag                | Description                            |
+| ------------------- | -------------------------------------- |
+| `--config <path>`   | Use an explicit configuration file     |
+| `--kit-path <path>` | Use an explicit operating kit root     |
+| `--dry-run`         | Report actions without modifying files |
+| `--yes`             | Skip confirmation prompts              |
+| `--verbose`         | Detailed output                        |
+| `--quiet`           | Errors only                            |
+| `--no-color`        | Disable colors                         |
+
+## Supported tools
+
+- **Claude Code** — artifacts placed in scope-resolved Claude Code paths
+- **GitHub Copilot** — agents and commands compiled to VS Code user directories
+- **OpenAI Codex** — `AGENTS.md`, agent TOML files, rules, hooks, and MCP compiled to Codex paths
+- **OpenCode** — instructions, agents, commands, skills, and MCP placed in XDG config paths
+- **Cursor** — instructions, subagents, rules, commands, skills, hooks, and MCP
+- **Cline** — instructions, rules, workflows, skills, and MCP
+
+## Quick start
+
+```sh
+# Initialize a configuration in your project
+npx @alessandroraffa/tangyr init
+
+# Install a kit (dry-run first to preview)
+npx @alessandroraffa/tangyr install --kit lite --dry-run
+npx @alessandroraffa/tangyr install --kit lite
+
+# Check installation status
+npx @alessandroraffa/tangyr status
+
+# Synchronize after a kit update
+npx @alessandroraffa/tangyr sync
+```
+
+## Scope
+
+Every write command accepts `--scope global` or `--scope project`. The CLI flag overrides `config.scope` for that invocation.
+
+| Scope     | Manifest location         | Claude Code artifacts               |
+| --------- | ------------------------- | ----------------------------------- |
+| `global`  | `~/.tangyr/manifest.json` | `~/.claude/`                        |
+| `project` | `.tangyr/manifest.json`   | repo root (`AGENTS.md`, `.claude/`) |
+
+## Distribution model
+
+- **Lite** — publicly available, core agents and essential skills
+- **Full** — requires license key, complete agent roster and all skills
+
+Run `tangyr auth login` to authenticate with a Full-tier license key.