skillcask 0.6.0 → 0.8.0

package/README.md

@@ -60,6 +60,27 @@ build provenance attestations:
 gh attestation verify skillcask-x86_64-unknown-linux-gnu.tar.xz -R puniserv/skillcask
 ```
 
+**GitHub Actions**
+
+```yaml
+permissions:
+  contents: read
+  attestations: read   # for the provenance check
+steps:
+  - uses: actions/checkout@<sha>
+  - uses: puniserv/skillcask@<commit sha of a release tag>   # vX.Y.Z
+    with:
+      version: X.Y.Z               # needed when the action is pinned to a sha, not a tag
+      args: install --frozen       # default
+      # working-directory: .
+      # verify-attestation: "true" # default
+```
+
+The action downloads the release archive for the runner (Linux x64 and arm64, macOS, Windows
+x64), checks its sha256 and its build provenance attestation, puts `skillcask` on `PATH` and runs
+it with `args`. It runs no other action. Used at a tag (`@vX.Y.Z`) it takes the version from the
+tag.
+
 ## Use
 
 ```sh
@@ -114,8 +135,9 @@ local = ".skills"        # project skills
 min-release-age = "3d"   # cooldown for add/update; "0" disables
 allow-ranges = true      # false: every version must be exact
 packagist = true         # false: drop the implicit Packagist repository
-github-requires = false  # true: dependencies may come from GitHub
+github-requires = false  # true: dependencies may come from GitHub or git URLs
 allow-sources = ["acme", "own", "packagist", "github"]   # only these sources; default: all
+deny-patterns = false    # true: risky patterns in new skill text fail instead of warning
 ```
 
 ### Agents
@@ -160,8 +182,8 @@ Policy can also come from `config.toml` next to the global manifest (`~/.config/
 from the environment. The first layer that sets a key wins:
 
 1. `SKILLCASK_ALLOW_SOURCES`, `SKILLCASK_MIN_RELEASE_AGE`, `SKILLCASK_ALLOW_RANGES`,
-   `SKILLCASK_PACKAGIST`, `SKILLCASK_GITHUB_REQUIRES` (overriding an enforced key prints a
-   warning);
+   `SKILLCASK_PACKAGIST`, `SKILLCASK_GITHUB_REQUIRES`, `SKILLCASK_DENY_PATTERNS` (overriding an
+   enforced key prints a warning);
 2. keys `config.toml` lists in `enforce`: a project that sets them otherwise fails;
 3. `[policy]` in `skills.toml`;
 4. the other keys of `config.toml`, as defaults.
@@ -200,6 +222,7 @@ version: 1.2.0
 requires:
   acme/security-review: ^1.0
   github:mattpocock/skills/pr: main
+  "git:https://git.example.com/team/skills.git#review": ^2.0
 ---
 ```
 
@@ -207,7 +230,7 @@ requires:
 cooldown, same hashes, one version per package (the highest one every requirer accepts). They
 stay out of `skills.toml`; the lock records each package's `requires` and switches to
 `version = 2`. A dependency is looked up only in your repositories, in order, then Packagist;
-a `github:` one needs `github-requires = true`. `remove` drops dependencies nobody needs any
+a `github:` or `git:<url>[#skill]` one needs `github-requires = true`. `remove` drops dependencies nobody needs any
 more, and `status` shows them as `via <requirer>`.
 
 ### Name conflicts
@@ -239,7 +262,10 @@ skillcask -g install --frozen    # e.g. from a dotfiles repository
 - Skills go to `~/.agents/skills` (read by most agents), with links in `~/.claude/skills`
   (`[agents] targets`, see Agents). Links are absolute, so a symlinked
   `~/.claude` works. `[agents] local` does not apply.
-- Personal skills you wrote by hand stay where they are and are not linked anywhere.
+- Personal skills you wrote by hand stay where they are and are not linked anywhere. `status`
+  lists them, and copies other tools put in a target, as `not managed`; `status --json` names the
+  source `npx skills` recorded for one. `skillcask -g add --adopt <source>` moves such a skill to
+  `~/.config/skillcask/adopted/` and installs the package's skill of the same name in its place.
 - The list of managed paths is `~/.agents/skills/.skillcask-installed`, local to the machine;
   nothing touches git.
 
@@ -252,20 +278,27 @@ Every command except `publish` and `validate` takes `-g, --global`.
 | `init` | Create `skills.toml`. |
 | `add <vendor/name>[@constraint] [--repository r]` | Resolve, lock and install. |
 | `add github:<owner/repo>[/skill][@version-or-ref]` | The same from a GitHub repository, see below. |
+| `add git:<https-url>[@version-or-ref]` | The same from any git repository over HTTPS, see below. |
 | `remove <vendor/name>…` | Drop from manifest and lock; delete files, links and gitignore lines. |
 | `install [--frozen]` | Install the lock. `--frozen` (implied by `CI`) fails when the lock is out of date. |
 | `update [vendor/name…] [--diff]` | Re-resolve within constraints. `--diff` prints what changes in each updated or added package; it does not ask before installing. |
-| `outdated [--strict]` | Newer versions, and when cooled-down ones become eligible. `--strict` exits 1 when `update` would lock a newer version. |
-| `diff [vendor/name] [--to constraint]` | Unified diff of skill files from the locked version to the one `update` would lock, see below. |
-| `info <vendor/name[@constraint]\|github:owner/repo\|skill>` | A package's skills, versions, description, license and requirements, or which package installs a skill. |
+| `outdated [--strict]` | Newer versions, when cooled-down ones become eligible, and GitHub or git tags moved since they were locked. `--strict` exits 1 when `update` would lock a newer version. |
+| `diff [vendor/name] [--to constraint\|--from old.lock]` | Unified diff of skill files from the locked version to the one `update` would lock, or from an older lock to `skills.lock`, see below. |
+| `info <vendor/name[@constraint]\|github:owner/repo\|git:url\|skill>` | A package's skills, versions, description, license and requirements, or which package installs a skill. |
 | `status` | Exit 1 when manifest, lock or installed files disagree. |
 | `doctor [--fix]` | Broken or committed links, stale gitignore block, modified skills; lists each check it ran. |
+| `audit [--json\|--sarif]` | What each installed skill reaches (commands, hosts, paths, env vars, scripts) and its findings: modified files, risky lines, invisible characters. Exit 1 on any finding. |
 | `search <query>` | Packagist (`type=ai-agent-skill`) and skill packages of the other repositories, GitLab included. |
 | `auth set\|remove <host>` | Keep a registry token in git's credential helper (Keychain, Credential Manager, libsecret). |
 | `publish --vendor v --base-url URL --out DIR [--inline] [--dist-url TPL] [paths…]` | Build a static Composer repository from a monorepo. |
 | `validate [paths…]` | Check `SKILL.md` files against the Agent Skills spec, see below. |
 | `<other>` | Runs `skillcask-<other>` from `PATH`, like git and cargo plugins. |
 
+`status`, `outdated`, `info`, `search`, `doctor` and `audit` take `--json`: one JSON document on one line of
+stdout, with the same exit code; warnings and errors stay on stderr. Package text in it is
+escaped as in the terminal (`<U+202E>`). For example `skillcask outdated --json | jq
+'.packages[] | select(.within != .locked)'`.
+
 Exit codes: 0 ok, 1 manifest/lock/status problems, 2 authentication, 3 network, 4 hash mismatch,
 5 IO or archive error.
 
@@ -294,6 +327,26 @@ before it writes the lock, then installs without asking: run `skillcask diff` fi
 and decide. A scheduled CI job can run `skillcask outdated --strict` (exit 1 when something is to
 update), then `skillcask update --diff` and open a pull request with the output.
 
+**Reviewing a lock change:** `skillcask diff --from old.lock` prints the same diff from the
+versions in another lock to those in `skills.lock`, plus the packages it drops, so a reviewer
+sees the skill text a pull request brings in instead of new versions and hashes. Each new dist
+is verified against `skills.lock` as `install` would, and the policy decides which repositories
+may be fetched. skillcask does not run git; the job fetches the old lock:
+
+```yaml
+# GitLab CI: print the diff in the merge request pipeline
+skills-diff:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+      changes: [skills.lock]
+  script:
+    - git fetch --depth 1 origin "$CI_MERGE_REQUEST_TARGET_BRANCH_NAME"
+    - git show FETCH_HEAD:skills.lock | skillcask diff --from -
+```
+
+`--from -` reads the old lock from stdin. On GitHub the same lines run in a `pull_request` job with `$GITHUB_BASE_REF`; posting the
+output as a comment is up to the CI.
+
 **Where a skill comes from:** `skillcask info vendor/name` shows the package's skills with their
 descriptions, its versions, description, license, `abandoned` and `requires`, for the locked
 version or else the newest one `add` would take (`@constraint` for another); `info
@@ -345,8 +398,29 @@ entry; `install` from the lock uses none, it downloads the pinned archive. Set `
 for a higher limit and for private repositories. `SKILLCASK_GITHUB_API` points at GitHub
 Enterprise (`https://ghe.example.com/api/v3`).
 
-skills.sh itself is not queried: its API needs a Vercel token. Search on the website, then add
-what you picked.
+skills.sh itself is not queried: its API is undocumented and may change without notice. Search
+on the website, then add what you picked.
+
+### Skills from any git repository
+
+GitLab, Bitbucket, Azure DevOps, Gitea or a self-hosted server work without a Composer registry:
+
+```sh
+skillcask add git:https://gitlab.example.com/acme/skills.git
+skillcask add git:https://gitlab.example.com/acme/skills.git@main
+```
+
+```toml
+"acme/skills" = { git = "https://gitlab.example.com/acme/skills.git", version = "^1.0" }
+```
+
+Versions, `ref` and `skills = [...]` work as for GitHub; the entry is named after the last two
+parts of the URL. skillcask speaks git's HTTPS protocol itself: no git binary runs, so no hook or
+filter of the repository can. It fetches the one commit it needs and checks every file against
+the commit's object ids. Credentials come from the same places as for registries (`auth.json`,
+the credential helper, `$CI_JOB_TOKEN` in GitLab CI). Git servers keep no release or push times,
+so `min-release-age` uses commit dates, which the committer sets; a branch whose newest commit is
+too young falls back to an older commit when the server supports partial fetches (`filter`).
 
 ## Security
 
@@ -369,6 +443,40 @@ what you picked.
   RIGHT-TO-LEFT OVERRIDE`, at most five per file. A leading byte order mark and a zero width
   joiner inside an emoji are not reported; right-to-left and Indic text can trigger warnings.
   Installing from the lock does not warn again.
+- The same commands warn about lines that usually mean harm, as `warning: acme/x:
+  skills/foo/SKILL.md:12: downloads code into a shell`, at most five per file:
+
+  | Warning | Matches (case-insensitive) |
+  |---|---|
+  | downloads code into a shell | `curl`, `wget`, `irm`, `iwr`, `Invoke-WebRequest` or `Invoke-RestMethod` piped (`\|`) into `sh`, `bash`, `zsh`, `dash`, `iex`, `Invoke-Expression`, `python`, `perl`, `ruby` or `node`, also after `sudo` |
+  | decodes base64 and runs it | `base64 -d`, `base64 --decode`, `b64decode` or `FromBase64String` with a pipe into a shell, `eval`, `exec(` or `iex` |
+  | reads SSH keys | `~/.ssh`, `$HOME/.ssh`, `id_rsa`, `id_ed25519` |
+  | reads system account files | `/etc/passwd`, `/etc/shadow` |
+  | tells the agent to ignore its instructions | "ignore (all) previous/prior instructions", "disregard all previous/prior" |
+
+  Skills that teach shell setup trigger some of these legitimately, so they are warnings. With
+  `deny-patterns = true` under `[policy]` (or enforced in `config.toml`) they fail the command
+  with exit 1 and nothing is written.
+- `skillcask audit` reviews what is installed now, every skill in `.agents/skills` and the project
+  skills: the commands its shell code blocks run, the hosts of its URLs, the paths in the home
+  directory or under system roots, the environment variables it reads and the files an agent could
+  run. That is read from the text, so it is a hint for review, not a sandbox. It also reports a
+  locked skill that differs from the lock, and every risky line and invisible character above,
+  with no limit per file, and exits 1 on any of them. `--sarif` prints a SARIF 2.1.0 log for code
+  scanning, e.g. in GitHub Actions:
+
+  ```yaml
+  - uses: puniserv/skillcask@v0.8.0
+    with:
+      args: install --frozen
+  - run: skillcask audit --sarif > skills.sarif
+  - uses: github/codeql-action/upload-sarif@v3
+    if: always()
+    with:
+      sarif_file: skills.sarif
+  ```
+- Plain git sources pin the commit; the lock's `dist-sha256` hashes the commit's file list
+  (path, mode, sha256 of the content), so it does not depend on how a server packs objects.
 - `min-release-age` for GitHub sources uses times GitHub sets: release publication for tags,
   push times from the Activity API for branches. A tag without a release, or a ref GitHub lists no
   pushes for, falls back to commit dates, which the committer sets; reviewing what `add`/`update`

package/npm-shrinkwrap.json

@@ -19,7 +19,7 @@
       "hasInstallScript": true,
       "license": "MIT OR Apache-2.0",
       "name": "skillcask",
-      "version": "0.6.0"
+      "version": "0.8.0"
     },
     "node_modules/detect-libc": {
       "engines": {
@@ -48,5 +48,5 @@
     }
   },
   "requires": true,
-  "version": "0.6.0"
+  "version": "0.8.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "artifactDownloadUrls": [
-    "https://github.com/puniserv/skillcask/releases/download/v0.6.0"
+    "https://github.com/puniserv/skillcask/releases/download/v0.8.0"
   ],
   "bin": {
     "skillcask": "run-skillcask.js"
@@ -104,7 +104,7 @@
       "zipExt": ".tar.xz"
     }
   },
-  "version": "0.6.0",
+  "version": "0.8.0",
   "volta": {
     "node": "18.14.1",
     "npm": "9.5.0"