synskill 0.1.4

package/README.md

@@ -0,0 +1,69 @@
+# synskill
+
+`synskill` is a public npm CLI that installs skills from a private Git repository you already have access to.
+
+## Usage
+
+```bash
+npx synskill
+```
+
+## Install A Skill
+
+Install one skill directly into the current repo:
+
+```bash
+npx synskill <skill-name> --project
+```
+
+Examples:
+
+```bash
+npx synskill pr-review --project
+npx synskill bootstrap-device-repo --project
+npx synskill skill-creator --global
+```
+
+Omit `--project` for a global install. Add `--copy` if you want copies instead of symlinks.
+
+## Requirements
+
+- Node.js 18 or newer
+- Git available in `PATH`
+- Access to the private repository that contains your skills
+
+## Common Commands
+
+```bash
+npx synskill
+npx synskill pr-review --project
+npx synskill install pr-review --project
+npx synskill add pr-review --project
+npx synskill list
+npx synskill skill-creator --global
+npx synskill install --skills my-skill --project
+npx synskill install --skills my-skill --project --copy
+npx synskill update
+```
+
+## Private Repo Override
+
+```bash
+npx synskill --repo-url <git-url>
+```
+
+or:
+
+```bash
+SYNAPSE_SKILLS_REPO_URL=<git-url> npx synskill
+```
+
+## Notes
+
+- The CLI keeps a local cache of the private skills repository to make repeated runs fast.
+- You can install a specific skill directly with `npx synskill install <skill-name>` or `npx synskill <skill-name>`.
+- `skill-creator` is fetched on demand from `https://github.com/anthropics/skills/tree/main/skills/skill-creator` so it stays on the upstream latest version without being stored in this repo.
+- `skill-creator` is explicit-install only and does not appear in the default interactive skills list.
+- By default it symlinks each selected target directly to the source skill directory; use `--copy` to write independent copies instead.
+- `update` forces a cache refresh.
+- `--no-pull` uses the existing cache without refreshing it.