yourskills 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,60 @@
+# yourskills
+
+Install the agent skills and bundles your team publishes, from the terminal.
+
+`yourskills` asks your organization's registry where a skill lives and installs it at the
+commit your registry pins. The registry never sends skill files: they are fetched from
+your own git host with your own credentials, so a private skill stays private.
+
+Documentation lives at **[yourskills.store](https://yourskills.store)**.
+
+## Install
+
+```bash
+npm i -g yourskills
+```
+
+Needs **Node 22.20.0 or later**. You do not need Bun, and you do not need to install the
+`skills` command separately: it ships as a dependency.
+
+Point the command at your registry, then sign in:
+
+```bash
+yourskills config set server https://api.yourskills.store
+yourskills login
+```
+
+## Use
+
+```bash
+yourskills                      # the command palette, if you would rather not memorise
+yourskills search pull request  # find something
+yourskills bundle backend-dev   # install a bundle at its pinned commits
+yourskills add create-pr        # or one skill
+```
+
+Installs are **global by default**, for every agent you have. Add `-p` to install into the
+current project instead, which records them in a `yourskills.json` you commit. A teammate
+who clones that repository runs `yourskills install` and gets the same skills at the same
+commits.
+
+```bash
+yourskills installed   # what is on this machine, and at which commit
+yourskills outdated    # what your registry has moved on from
+yourskills update      # catch up
+yourskills remove <skill>
+yourskills doctor      # when something is wrong and you want to know what
+```
+
+## Hooks
+
+`yourskills hooks install` registers a session-start check with your agent, so it can tell
+you when an installed skill has moved. It never writes skill files on its own.
+
+Usage counting is separate and **opt in**, with `yourskills hooks install --track`. When it
+is on, an invocation sends the skill's registry id, the commit you installed it at, which
+agent ran it, and when. The CLI never sends a user identifier. `YOURSKILLS_NO_TRACK=1`
+turns it off outright, and `yourskills hooks uninstall` removes what we registered and
+nothing else.
+
+Run `yourskills --help` for the full command list.