@work-shape/catalyst-cli 0.8.0-rc.4 → 0.8.0-rc.41
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -0
- package/dist/index.d.ts +32364 -12347
- package/dist/index.js +21084 -10866
- package/package.json +5 -4
- package/skills/catalyst/SKILL.md +68 -5
package/README.md
CHANGED
|
@@ -11,4 +11,15 @@ catalyst --help
|
|
|
11
11
|
|
|
12
12
|
It needs Node 22 or later. The key is read from `CATALYST_API_KEY`, is sent only to the instance you name over HTTPS, and is never written into the working copy.
|
|
13
13
|
|
|
14
|
+
Run `catalyst doctor` to check the address, sign-in, versions and effective key rights. Its four lines contain no keys, tokens, identities or response contents and are safe to share. Pass `--instance <url>` to select an instance explicitly. Use the instance's HTTPS origin, without `/api` or a sign-in path.
|
|
15
|
+
|
|
16
|
+
The CLI must be the server's release. When the server's first answer to a command names a newer release and you run the command in a terminal, a CLI installed with `npm install --global` installs that version of itself, says so in one line and runs the command again; a Catalyst skill that `catalyst setup` wrote and you did not change is updated with it. It never installs an older version, never reacts to a later answer of the same command, never replaces a checkout `npm link` points at, and never runs in CI (`CI` set), without a terminal, or with `CATALYST_NO_AUTO_UPDATE=1`. There, and when the install fails, commands print the exact update command, including prerelease versions, for example:
|
|
17
|
+
|
|
18
|
+
```powershell
|
|
19
|
+
npm install --global @work-shape/catalyst-cli@<server-version>
|
|
20
|
+
catalyst doctor
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Replace `<server-version>` with the version in the diagnostic. Run each line separately; this also works in Windows PowerShell 5.1, which does not support `&&`. A project-local installation is never updated by the CLI: the diagnostic names the project's folder and its install command (npm, pnpm or yarn, exact version), or `pnpm add --global` for pnpm's global install; run it there, then `npx catalyst doctor`. Updating the CLI preserves saved sign-ins. After a manual update, run `catalyst setup <tool> --instance <url>` again to refresh the installed skill.
|
|
24
|
+
|
|
14
25
|
MIT licence.
|