@sr-connect/cli 0.1.1 → 0.1.3

package/README.md

@@ -2,13 +2,15 @@
 
 A CLI to work with [ScriptRunner Connect](https://scriptrunnerconnect.com). Run it with nothing but a verb and it asks for what it needs. Run it with flags and `--agent` and it never asks, which is what scripts and AI agents want.
 
+Driving it from an agent? Install the companion [skill](https://www.skills.sh/adaptavist/scriptrunner-skills/sr-connect), which teaches the product behind the commands. See [For agents](#for-agents).
+
 ```sh
 npx @sr-connect/cli                  # no install; lists the command groups
 npm i -g @sr-connect/cli             # then: sr-connect
 npx @sr-connect/cli cli get-readme   # prints this document from the installed copy
 ```
 
-Node 22 or newer. An older runtime gets one warning line per run and most commands still work, but live log streaming does not. Every example below spells the CLI as `npx @sr-connect/cli`, which is also how it refers to itself in its own hints. For daily use install it globally: `npx` spends most of a second resolving the package before the CLI starts, and the installed `sr-connect` answers in a fraction of that.
+Node 22 or newer. An older runtime gets one warning line per run and most commands still work, but live log streaming does not. Every example below spells the CLI as `npx @sr-connect/cli`. For daily use install it globally: `npx` spends most of a second resolving the package before the CLI starts, the installed `sr-connect` answers in a fraction of that, and a global install refers to itself as `sr-connect` in its own hints rather than telling you to run `npx`.
 
 ## Getting started
 
@@ -57,6 +59,8 @@ Commands that change something the clone contains also keep the clone current. S
 
 **Pass `--agent` on every call, or set `SR_CONNECT_CLI_AGENT=1` once.** That is the whole of it: `--agent` switches off every question on its own, so anything missing becomes exit 2 instead of a hang, and it tells the API that an agent is driving. You do not also need `--no-prompts`, which is the same prompt switch without the declaration and is there for scripts that are not agents. `--agent` does not change what stdout looks like — pair it with `--raw`, or set `SR_CONNECT_CLI_RAW=1` beside the other one.
 
+**There is a companion skill.** [`sr-connect`](https://www.skills.sh/adaptavist/scriptrunner-skills/sr-connect) teaches an agent the product behind the commands: what a workspace, connector, event listener and scheduled trigger are, what the runtime can and cannot do, and how to drive this CLI to build any of it. Install it wherever your agent reads skills from. This document is orientation for the CLI, and `--explain` answers for a single verb; the skill is the part neither of them covers.
+
 - **Ask a verb what it takes before calling it — this is the fastest thing in the CLI, and it is where the per-verb documentation lives.** Every verb takes `--explain`: on stdout the example `--input` body where the verb has one and `{}` where it does not, and on stderr a sentence per parameter plus notes on everything the parameters do not cover — outcomes, exit codes, the shape of the document it answers with. Exit 0, no credentials, no scope, no request. This document does not repeat any of it, so `--explain` is the answer rather than a second opinion. Run it before a flags-only call too: a body key is a flag under another spelling, and the rule says which (`version` is `--package-version`, `eventListenerTypeId` is `--listener-type-id`, `waitForResponse` is `--wait`).
 
     ```sh
@@ -545,6 +549,7 @@ npx @sr-connect/cli event-listener update --explain
 - `workspace get` — Get a single workspace
 - `workspace update` — Update a workspace
 - `workspace delete` — Delete a workspace
+- `workspace check-package-versions` — Check the packages a workspace depends on against the versions NPM publishes
 
 ### workspace-lock (wl)