pruff-skills 0.1.0

package/README.md

@@ -0,0 +1,186 @@
+# pruff-skills
+
+The official Pruff agent skills CLI — install Pruff's curated skills into Claude Code, Cursor, Codex and 70+ other agents.
+
+```
+██████╗ ██████╗ ██╗   ██╗███████╗███████╗
+██╔══██╗██╔══██╗██║   ██║██╔════╝██╔════╝
+██████╔╝██████╔╝██║   ██║█████╗  █████╗
+██╔═══╝ ██╔══██╗██║   ██║██╔══╝  ██╔══╝
+██║     ██║  ██║╚██████╔╝██║     ██║
+╚═╝     ╚═╝  ╚═╝ ╚═════╝ ╚═╝     ╚═╝
+```
+
+Run it with no arguments to see the banner and command list:
+
+```bash
+npx pruff-skills
+```
+
+## Install a Skill
+
+```bash
+npx pruff-skills add <skill>
+```
+
+A bare skill name resolves from Pruff's catalog (gated by your GitHub access). You can also point
+`add` at any GitHub repo, git URL, or local path — see [Source Formats](#source-formats).
+
+## The catalog
+
+Pruff's skills live in a **private** catalog, so only teammates with access can install them.
+Browse what's available with `npx pruff-skills find`, then install with `npx pruff-skills add <skill>`.
+
+The catalog also ships **Claude Code subagents**. `find` lists them alongside skills (tagged
+`[subagent]`); install one with:
+
+```bash
+npx pruff-skills agents add <name>      # → .claude/agents/  (add -g for ~/.claude/agents/)
+```
+
+## Use a Skill Without Installing
+
+Generate a prompt for one skill, or start a supported coding agent interactively:
+
+```bash
+npx pruff-skills use <skill> | claude
+npx pruff-skills use <skill> --agent claude-code
+```
+
+`pruff-skills use` resolves sources the same way as `add`, writes the selected skill files to a temporary
+directory, and prints only the generated prompt to stdout unless `--agent` is provided. With `--agent`,
+it starts one supported agent interactively with the generated prompt.
+
+### Source Formats
+
+```bash
+# Pruff catalog (bare skill name → the private catalog repo)
+npx pruff-skills add <skill>
+
+# GitHub shorthand (owner/repo)
+npx pruff-skills add Pruff-Tech/pruff-skills
+
+# Full GitHub URL
+npx pruff-skills add https://github.com/Pruff-Tech/pruff-skills
+
+# Any git URL
+npx pruff-skills add git@github.com:Pruff-Tech/pruff-skills.git
+
+# Local path
+npx pruff-skills add ./my-local-skills
+```
+
+### Options
+
+| Option                    | Description                                                              |
+| ------------------------- | ------------------------------------------------------------------------ |
+| `-g, --global`            | Install to the user directory instead of the project                     |
+| `-a, --agent <agents...>` | Target specific agents (e.g., `claude-code`, `cursor`, `codex`)          |
+| `-s, --skill <skills...>` | Install specific skills by name (use `'*'` for all skills)               |
+| `-l, --list`              | List available skills without installing                                 |
+| `--copy`                  | Copy files instead of symlinking to agent directories                    |
+| `-y, --yes`               | Skip all confirmation prompts                                            |
+| `--all`                   | Install all skills to all agents without prompts                         |
+
+### Examples
+
+```bash
+# List skills available in the catalog without installing
+npx pruff-skills add Pruff-Tech/pruff-skills --list
+
+# Install specific skills
+npx pruff-skills add --skill <skill> --skill <skill>
+
+# Install to specific agents
+npx pruff-skills add <skill> -a claude-code -a cursor
+
+# Non-interactive (CI-friendly)
+npx pruff-skills add <skill> -g -a claude-code -y
+```
+
+### Installation Scope
+
+| Scope       | Flag      | Location            | Use Case                                      |
+| ----------- | --------- | ------------------- | --------------------------------------------- |
+| **Project** | (default) | `./<agent>/skills/` | Committed with your project, shared with team |
+| **Global**  | `-g`      | `~/<agent>/skills/` | Available across all projects                 |
+
+### Installation Methods
+
+| Method                    | Description                                                                                 |
+| ------------------------- | ------------------------------------------------------------------------------------------- |
+| **Symlink** (Recommended) | Creates symlinks from each agent to a canonical copy. Single source of truth, easy updates. |
+| **Copy**                  | Creates independent copies for each agent. Use when symlinks aren't supported.              |
+
+## Other Commands
+
+| Command                        | Description                                   |
+| ------------------------------ | --------------------------------------------- |
+| `npx pruff-skills use <source>`    | Use one skill without installing              |
+| `npx pruff-skills list`            | List installed skills (alias: `ls`)           |
+| `npx pruff-skills find [query]`    | Search the Pruff catalog interactively or by keyword |
+| `npx pruff-skills remove [skills]` | Remove installed skills from agents           |
+| `npx pruff-skills update [skills]` | Update installed skills to latest versions    |
+| `npx pruff-skills init [name]`     | Create a new `SKILL.md` template              |
+
+```bash
+npx pruff-skills list                 # list installed skills
+npx pruff-skills find logs            # search the catalog by keyword
+npx pruff-skills update -g            # update global skills
+npx pruff-skills remove <skill>    # remove a skill
+```
+
+## Supported Agents
+
+The CLI auto-detects which coding agents you have installed and writes skills into the right path
+for each (`.claude/skills/`, `.agents/skills/`, `.cursor/skills/`, …). Claude Code, Cursor, Codex,
+OpenCode and 70+ others are supported. If none are detected, you'll be prompted to choose.
+
+## Creating Skills
+
+Skills are directories containing a `SKILL.md` file with YAML frontmatter:
+
+```markdown
+---
+name: my-skill
+description: What this skill does and when to use it
+---
+
+# My Skill
+
+Instructions for the agent to follow when this skill is activated.
+
+## When to Use
+
+Describe the scenarios where this skill should be used.
+
+## Steps
+
+1. First, do this
+2. Then, do that
+```
+
+Scaffold one with `npx pruff-skills init my-skill`, then publish it by pushing to a repo
+(`npx pruff-skills add <owner>/<repo>`) or hosting it under `/.well-known/agent-skills/`.
+
+## Environment Variables
+
+| Variable                  | Description                                                                          |
+| ------------------------- | ------------------------------------------------------------------------------------ |
+| `PRUFF_SKILLS_CATALOG`        | Source a bare skill name resolves to (default `Pruff-Tech/pruff-skills`). A GitHub `owner/repo`, git URL, or local path. Set to a local checkout for offline installs. |
+| `INSTALL_INTERNAL_SKILLS` | Set to `1` or `true` to show and install skills marked as `internal: true`          |
+
+## Telemetry
+
+**None.** pruff-skills ships with all usage telemetry removed — no events leave your machine.
+
+## Attribution
+
+pruff-skills is a rebranded fork of [`vercel-labs/skills`](https://github.com/vercel-labs/skills) (MIT).
+The CLI engine, provider/installer logic, and agent path mappings are upstream's work; the Pruff fork
+swaps the logo, branding, catalog source (the private `Pruff-Tech/pruff-skills` repo), and removes the bundled usage telemetry.
+See `ThirdPartyNoticeText.txt` for third-party licenses.
+
+## License
+
+MIT

package/ThirdPartyNoticeText.txt

@@ -0,0 +1,163 @@
+/*!----------------- Skills CLI ThirdPartyNotices -------------------------------------------------------
+
+The Skills CLI incorporates third party material from the projects listed below.
+The original copyright notice and the license under which this material was received
+are set forth below. These licenses and notices are provided for informational purposes only.
+
+---------------------------------------------
+Third Party Code Components
+--------------------------------------------
+
+================================================================================
+Package: @clack/core@0.5.0
+License: MIT
+Repository: https://github.com/bombshell-dev/clack
+--------------------------------------------------------------------------------
+
+MIT License
+
+Copyright (c) Nate Moore
+
+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: @clack/prompts@0.11.0
+License: MIT
+Repository: https://github.com/bombshell-dev/clack
+--------------------------------------------------------------------------------
+
+MIT License
+
+Copyright (c) Nate Moore
+
+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: picocolors@1.1.1
+License: ISC
+Repository: https://github.com/alexeyraspopov/picocolors
+--------------------------------------------------------------------------------
+
+ISC License
+
+Copyright (c) 2021-2024 Oleksii Raspopov, Kostiantyn Denysov, Anton Verinov
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+
+================================================================================
+Package: simple-git@3.36.0
+License: MIT
+Repository: https://github.com/steveukx/git-js
+--------------------------------------------------------------------------------
+
+MIT License
+
+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: sisteransi@1.0.5
+License: MIT
+Repository: https://github.com/terkelg/sisteransi
+--------------------------------------------------------------------------------
+
+MIT License
+
+Copyright (c) 2018 Terkel Gjervig Nielsen
+
+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: xdg-basedir@5.1.0
+License: MIT
+Repository: https://github.com/sindresorhus/xdg-basedir
+--------------------------------------------------------------------------------
+
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+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: yaml@2.9.0
+License: ISC
+Repository: https://github.com/eemeli/yaml
+--------------------------------------------------------------------------------
+
+Copyright Eemeli Aro <eemeli@gmail.com>
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.
+
+
+================================================================================
+*/

package/bin/cli.mjs

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+
+import module from 'node:module';
+
+// https://nodejs.org/api/module.html#module-compile-cache
+if (module.enableCompileCache && !process.env.NODE_DISABLE_COMPILE_CACHE) {
+  try {
+    module.enableCompileCache();
+  } catch {
+    // Ignore errors
+  }
+}
+
+await import('../dist/cli.mjs');