@catalyst-cloud/cli 0.9.5 → 0.13.1
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/CHANGELOG.md +28 -0
- package/README.md +28 -29
- package/dist/args.js +19 -1
- package/dist/ask.js +30 -18
- package/dist/capabilities.js +5 -0
- package/dist/cli.js +24 -6
- package/dist/env/declaration-rules.js +163 -0
- package/dist/env/group.js +51 -0
- package/dist/env/inventory.js +102 -0
- package/dist/env/render.js +39 -0
- package/dist/env/scan-env-example.js +62 -0
- package/dist/env/scan-source.js +43 -0
- package/dist/env/scan-workflow.js +123 -0
- package/dist/env/scan-wrangler.js +120 -0
- package/dist/env/types.js +1 -0
- package/dist/env/walk.js +87 -0
- package/dist/env.js +76 -0
- package/dist/environment.js +1 -1
- package/dist/legacy.js +224 -0
- package/dist/project.js +129 -0
- package/dist/release.js +1 -1
- package/dist/repo.js +297 -0
- package/dist/runtime-verb.js +1 -1
- package/dist/secret.js +1 -1
- package/dist/skill-shape.js +21 -13
- package/dist/skills.js +44 -4
- package/dist/transport.js +26 -1
- package/package.json +7 -6
- package/skills/catalyst-github/SKILL.md +7 -7
- package/skills/catalyst-github/references/is-it-mergeable.md +8 -2
- package/skills/catalyst-github/references/what-a-pr-accumulates.md +3 -3
- package/skills/catalyst-github/scripts/is-it-mergeable.mjs +3 -3
- package/skills/catalyst-github/scripts/lib/cli.mjs +9 -7
- package/skills/catalyst-github/scripts/lib/credential.mjs +2 -2
- package/skills/catalyst-github/scripts/read-pr.mjs +2 -2
- package/skills/catalyst-linear/SKILL.md +17 -19
- package/skills/catalyst-linear/agents/openai.yaml +1 -1
- package/skills/catalyst-linear/agents/portability.yaml +1 -1
- package/skills/catalyst-linear/references/reading-a-ticket.md +9 -26
- package/skills/catalyst-linear/references/what-a-ticket-accumulates.md +2 -2
- package/skills/catalyst-linear/references/writing-to-linear.md +7 -9
- package/skills/catalyst-linear/scripts/comment.mjs +1 -1
- package/skills/catalyst-linear/scripts/create-ticket.mjs +1 -1
- package/skills/catalyst-linear/scripts/label.mjs +1 -1
- package/skills/catalyst-linear/scripts/lib/cli.mjs +9 -7
- package/skills/catalyst-linear/scripts/lib/credential.mjs +2 -2
- package/skills/catalyst-linear/scripts/move.mjs +1 -1
- package/skills/catalyst-linear/scripts/read-ticket.mjs +1 -1
- package/skills/catalyst-linear/scripts/search.mjs +1 -1
- package/skills/catalyst-onboard/SKILL.md +37 -57
- package/skills/catalyst-onboard/agents/openai.yaml +2 -2
- package/skills/catalyst-onboard/agents/portability.yaml +1 -1
- package/skills/catalyst-onboard/references/connecting-this-machine.md +35 -0
- package/skills/catalyst-onboard/references/declaring-a-repository.md +7 -17
- package/skills/catalyst-onboard/references/local-sync.md +19 -7
- package/skills/catalyst-onboard/references/reading-ready.md +79 -0
- package/skills/catalyst-onboard/references/replacing-a-credential.md +8 -33
- package/skills/catalyst-onboard/references/repository-agent-setup.md +23 -0
- package/skills/catalyst-onboard/references/skill-sources.md +13 -19
- package/skills/catalyst-onboard/references/the-one-path.md +18 -74
- package/skills/catalyst-onboard/references/what-a-phase-needs.md +21 -28
- package/skills/catalyst-onboard/references/what-the-browser-owns.md +20 -37
- package/skills/{catalyst-setup → catalyst-onboard}/scripts/check.mjs +10 -9
- package/skills/catalyst-onboard/scripts/lib/cli.mjs +6 -4
- package/skills/catalyst-onboard/scripts/lib/credential.mjs +2 -2
- package/skills/catalyst-onboard/scripts/where-am-i.mjs +60 -4
- package/skills/run-this-project/SKILL.md +23 -25
- package/skills/run-this-project/agents/openai.yaml +1 -1
- package/skills/run-this-project/agents/portability.yaml +1 -1
- package/skills/run-this-project/references/making-work-ready.md +20 -37
- package/skills/run-this-project/references/reacting-to-events.md +25 -48
- package/skills/run-this-project/references/stalls-and-escalation.md +20 -42
- package/skills/run-this-project/scripts/lib/cli.mjs +7 -5
- package/skills/run-this-project/scripts/lib/credential.mjs +2 -2
- package/skills/run-this-project/scripts/scope-status.mjs +0 -0
- package/skills/run-this-project/scripts/watch-scope.mjs +1 -1
- package/skills/unstick/SKILL.md +12 -12
- package/skills/unstick/agents/openai.yaml +1 -1
- package/skills/unstick/agents/portability.yaml +1 -1
- package/skills/unstick/references/playbook.md +13 -13
- package/skills/unstick/scripts/lib/cli.mjs +6 -4
- package/skills/unstick/scripts/lib/credential.mjs +2 -2
- package/skills/unstick/scripts/unstick.mjs +1 -1
- package/skills/what-needs-me/SKILL.md +12 -14
- package/skills/what-needs-me/agents/openai.yaml +2 -2
- package/skills/what-needs-me/agents/portability.yaml +1 -1
- package/skills/what-needs-me/references/raising-a-decision.md +8 -16
- package/skills/what-needs-me/references/reading-the-inbox.md +9 -12
- package/skills/what-needs-me/references/settling-an-answer.md +6 -12
- package/skills/what-needs-me/scripts/inbox.mjs +14 -13
- package/skills/what-needs-me/scripts/lib/cli.mjs +6 -4
- package/skills/what-needs-me/scripts/lib/credential.mjs +2 -2
- package/skills/what-needs-me/scripts/raise.mjs +1 -1
- package/skills/what-needs-me/scripts/settle.mjs +1 -1
- package/skills/what-this-repo-needs/SKILL.md +31 -0
- package/skills/what-this-repo-needs/agents/openai.yaml +6 -0
- package/skills/what-this-repo-needs/agents/portability.yaml +4 -0
- package/skills/what-this-repo-needs/references/what-each-group-means.md +38 -0
- package/skills/what-this-repo-needs/scripts/check.mjs +64 -0
- package/skills/what-this-repo-needs/scripts/inventory.mjs +61 -0
- package/skills/{catalyst-setup → what-this-repo-needs}/scripts/lib/cli.mjs +35 -22
- package/skills/{catalyst-setup → what-this-repo-needs}/scripts/lib/credential.mjs +2 -2
- package/skills/whats-happening/SKILL.md +27 -21
- package/skills/whats-happening/agents/openai.yaml +1 -1
- package/skills/whats-happening/references/coding-accounts.md +24 -0
- package/skills/whats-happening/references/routing-work.md +11 -29
- package/skills/whats-happening/references/settings-and-where-they-live.md +20 -0
- package/skills/whats-happening/references/stages-and-mapping.md +25 -0
- package/skills/whats-happening/references/status-reply.md +21 -21
- package/skills/whats-happening/references/the-ladder.md +30 -0
- package/skills/whats-happening/references/what-runs-next.md +32 -0
- package/skills/whats-happening/references/when-a-phase-fails.md +27 -0
- package/skills/whats-happening/references/why-is-it-stuck.md +33 -40
- package/skills/whats-happening/scripts/explain.mjs +1 -1
- package/skills/whats-happening/scripts/lib/cli.mjs +7 -5
- package/skills/whats-happening/scripts/lib/credential.mjs +2 -2
- package/skills/{how-catalyst-works → whats-happening}/scripts/show-my-map.mjs +18 -32
- package/skills/whats-happening/scripts/snapshot.mjs +10 -6
- package/skills/catalyst-onboard/references/choosing-a-coding-account.md +0 -52
- package/skills/catalyst-onboard/references/who-fixes-what.md +0 -64
- package/skills/catalyst-setup/SKILL.md +0 -36
- package/skills/catalyst-setup/agents/openai.yaml +0 -6
- package/skills/catalyst-setup/agents/portability.yaml +0 -4
- package/skills/catalyst-setup/references/what-each-check-means.md +0 -88
- package/skills/catalyst-setup/scripts/replica-status.mjs +0 -46
- package/skills/connect-me/SKILL.md +0 -63
- package/skills/connect-me/agents/openai.yaml +0 -6
- package/skills/connect-me/agents/portability.yaml +0 -5
- package/skills/connect-me/references/keeping-the-replica-running.md +0 -88
- package/skills/connect-me/scripts/lib/cli.mjs +0 -185
- package/skills/connect-me/scripts/lib/credential.mjs +0 -29
- package/skills/connect-me/scripts/verify-connection.mjs +0 -68
- package/skills/how-catalyst-works/SKILL.md +0 -43
- package/skills/how-catalyst-works/agents/openai.yaml +0 -6
- package/skills/how-catalyst-works/agents/portability.yaml +0 -4
- package/skills/how-catalyst-works/references/coding-accounts.md +0 -51
- package/skills/how-catalyst-works/references/stages-and-mapping.md +0 -56
- package/skills/how-catalyst-works/references/the-ladder.md +0 -41
- package/skills/how-catalyst-works/references/what-catalyst-is.md +0 -30
- package/skills/how-catalyst-works/references/what-runs-next.md +0 -88
- package/skills/how-catalyst-works/references/when-a-phase-fails.md +0 -57
- package/skills/how-catalyst-works/scripts/explain-ticket.mjs +0 -41
- package/skills/how-catalyst-works/scripts/lib/cli.mjs +0 -164
- package/skills/how-catalyst-works/scripts/lib/credential.mjs +0 -29
- package/skills/how-catalyst-works/scripts/whats-running.mjs +0 -65
- package/skills/whats-happening/references/reading-the-board.md +0 -43
- package/skills/whats-happening/references/reprioritising.md +0 -37
|
@@ -1,79 +1,59 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: catalyst-onboard
|
|
3
3
|
description: >-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
allowed-tools: Bash(catalyst:*) Bash(npx -p @catalyst-cloud/cli catalyst:*) Bash(npx @catalyst-cloud/catalyst-skills:*)
|
|
4
|
+
Set up Catalyst Cloud and say whether setup is working. Walks a person from nothing to their first ticket running, one step at a time: the coding account, the project, the integrations and connected accounts, each repository's settings file, then one real ticket moving. Also logs this machine in, reads the readiness verdict with who can fix each failure, and checks the optional local replica. Use when someone says "set me up", "onboard me", "I just signed up", "get me started", "what do I do first", "log me in", "which account is this machine on", "am I set up", "what is missing", "why does nothing happen" or "is the replica running", when a login expired, or when a skill script exits 2 saying this machine is not connected. Does every step a key can do through the catalyst CLI, hands over the exact page for the steps only a browser can do, and never claims a step it did not watch succeed.
|
|
5
|
+
allowed-tools: Bash(catalyst:*) Bash(npx -p @catalyst-cloud/cli catalyst:*)
|
|
7
6
|
---
|
|
8
|
-
<!-- vendored-from: @catalyst-cloud/catalyst-skills@0.
|
|
7
|
+
<!-- vendored-from: @catalyst-cloud/catalyst-skills@0.13.1 — written in this repository for customer accounts -->
|
|
9
8
|
|
|
10
9
|
# Onboard me
|
|
11
10
|
|
|
12
|
-
You are the guide a new member gets on
|
|
11
|
+
You are the guide a new member gets on day one and comes back to when they ask whether setup still works: one step and one question at a time, saying why each step matters and checking it landed. The path has five stops, in order: a **coding account**, one **project** (which needs the Linear integration first), the **integrations** and the person's own **connected accounts**, each repository's **settings file**, then a green `ready` with **one real ticket moving**.
|
|
13
12
|
|
|
14
|
-
|
|
13
|
+
**Words:** **Workspace** is the person's whole cloud account (a command that prints `Tenant:` means it). **Project** is one Linear team plus its registered repositories. **Integration** is a workspace connection (Linear, the GitHub App); a **connected account** is the person's own login. **Coding account** is the AI provider login the work runs on.
|
|
15
14
|
|
|
16
|
-
##
|
|
15
|
+
## Which branch you are on
|
|
17
16
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
4. Stop. Wait for their answer.
|
|
22
|
-
5. When they answer, run the script again and read them the part that should have changed. If it changed, say so and move on. If it did not, refresh the contract once (`catalyst contract --refresh`) and read it again; if it still did not, say what the page told them and what the instrument says, and ask what they saw.
|
|
17
|
+
- **"Am I set up?", "what is missing?", "why does nothing happen?"** Run `node scripts/check.mjs`, read it with `references/reading-ready.md`, and end with the verdict and the who-can-click-what list.
|
|
18
|
+
- **Not connected, a login expired, "which account is this?"** `references/connecting-this-machine.md`.
|
|
19
|
+
- **"Is the replica running?", or local SQL.** `node scripts/local-sync.mjs`, then `references/local-sync.md`.
|
|
23
20
|
|
|
24
|
-
|
|
21
|
+
## How a turn goes on the path (first day, "what do I do first")
|
|
25
22
|
|
|
26
|
-
|
|
23
|
+
1. Run `node scripts/where-am-i.mjs --next` and read its one line; trust it over your memory of the last turn. A `note:` after it is worth one clause.
|
|
24
|
+
2. Say what the step is for.
|
|
25
|
+
3. Ask one question or do one thing. Run a `do:` command a key can run and show its output; hand over a browser step as `references/what-the-browser-owns.md` says.
|
|
26
|
+
4. Wait for the answer. Two or three short sentences a turn; the full report is for you, not to paste.
|
|
27
|
+
5. Re-run the script and read back the part that should have changed. Still unchanged after one `catalyst contract --refresh`: report both what the page said and what the instrument says.
|
|
27
28
|
|
|
28
|
-
|
|
29
|
+
## Run first
|
|
29
30
|
|
|
30
|
-
|
|
31
|
-
- `node scripts/where-am-i.mjs`: every part
|
|
32
|
-
- `node scripts/
|
|
33
|
-
- `node scripts/local-sync.mjs`: optional local replica and event
|
|
31
|
+
Scripts are run, never read; each prints `--help`.
|
|
32
|
+
- `node scripts/where-am-i.mjs [--next] [--json] [--repo <path>]`: every part of setup with its instrument, verdict, and who can fix what is unfinished; works before the machine is connected. A `note:` names a cancelled coding account, old-runtime leftovers (`catalyst legacy`), or a named checkout's agent-setup offers.
|
|
33
|
+
- `node scripts/check.mjs [--json]`: the `catalyst ready` verdict, with fix and owner under each failure. Exit 0 READY, 1 NOT READY, 2 not connected.
|
|
34
|
+
- `node scripts/local-sync.mjs [--start]`: the optional local replica and event cache; `--start` only once chosen.
|
|
34
35
|
|
|
35
36
|
## Load on demand
|
|
36
37
|
|
|
37
38
|
| when | read |
|
|
38
39
|
| -- | -- |
|
|
39
|
-
| walking the
|
|
40
|
-
|
|
|
41
|
-
|
|
|
42
|
-
| the
|
|
43
|
-
|
|
|
44
|
-
| the repository's
|
|
45
|
-
| the
|
|
46
|
-
|
|
|
47
|
-
|
|
|
48
|
-
| the machine will not connect, or a login expired | the `connect-me` skill |
|
|
49
|
-
| the person asks how to install, update, or migrate Catalyst skills | `references/skill-sources.md` |
|
|
50
|
-
| setup is finished and they want the standing readiness verdict | the `catalyst-setup` skill |
|
|
51
|
-
| the first ticket did not start and you need the reason | the `how-catalyst-works` skill, then `unstick` |
|
|
52
|
-
|
|
53
|
-
## Words
|
|
54
|
-
|
|
55
|
-
Use the product's words, and name the page label Settings shows today when it differs. **Workspace** is the whole customer account. **Project** is one Linear team plus the repositories registered to it. **Repository** is one `owner/name`. **Integration** is a workspace-level connection, the Linear connection or the GitHub App (the page is Settings → Connections). **Connected account** is the person's own Linear or GitHub login. **Member** is a person who can sign in. A **coding account** is an AI provider login the work runs on (Settings → AI accounts). Say "tenant" and "org" only when quoting a command's output.
|
|
40
|
+
| walking the path, step by step | `references/the-one-path.md` |
|
|
41
|
+
| logging in, a refused or expired login, which account this is, the Linear identity | `references/connecting-this-machine.md` |
|
|
42
|
+
| anything reports not ready, a check id, or who fixes something | `references/reading-ready.md` |
|
|
43
|
+
| the coding account or the `host` part, or before saying work can run | `references/what-a-phase-needs.md`; a credential to replace, `references/replacing-a-credential.md` |
|
|
44
|
+
| a browser step, or confirming a page that said it worked | `references/what-the-browser-owns.md` |
|
|
45
|
+
| the repository's `.catalyst/catalyst.toml` and its approval; its AGENTS.md block and agent layout | `references/declaring-a-repository.md`; `references/repository-agent-setup.md` |
|
|
46
|
+
| the replica or event cache | `references/local-sync.md` |
|
|
47
|
+
| installing, updating, or migrating Catalyst skills | `references/skill-sources.md` |
|
|
48
|
+
| what Catalyst is, or why the first ticket did not start | the `whats-happening` skill, then `unstick` if something holds it |
|
|
56
49
|
|
|
57
50
|
## Rules
|
|
58
51
|
|
|
59
|
-
- **One step, then stop.**
|
|
60
|
-
- **
|
|
61
|
-
- **
|
|
62
|
-
- **
|
|
63
|
-
- **
|
|
64
|
-
- **
|
|
65
|
-
- **
|
|
66
|
-
- **
|
|
67
|
-
- **Not ready is a question about who.** Name which check, who can fix it, and where. If the owner is not the person in front of you, say so and stop.
|
|
68
|
-
- **Never invent a count or a list.** Every number and every name comes from what a command printed.
|
|
69
|
-
- **Provider consent belongs to the person in a browser.** Login approval, the workspace's Linear connection and GitHub App install, and the person's own connected accounts. Give the printed URL, then check `status`. Never claim a grant succeeded because a browser opened.
|
|
70
|
-
- **Team setup is CLI work now; two steps still are not.** `team list`, `team check`, `team map`, `team adopt`, `team migrate` and `team checklist` run with the person's own login: show each preview, and pass `--yes --plan-hash` only after they approve that exact plan. `catalyst capabilities` says what this CLI can do on this cloud, and the script consults it and the person's role before it names a command or a page. Registering a repository and approving one repository's settings file are settings-page work today; route those through the browser and say plainly that it is a gap, not the design. Never guess at a route.
|
|
71
|
-
- **The workspace-wide environment declaration is the one setup write you can perform.** `catalyst environment` reads it, proposes it and approves it.
|
|
72
|
-
- **Local sync is opt-in.** API-backed skills work without it. Ask before running `local-sync.mjs --start`; a detached process starting is not evidence of freshness. See `references/local-sync.md`.
|
|
73
|
-
- **A cancelled or ended coding account is kept, not retired.** It stays for reporting, is not used, and is never given a new token; a token minted from a live login must never land on it. Reactivating it is the person's call if the subscription comes back. Never tell anyone to retire or delete it.
|
|
74
|
-
- **Their workspace, as them.** Everything goes through the CLI and the person's own login. You never name another workspace, never ask for a key you could avoid, and never see a credential or a secret's value.
|
|
75
|
-
- **Ask once before you write to their machine or their repository.** Say what you found, what you will write and where, then wait for a yes.
|
|
76
|
-
- **A blocked command is the person's call.** If the harness blocks `npx`, a global install, or a tool, ask or hand them the command. Never skip it silently, never edit your own permission settings.
|
|
77
|
-
- **An older cloud is not a broken command.** When the CLI says the cloud is older than the bundle, say so and move on.
|
|
78
|
-
- **Stop at a wall you cannot pass.** A suspended workspace, a seat that is not active, a person who is not an owner or admin where one is required: say what you found, name who can act, and stop.
|
|
79
|
-
- **Write like a capable colleague.** Plain words, short sentences, one idea each, active voice, warm and unhurried. No em dashes, no emoji, no chatbot openers or flattery, and bold only the rare thing. Reread each message before you send it.
|
|
52
|
+
- **One step, then stop.** Open with the step. One question has one answer: a yes-or-no, or one fact. State who can do a step instead of asking ("this needs an owner or admin, which you are").
|
|
53
|
+
- **Report what you observed.** Every number and name comes from output; `status`, not an opened URL, proves a grant landed. Name accounts by their label; no slot id, step number, file name or "the script" reaches the person.
|
|
54
|
+
- **Each part by its own instrument;** a project problem is never a machine problem. Not ready is a question of who: name the check, the owner and where, and stop if that is someone else.
|
|
55
|
+
- **Previews before project writes.** `team map`, `team adopt` and `team migrate` preview; pass `--yes --plan-hash` only after the person approves that exact plan.
|
|
56
|
+
- **Their machine and their repository need a yes,** a login included. Say what you will write and where, then wait.
|
|
57
|
+
- **Local sync is opt-in.** Every skill works through the API without it; a started process is not proof of freshness.
|
|
58
|
+
- **Stop at a wall.** A suspended workspace, an inactive seat, an owner or admin needed where the person is neither, a blocked command: say what you found and who can act, then stop. An older cloud is not a broken command. A person with no account joins one by invitation from its admin.
|
|
59
|
+
- **Write like a capable colleague:** plain words, short sentences, warm and unhurried.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
interface:
|
|
2
2
|
display_name: "Onboard me"
|
|
3
|
-
short_description: "
|
|
3
|
+
short_description: "Set up Catalyst Cloud one step at a time, log this machine in, and say whether setup is ready and who fixes what is missing"
|
|
4
4
|
default_prompt: "Use $catalyst-onboard to set me up on Catalyst Cloud, one step at a time."
|
|
5
5
|
policy:
|
|
6
|
-
allow_implicit_invocation:
|
|
6
|
+
allow_implicit_invocation: true
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Connecting this machine
|
|
2
|
+
|
|
3
|
+
## Which cloud account is this machine on
|
|
4
|
+
|
|
5
|
+
`catalyst status` prints the account on its `Tenant:` line, the API, and the config paths. Say "your cloud account" and its name. The credential is the only account selector; there is no `--account`. If the cloud names no account for the login, stop and say so.
|
|
6
|
+
|
|
7
|
+
## Logging in
|
|
8
|
+
|
|
9
|
+
Keyless is the preferred rail: `catalyst login` with no key prints a short code and a URL the person approves in a browser, or from a phone. Ask first, and run it once per code. The session refreshes silently, so they stay connected for months.
|
|
10
|
+
|
|
11
|
+
A **personal key** is the fallback for a script or an unattended shell. Any active member mints one at Settings → API keys. The environment form keeps it out of shell history:
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
CATALYST_CLOUD_TOKEN=<your-personal-key> catalyst login
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
`CATALYST_CLOUD_BASE_URL` or `--base-url` pins a non-default cloud. The account key (`ctc_acct_`) belongs to hosts and runners: a person connected with it has no name on anything their agent writes, and "what needs me" cannot mean them.
|
|
18
|
+
|
|
19
|
+
## An unmatched Linear identity
|
|
20
|
+
|
|
21
|
+
An unmatched Linear identity is the person's to match: `catalyst identity linear status`, then `catalyst identity linear options`; they pick their own listed identity and you run `catalyst identity linear set <linearUserId>`. An identity someone else claimed, and an inactive seat, need an owner or admin at Settings → Members. Connecting Linear personally does not set the identity: the identity and the personal grant are two different stored facts. Until the identity is matched, "what needs me" shows everyone's asks.
|
|
22
|
+
|
|
23
|
+
## What login writes
|
|
24
|
+
|
|
25
|
+
`~/.config/catalyst-cloud/customer.json` (mode 0600) holds the credential, the resolved account and person, and this CLI's path for skill scripts; `contract.json` beside it caches the contract. `CATALYST_SKILLS_HOME` moves the directory. With no home directory (a container, or `HOME` unset or `/`) the config lands under `/`: stop, confirm this is the person's own machine, and set `CATALYST_SKILLS_HOME` if it is. Login installs no skills (`references/skill-sources.md`).
|
|
26
|
+
|
|
27
|
+
## When login fails
|
|
28
|
+
|
|
29
|
+
- **"Your login expired or was revoked."** One fresh `catalyst login`.
|
|
30
|
+
- **A 401 on the key rail.** A stale, mistyped or revoked key: mint a new one at Settings → API keys.
|
|
31
|
+
- **A 403 on the contract naming an older cloud.** The cloud lacks personal-key access: update the cloud, or use the account key until then.
|
|
32
|
+
- **A line naming two contract versions.** `npm install -g @catalyst-cloud/cli@latest && catalyst login` before using the other skills.
|
|
33
|
+
- **A refusal naming `jwt-no-membership`.** The cloud learns of a person at their first sign-in to the app. Have them sign in once, then log in again. If it repeats, their seat is inactive and an owner or admin activates it.
|
|
34
|
+
|
|
35
|
+
Retry a failed login once, by hand, after the fix. A key goes into the login command or `CATALYST_CLOUD_TOKEN` and nowhere else: never a ticket, a transcript, or a file you write. After a bundle update, the next command prints a one-line notice; read it to the person if they are watching.
|
|
@@ -1,20 +1,17 @@
|
|
|
1
1
|
# Declaring what one repository's containers need
|
|
2
2
|
|
|
3
|
-
The cloud containers build and test the repository
|
|
4
|
-
|
|
5
|
-
This is step 8 of `references/the-one-path.md`. Offer to draft the file from the repository's own build files, say which files you will read and what you will write, and wait for a yes before you write anything. If the repository already has one, verify it against the inventory below instead of rewriting it.
|
|
3
|
+
The cloud containers build and test the repository and need the names of the variables and secrets it reads. You write the names; the person enters the values in the app. Never read or print a value. Say which files you will read and what you will write, and wait for a yes. An existing file gets verified against the inventory, not rewritten.
|
|
6
4
|
|
|
7
5
|
## The inventory, in order
|
|
8
6
|
|
|
9
|
-
1. Start from
|
|
10
|
-
2.
|
|
11
|
-
3.
|
|
12
|
-
4.
|
|
13
|
-
5. Write the names into `.catalyst/catalyst.toml` and open a pull request. Use that exact path. The cloud reads no other file, and an older `catalyst.env.json` is ignored. Once the pull request merges, each push to the default branch that touches the file makes the cloud read it and propose it as a new revision. A tenant owner or admin opens Settings → Repositories → the repository → Environment → Setup declaration and clicks Approve this revision. The person enters the values on the same page's Environment variables and Secrets tabs.
|
|
7
|
+
1. Start from what builds and tests the repository: the README's setup section, the scripts in `package.json` or its equivalent, and CI's build and test steps. A name none of them reads does not belong in the file.
|
|
8
|
+
2. Tie each name to the file it came from: a `.env.example` (never `.env`, which holds live values), a CI secret in a workflow's `env:` block, or a platform binding. A name you cannot tie to a file is a guess; say so instead of listing it.
|
|
9
|
+
3. Leave out platform bindings and deploy-only secrets, since containers build and test but never deploy, unless the person says the build needs one.
|
|
10
|
+
4. Write the names into `.catalyst/catalyst.toml`, the only file the cloud reads, and open a pull request. Each merged change to it is proposed as a new revision, which an owner or admin approves at Settings → Repositories → the repository → Environment → Setup declaration → Approve this revision; the person enters values on that page's Environment variables and Secrets tabs.
|
|
14
11
|
|
|
15
12
|
## The file's shape
|
|
16
13
|
|
|
17
|
-
`[project]` with `linear_team` is required
|
|
14
|
+
`[project]` with `linear_team` is required; every other section is optional.
|
|
18
15
|
|
|
19
16
|
```toml
|
|
20
17
|
#:schema https://staging.catalystcloud.dev/schemas/catalyst.schema.json
|
|
@@ -36,11 +33,4 @@ name = "install"
|
|
|
36
33
|
run = ["npm", "ci"]
|
|
37
34
|
```
|
|
38
35
|
|
|
39
|
-
|
|
40
|
-
- Each `[[environment.variables]]` entry names one variable and says whether it is `required`. Add `secret = true` for a secret. Names only: a value never goes in this file.
|
|
41
|
-
- `[[environment.setup]]` steps carry this repository's own install commands. `run` is an argument list, not a shell string, and `name` is kebab-case. `verify` steps have the same shape and carry the test commands. `toolchains`, `system_packages`, `services` and the other `[environment]` tables are optional; the schema lists their fields.
|
|
42
|
-
- The `#:schema` line lets an editor check the file as you type.
|
|
43
|
-
|
|
44
|
-
## After the merge
|
|
45
|
-
|
|
46
|
-
`catalyst ready` reports `environment_declared` for the team's default repository and names the next step: commit the file, fix it, or approve it. The `catalyst-setup` check table has each reason. The workspace-wide declaration is separate; `catalyst environment` handles it (also step 8 of `references/the-one-path.md`).
|
|
36
|
+
`linear_team` is the Linear team's key. `run` is an argument list, not a shell string, and `name` is kebab-case; `verify` steps share the shape and carry the test commands. The schema lists the optional tables (`toolchains`, `system_packages`, `services`). After the merge, `catalyst ready` reports `environment_declared` with the next step.
|
|
@@ -1,15 +1,27 @@
|
|
|
1
|
-
#
|
|
1
|
+
# The optional local replica and event cache
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The replica is an on-machine SQLite copy of the account for cheap repeated reads and ad hoc SQL; the event cache holds recent events. Every skill works without them through the API, which is origin-fresh. Start a background writer only when the person asks for local data.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## The replica's exit codes
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
`catalyst replica status` needs no network. Exit 0 is fresh (a live writer, a heartbeat under 15 seconds, a cursor), and skills read the replica. Exit 1 is stale and 3 is absent; skills read the API, and `catalyst replica start --detach` restarts a stale one. Exit 2 is not connected (`references/connecting-this-machine.md`). `--probe` adds one network call comparing the local cursor with the cloud head. Every read verb names its source on standard error.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
## Checking and starting both
|
|
10
|
+
|
|
11
|
+
`node scripts/local-sync.mjs` shows the local state. Only after the person opts in, `--start` starts the replica and event cache writers and waits up to 90 seconds (`--wait <seconds>`, 0 to 300).
|
|
12
|
+
|
|
13
|
+
Say `Local sync current` only when both writers have live heartbeats and each cursor equals its cloud head. A detached process starting, one fresh heartbeat, or replica freshness alone does not prove event freshness. `catalyst replica status --probe --json` checks the replica cursor; `catalyst events status --probe --json` checks the separate event cursor. Unknown means the comparison could not be proved, which is not stale. The script exits 0 current, 1 stale, 3 absent, and 2 for "not connected" or "unknown", with a printed reason. After a restart, check again before relying on local data.
|
|
10
14
|
|
|
11
15
|
## First ticket event
|
|
12
16
|
|
|
13
|
-
|
|
17
|
+
Before the person moves a card, run `node scripts/local-sync.mjs --start` (after they opt in) and wait until it reports current. Then run `catalyst events status --probe --json` and record its `cursor` as `<cursor-before-move>`. Move the card only after this baseline is captured. Then run `catalyst events wait-for --ticket <ticket-identifier> --after <cursor-before-move> --timeout 300` with the identifier `explain` printed, and no guessed event type. The explicit cursor finds an event that reached the cache before the command began.
|
|
18
|
+
|
|
19
|
+
Exit 0 prints a matching event after the baseline, proving it reached this machine's cache. Exit 1 means no matching cached event arrived within five minutes; recheck `node scripts/local-sync.mjs` and report stale or unknown evidence without inferring a cloud or webhook failure. Exit 3 means the event cache is absent; ask before starting it. Other errors are unknown. `explain` stays the API-backed answer to why a ticket can or cannot run.
|
|
20
|
+
|
|
21
|
+
## The writer
|
|
22
|
+
|
|
23
|
+
`catalyst replica --help` lists `start`, `stop`, `sql` and `schema`. It needs Node 22.15 or newer, or bun 1.4 or newer, and its files stay bounded under `~/.config/catalyst-cloud/`. The first start seeds the whole snapshot before going live, so `status` reads stale until the cursor appears; ask again after the live line, or watch `status --probe` count down. The lock refuses a second writer on the same file.
|
|
24
|
+
|
|
25
|
+
The writer backs off after a failed snapshot pull and gives up after five consecutive snapshot failures; `catalyst replica status` and `catalyst ready` then name the stopped state, the last error and the restart command, and the file reads stale (exit 1).
|
|
14
26
|
|
|
15
|
-
|
|
27
|
+
To survive a reboot, run `catalyst replica start` without `--detach` under the platform's supervisor: a launchd agent with `KeepAlive` on macOS, a systemd user unit with `Restart=on-failure` on Linux (plus `loginctl enable-linger $USER` to run while logged out), or a Task Scheduler task at logon on Windows.
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# Reading `catalyst ready`: what each check proves and who fixes it
|
|
2
|
+
|
|
3
|
+
Read this before telling a person something is not ready or what to do about it. `catalyst ready` prints one verdict over the machine and every project; `node scripts/check.mjs` adds each failure's fix and owner and a "who can click what" list.
|
|
4
|
+
|
|
5
|
+
## The parts, and the instrument that owns each
|
|
6
|
+
|
|
7
|
+
| part | instrument | a pass does not prove |
|
|
8
|
+
| -- | -- | -- |
|
|
9
|
+
| **machine** | `catalyst status`, and the machine checks of `ready` | anything about the cloud account |
|
|
10
|
+
| **person** | `catalyst me`, `catalyst connections personal <linear|github> status` | an active seat (an owner or admin fixes it in Settings → Members) |
|
|
11
|
+
| **account** | `catalyst contract --path account` (a resolved Linear workspace) | that the GitHub App is installed |
|
|
12
|
+
| **project** | `catalyst team list`, then `team check <KEY>` and the `team:` checks of `ready` | that an unchecked team is ready |
|
|
13
|
+
| **repository** | `catalyst contract --path merge.repositories` | that it is active, attached to a project, or declared |
|
|
14
|
+
| **repository declarations** | `environment_declared` in `catalyst contract --path teams` | that the values behind the names exist |
|
|
15
|
+
| **coding accounts**, **host** | `references/what-a-phase-needs.md` | that a phase has headroom |
|
|
16
|
+
|
|
17
|
+
⛔ **An empty contract project list means nothing is mapped yet**; pick one from `catalyst team list`. `team check --all` checks every team and may file an ask for each. ⛔ **A registered repository is not a dispatchable one**; if a card does not start, `catalyst explain <ticket>` names the reason.
|
|
18
|
+
|
|
19
|
+
## Triaging NOT READY
|
|
20
|
+
|
|
21
|
+
Split the verdict first. In `catalyst ready --json`, an id that begins with `team:` is a **project** finding; the rest are **machine** findings. Report the two groups separately, machine first, each with its owner, its `pass`, `fail` and `unknown` counts, and when each team verdict was computed (`teams[].readiness.checkedAt`, null before any pass).
|
|
22
|
+
|
|
23
|
+
- **A machine check failed:** the person's, here, now. Do its `fix` line.
|
|
24
|
+
- **A project check failed:** name the check, the project and the `who`. A mapping is repaired with `catalyst team check`, `team map` or `team adopt`; a Linear connection, permission or team setting in a browser. Re-running `ready` fixes nothing.
|
|
25
|
+
- **A note** never moves the verdict; waiting is not failing, and unknown is not a pass.
|
|
26
|
+
|
|
27
|
+
End every readiness answer with the verdict and the who-can-click-what list, in that order. Run each check once; waiting for one to clear is the project owner's watch (`run-this-project`).
|
|
28
|
+
|
|
29
|
+
## The checks
|
|
30
|
+
|
|
31
|
+
The contract's `readinessChecks[]` is the list of record, with each check's severity; `teams[].readiness` holds each team's states. A check listed there and not here is newer than this page: `node scripts/check.mjs` still prints its line, fix and owner, so read that and say you did.
|
|
32
|
+
|
|
33
|
+
A team is `ready`, `degraded`, `blocked` or `unchecked` (no pass yet, a note). Severity decides whether a failing check blocks, degrades or only informs; an unknown (the engine could not look) degrades regardless. Readiness is stamped with the mapping revision it read, so a stale verdict shows as stale.
|
|
34
|
+
|
|
35
|
+
| check id | proves | when it fails | who clicks |
|
|
36
|
+
| -- | -- | -- | -- |
|
|
37
|
+
| `oauth_scope` | the Linear connection has the permissions it needs | re-authorise it | owner or admin, in settings |
|
|
38
|
+
| `token_live` | the Linear connection is accepted now | reconnect if expired, revoked or never connected; re-check if Linear was unreachable | owner or admin |
|
|
39
|
+
| `team_visible` | Catalyst can see the team | usually it went private: grant access in Linear | owner or admin, in Linear |
|
|
40
|
+
| `mapped_states_exist` | every mapped stage still exists | `catalyst team map <KEY>`; `stages_pending_write` means a mapping was just saved, so wait | owner or admin |
|
|
41
|
+
| `mapping_total` | every stage Catalyst moves tickets into is mapped | map them ("absent": never mapped) | owner or admin |
|
|
42
|
+
| `types_compatible` | each load-bearing stage is the right kind (dispatch and intake unstarted or backlog, PR started, done completed, canceled canceled) | map a stage of the right kind | owner or admin |
|
|
43
|
+
| `labels_present` | Catalyst's labels exist | none: they are created on first use | nobody |
|
|
44
|
+
| `writes_land` | Catalyst has written to the team | `no_write_observed` clears on the first move; a refused write: check the connection and permissions | owner or admin when refused; otherwise nobody |
|
|
45
|
+
| `webhook_covers_team` | the team's events arrive | `no_delivery_observed` clears once a registered repository's events flow | owner or admin, by registering the repository |
|
|
46
|
+
| `hosts_current` | no connected host runs an older mapping | `references/what-a-phase-needs.md`; `no_host_connected` is waiting | whoever runs that host |
|
|
47
|
+
| `environment_declared` | the default repository's `.catalyst/catalyst.toml` is ingested, valid and approved | the reason names the step: register a default repository, commit or fix the file, or approve it (`references/declaring-a-repository.md`) | owner or admin, except committing the file, which is whoever can push |
|
|
48
|
+
| `tools_resolvable` | every MCP server and CLI the declaration names resolves | `tool_reference_unresolved`: add the secret or fix the declaration; `toolchain_cli_missing` is not self-service | owner or admin, in the declaration or Settings → Environment |
|
|
49
|
+
| `reviewer_required` | the repository can merge under its policy | a strict policy with no reviewer: configure one at Settings → Repositories → Code reviews, or relax the policy; only the merge waits | owner or admin, in settings |
|
|
50
|
+
| `reviewer_configured` | a code reviewer is configured at all | configure one there; a fail never blocks or degrades | owner or admin, in settings; nobody is required when it fails |
|
|
51
|
+
|
|
52
|
+
## The machine checks the CLI adds
|
|
53
|
+
|
|
54
|
+
Each failing line prints its own fix.
|
|
55
|
+
|
|
56
|
+
| id | proves |
|
|
57
|
+
| -- | -- |
|
|
58
|
+
| `runtime` | this runtime can run the CLI: Node 22.15+ or bun 1.4+. The fix, `npx -y -p @catalyst-cloud/cli catalyst runtime install`, puts a pinned Node in the CLI's cache and leaves the default Node alone |
|
|
59
|
+
| `config` | `customer.json` exists and loads (`references/connecting-this-machine.md`) |
|
|
60
|
+
| `contract` | the contract is cached and its major version is in this bundle's range |
|
|
61
|
+
| `bundle` | the CLI meets the account's minimum version; a note |
|
|
62
|
+
| `cliPath` | the CLI path recorded at login still exists |
|
|
63
|
+
| `skills` | the Cloud pack's copied skills are all present; a pack installed another way reads as a note (`references/skill-sources.md`) |
|
|
64
|
+
| `cliRelease` | the CLI is not behind the newest release; a note |
|
|
65
|
+
| `skillsRelease` | the skill files are not behind the newest bundle; "could not run" means the registry was unreachable |
|
|
66
|
+
| `sdk` | the SDK loads, so the replica and the watch are available; reads work through the API meanwhile |
|
|
67
|
+
| `replica` | the optional replica is fresh; a note (`references/local-sync.md`) |
|
|
68
|
+
|
|
69
|
+
## Setting up one team at a time
|
|
70
|
+
|
|
71
|
+
A team receives work once its stages are saved. Saving one team changes no other team's stages or tickets; only the labels Adopt creates are shared. Once saved, tickets in its dispatch stage start, so pilot on a low-stakes team and first move anything there that should wait back to Backlog. Nothing reads `gitAutomation` in the contract.
|
|
72
|
+
|
|
73
|
+
Each action exists in the terminal and on `<their cloud>/settings/linear-teams`:
|
|
74
|
+
|
|
75
|
+
- **Check** (`catalyst team check <KEY>`, Re-check) saves the team's verdict, changing no ticket or mapping, and files one setup ticket for an admin if something is missing.
|
|
76
|
+
- **Map** (`catalyst team map <KEY>`, Map my stages) saves a mapping from the team's existing stages and creates nothing in Linear.
|
|
77
|
+
- **Adopt** (`catalyst team adopt <KEY>`, Adopt the Catalyst workflow) creates the missing stages and Catalyst's labels with the admin's own Linear authorisation, including the hold label a failed phase uses when the team has no remediate stage (`teams[].labels.hold`). The label alone means nothing failed.
|
|
78
|
+
|
|
79
|
+
Map when the team's stages already cover the work, Adopt when they do not.
|
|
@@ -1,51 +1,26 @@
|
|
|
1
1
|
# Replacing a coding account's credential
|
|
2
2
|
|
|
3
|
-
When the script prints "<provider> account <slot> needs a new credential", replace that account's credential on its own page. Do not enroll a second account.
|
|
4
|
-
|
|
5
|
-
## Why an account needs one
|
|
6
|
-
|
|
7
|
-
The script flags an account in three cases:
|
|
8
|
-
|
|
9
|
-
- it is quarantined;
|
|
10
|
-
- it is expired or revoked;
|
|
11
|
-
- its last polls failed on the credential itself, such as `no_access_token`, three or more times in a row. The script can see this only when the cloud reports each account's polls.
|
|
12
|
-
|
|
13
|
-
Other accounts can be healthy at the same time. The contract can still say `enrolled`, so that line alone never proves every account works.
|
|
14
|
-
|
|
15
|
-
## Who does it
|
|
16
|
-
|
|
17
|
-
A tenant owner or admin, in the browser. The person copies the credential and pastes it. You never read it, print it, or paste it. The script prints the page link; use it, and never type a host.
|
|
3
|
+
When the script prints "<provider> account <slot> needs a new credential" (quarantined, expired, revoked, or three or more polls failed on the credential), replace that account's credential on its own page. Do not enroll a second account. It would be a duplicate beside the dead one. A workspace owner or admin does it in the browser, from the link the script prints; the person copies and pastes the credential, and you never read, print or paste it.
|
|
18
4
|
|
|
19
5
|
## Codex
|
|
20
6
|
|
|
21
7
|
The person runs these steps on their own machine:
|
|
22
8
|
|
|
23
9
|
1. Run `codex login` and choose "Sign in with ChatGPT".
|
|
24
|
-
2. The login writes `~/.codex/auth.json
|
|
25
|
-
3. In the browser, open Settings → AI accounts, then
|
|
10
|
+
2. The login writes `~/.codex/auth.json`, or `$CODEX_HOME/auth.json` when `CODEX_HOME` is set. On macOS, `pbcopy < ~/.codex/auth.json` copies it.
|
|
11
|
+
3. In the browser, open Settings → AI accounts, then that Codex account.
|
|
26
12
|
4. Paste the file into "Replacement auth.json contents", then press Replace credential.
|
|
27
13
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
Say these two things plainly:
|
|
31
|
-
|
|
32
|
-
- Do not enroll a second account. Replace the credential on the one the script named.
|
|
33
|
-
- Catalyst takes over this login. Its refresh token is single-use, so the copy on this machine stops working once Catalyst uses it. To use Codex locally, sign in to Codex again, separately, after the replacement.
|
|
14
|
+
Say plainly that Catalyst takes over this login: its refresh token is single-use, so the local copy stops working once Catalyst uses it, and to use Codex locally they sign in to Codex again, separately, after the replacement.
|
|
34
15
|
|
|
35
16
|
## Claude
|
|
36
17
|
|
|
37
|
-
The
|
|
38
|
-
|
|
39
|
-
## A cancelled or ended account
|
|
40
|
-
|
|
41
|
-
An account whose subscription is cancelled, or which has ended, is not a credential problem, and no token revives it. It stays enrolled for reporting, is not used, and is not something to retire or delete. Never replace its credential with a token from another account: that puts a working account's login onto a dead slot. If the subscription is live again, the person reactivates it on its own page.
|
|
18
|
+
The field is "Replacement setup token". `claude setup-token` mints a token for whichever account the terminal is logged into, not for the slot, so match them first: compare the slot's email on the AI accounts page with what `/status` in `claude` shows, and log in to the slot's account if they differ. Then run `claude setup-token`, paste the token, and press Replace credential.
|
|
42
19
|
|
|
43
20
|
## Any other provider
|
|
44
21
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
## What Replace credential does
|
|
22
|
+
The same page, with the credential it asks for. A cancelled or ended account is not a credential problem, and no token revives it.
|
|
48
23
|
|
|
49
|
-
|
|
24
|
+
## Afterwards
|
|
50
25
|
|
|
51
|
-
|
|
26
|
+
Replace credential also clears the quarantine; no operator is needed. Run `node scripts/where-am-i.mjs` again. A failed poll stays on record until the next poll, so if the script still names the account, wait for that poll before reporting a disagreement.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# The repository's agent setup
|
|
2
|
+
|
|
3
|
+
Two CLI verbs, both on a checkout the person names, both writing only to its working tree. Nothing here pushes or reaches the cloud; the branch, commit and pull request are the person's, never on the default branch. When `catalyst capabilities` lacks `repo agents-block` and `repo agent-setup`, say the CLI is older and skip this; never paste the block by hand.
|
|
4
|
+
|
|
5
|
+
Say in one clause what the report found ("CLAUDE.md carries your guidance, there is no AGENTS.md, and `.claude/skills` is a real directory"), then offer each write below after its own yes, in the same pull request as the settings file when that is open.
|
|
6
|
+
|
|
7
|
+
## The Catalyst block in AGENTS.md
|
|
8
|
+
|
|
9
|
+
`catalyst repo agents-block <path>` reads AGENTS.md as `absent`, `missing` (no block), `stale` (words differ from this CLI's) or `current`. `--write` creates the file, appends the block, or replaces the region between `<!-- catalyst:start -->` and `<!-- catalyst:end -->`; a rerun changes nothing. The block says the repository is worked through Catalyst and names the skills that explain the process; it carries no process of its own, so it never goes stale with the pipeline.
|
|
10
|
+
|
|
11
|
+
## The portable layout
|
|
12
|
+
|
|
13
|
+
`catalyst repo agent-setup <path>` reports AGENTS.md (size, block state), CLAUDE.md (whether a line is exactly `@AGENTS.md`, and its own line count), `.agents/skills|rules` and `.claude/skills|rules` (absent, real directory, or symlink and target), and other agent files it saw (`.codex`, `.cursor`, `GEMINI.md`), then one verdict:
|
|
14
|
+
|
|
15
|
+
- **portable**: AGENTS.md is canonical, CLAUDE.md imports it, each `.claude/` twin is absent or a relative symlink into `.agents/`. Offer only the block if it is missing.
|
|
16
|
+
- **convertible**: the report lists the plan (CLAUDE.md's guidance moves into AGENTS.md and CLAUDE.md becomes `@AGENTS.md` plus Claude-only notes; `.claude/skills|rules` move to `.agents/` behind a relative symlink). `--apply` does exactly that.
|
|
17
|
+
- **needs a hand merge**: both directories are real, or a symlink points elsewhere. `--apply` refuses and names each blocker.
|
|
18
|
+
|
|
19
|
+
Portable means one AGENTS.md serves every coding agent, so a second harness finds the same instructions and skills without a drifting copy.
|
|
20
|
+
|
|
21
|
+
`--with-check` writes `scripts/agents-md-check.mjs`, a dependency-free CI script that fails when CLAUDE.md stops importing AGENTS.md, a `.claude/` twin stops being a relative symlink into `.agents/`, AGENTS.md outgrows 120 lines or 16 KiB (`AGENTS_MD_MAX_LINES`, `AGENTS_MD_MAX_BYTES`), or a backticked path it cites is gone. The person wires it into CI.
|
|
22
|
+
|
|
23
|
+
**Read back:** rerun `catalyst repo agent-setup <path>` after any write. Exit 0 is portable with the block current; exit 1 lists what is still open.
|
|
@@ -1,38 +1,32 @@
|
|
|
1
1
|
# Catalyst skill sources
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
The installer the person ran first, at their cloud's `/install.sh` (the app's setup page shows the command), installs both packs in one pass. It stages them with a pinned skills CLI, installs exact commits, and stops on any same-named skill it does not recognise, naming the path. A home install schedules a daily refresh that also picks up new skills. Re-run it to refresh or repair either pack. The commands in the table are the by-hand equivalent.
|
|
3
|
+
The installer at the cloud's `/install.sh` (the app's setup page shows the command) installs both packs from exact commits, stops on any same-named skill it does not recognise, and on a home install schedules a daily refresh. Re-run it to refresh or repair; the table is the by-hand equivalent.
|
|
6
4
|
|
|
7
5
|
| Pack | Purpose | By hand | Optional Claude Code plugin |
|
|
8
6
|
| -- | -- | -- | -- |
|
|
9
|
-
| `coalesce-labs/catalyst-cloud-skills` |
|
|
7
|
+
| `coalesce-labs/catalyst-cloud-skills` | Cloud account setup and operation | `npx skills@latest add coalesce-labs/catalyst-cloud-skills --all -g` | `catalyst@catalyst-cloud` |
|
|
10
8
|
| `coalesce-labs/catalyst-dev-skills` | Coding workflows | `npx skills@latest add coalesce-labs/catalyst-dev-skills --all -g` | `catalyst-dev@catalyst-dev-skills` |
|
|
11
9
|
|
|
12
|
-
Install
|
|
10
|
+
Install each pack by one method: `npx skills` or its plugin.
|
|
13
11
|
|
|
14
12
|
## Where each install lands
|
|
15
13
|
|
|
16
|
-
|
|
17
|
-
- Project (no `-g`): `.agents/skills/`, `.claude/skills/` and `skills-lock.json` at the project root. Nothing lands in the home directory.
|
|
18
|
-
- The global lock is `$XDG_STATE_HOME/skills/.skill-lock.json` when `XDG_STATE_HOME` is set, else `~/.agents/.skill-lock.json`. A project uses its own `skills-lock.json`.
|
|
19
|
-
- The installer writes relative links. Resolve each with `readlink -f` before you compare paths.
|
|
20
|
-
|
|
14
|
+
Global (`-g`) installs go to `~/.agents/skills/`, linked from `~/.claude/skills/`, with the lock at `$XDG_STATE_HOME/skills/.skill-lock.json` or `~/.agents/.skill-lock.json`. Project installs go to `.agents/skills/` and `.claude/skills/` with `skills-lock.json`. Links are relative; resolve each with `readlink -f` before comparing paths.
|
|
21
15
|
|
|
22
|
-
|
|
16
|
+
`npx skills add --all` replaces same-named directories and links. Before running it on an existing machine, inspect every same-named destination and proceed only when each is absent or a verified, unmodified copy of the intended pack (a lock entry verifies nothing on disk). Resolve any other copy first. Schedule only the installer, never raw add commands.
|
|
23
17
|
|
|
24
18
|
## Is each pack there
|
|
25
19
|
|
|
26
|
-
`catalyst ready` checks the Cloud pack only.
|
|
20
|
+
`catalyst ready` checks the Cloud pack only. Look for `catalyst-onboard/SKILL.md` (Cloud) and `research-codebase/SKILL.md` (development) in the intended directory.
|
|
27
21
|
|
|
28
|
-
##
|
|
22
|
+
## Migrating an existing installation
|
|
29
23
|
|
|
30
24
|
Inventory source and scope before removing anything:
|
|
31
25
|
|
|
32
|
-
1.
|
|
33
|
-
2. Inspect the
|
|
34
|
-
3.
|
|
35
|
-
4. Install the replacement
|
|
36
|
-
5. Read back the plugin list,
|
|
26
|
+
1. `claude plugin list`: record whether `catalyst-dev@catalyst` is installed, and at which scope.
|
|
27
|
+
2. Inspect the home and project skill directories separately, with their locks and provenance markers; a folder name does not prove its source, and `.claude/skills` may link elsewhere.
|
|
28
|
+
3. Remove only `catalyst-dev@catalyst`: `claude plugin uninstall catalyst-dev@catalyst --scope user --keep-data --yes`. For a copied skill whose lock source is the deprecated Catalyst runtime repository, `npx skills remove <name> -g -y` (no `-g` for a proven project install), and only when every agent path with that name is that copy or a link to it. Remove by name, never with `--all`.
|
|
29
|
+
4. Install the replacement packs in the intended scope with the commands above.
|
|
30
|
+
5. Read back the plugin list, each changed lock and the folders, and start a new agent session after a plugin change.
|
|
37
31
|
|
|
38
|
-
|
|
32
|
+
Keep any Catalyst checkout, local project data, and same-named skill of unknown source; if source or scope is ambiguous, stop and report it.
|