@catalyst-cloud/cli 0.9.4 → 0.9.5
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 +12 -0
- package/README.md +35 -31
- package/dist/args.js +13 -1
- package/dist/ask.js +2 -2
- package/dist/capabilities.js +70 -0
- package/dist/cli.js +37 -29
- package/dist/config.js +1 -1
- package/dist/connections.js +5 -5
- package/dist/environment.js +4 -4
- package/dist/events.js +1 -1
- package/dist/execution.js +3 -2
- package/dist/identity.js +3 -3
- package/dist/oauth.js +3 -3
- package/dist/query.js +27 -1
- package/dist/ready.js +3 -3
- package/dist/release.js +1 -1
- package/dist/replica.js +9 -7
- package/dist/runtime-store.js +2 -2
- package/dist/runtime.js +1 -1
- package/dist/secret.js +1 -1
- package/dist/skills.js +1 -1
- package/dist/team.js +329 -0
- package/package.json +1 -1
- package/skills/catalyst-github/SKILL.md +1 -1
- package/skills/catalyst-linear/SKILL.md +1 -1
- package/skills/catalyst-onboard/SKILL.md +7 -7
- package/skills/catalyst-onboard/references/choosing-a-coding-account.md +2 -2
- package/skills/catalyst-onboard/references/declaring-a-repository.md +1 -1
- package/skills/catalyst-onboard/references/local-sync.md +3 -3
- package/skills/catalyst-onboard/references/skill-sources.md +1 -1
- package/skills/catalyst-onboard/references/the-one-path.md +12 -10
- package/skills/catalyst-onboard/references/what-a-phase-needs.md +5 -5
- package/skills/catalyst-onboard/references/what-the-browser-owns.md +6 -9
- package/skills/catalyst-onboard/references/who-fixes-what.md +35 -16
- package/skills/catalyst-onboard/scripts/local-sync.mjs +6 -6
- package/skills/catalyst-onboard/scripts/where-am-i.mjs +133 -54
- package/skills/catalyst-setup/SKILL.md +1 -1
- package/skills/connect-me/SKILL.md +1 -1
- package/skills/how-catalyst-works/SKILL.md +2 -2
- package/skills/how-catalyst-works/references/what-runs-next.md +11 -0
- package/skills/run-this-project/SKILL.md +1 -1
- package/skills/unstick/SKILL.md +1 -1
- package/skills/what-needs-me/SKILL.md +1 -1
- package/skills/whats-happening/SKILL.md +1 -1
- package/skills/whats-happening/references/reading-the-board.md +1 -1
- package/skills/whats-happening/references/why-is-it-stuck.md +1 -0
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: catalyst-onboard
|
|
3
3
|
description: >-
|
|
4
|
-
Walk a person from nothing to their first Catalyst Cloud ticket running, one step at a time, hand-held. Use when someone says "set me up", "onboard me", "I just signed up", "get me started", "what do I do first", or when they have the Catalyst Cloud skills installed and nothing else. Starts with the coding account, then the project, the integrations and the person's connected accounts, each repository's settings file, and ends with one real ticket moving. Reads each part of the setup with the instrument that owns it, does every step a key can do through the catalyst
|
|
4
|
+
Walk a person from nothing to their first Catalyst Cloud ticket running, one step at a time, hand-held. Use when someone says "set me up", "onboard me", "I just signed up", "get me started", "what do I do first", or when they have the Catalyst Cloud skills installed and nothing else. Starts with the coding account, then the project, the integrations and the person's connected accounts, each repository's settings file, and ends with one real ticket moving. Reads each part of the setup with the instrument that owns it, does every step a key can do through the catalyst CLI, and for the steps only a browser can do hands over the exact page and says what to come back with. Never claims a step it did not watch succeed.
|
|
5
5
|
disable-model-invocation: true
|
|
6
|
-
allowed-tools: Bash(catalyst-
|
|
6
|
+
allowed-tools: Bash(catalyst:*) Bash(npx -p @catalyst-cloud/cli catalyst:*) Bash(npx @catalyst-cloud/catalyst-skills:*)
|
|
7
7
|
---
|
|
8
|
-
<!-- vendored-from: @catalyst-cloud/catalyst-skills@0.9.
|
|
8
|
+
<!-- vendored-from: @catalyst-cloud/catalyst-skills@0.9.5 — written in this repository for customer tenants -->
|
|
9
9
|
|
|
10
10
|
# Onboard me
|
|
11
11
|
|
|
@@ -17,9 +17,9 @@ The path has five stops, in this order: a **coding account** the work will run o
|
|
|
17
17
|
|
|
18
18
|
1. Run `node scripts/where-am-i.mjs --next` and read the one line it prints. If a `note:` line follows it, say the note in one clause in the same turn (a cancelled account is kept for reporting, not used, never re-tokened); it is information, not a task.
|
|
19
19
|
2. Say, in one or two sentences, what that step is for. The person should always know why they are doing it.
|
|
20
|
-
3. Ask one question, or do one thing. If it is a command a key can run, run it and show the lines it printed. If it needs a browser, hand over one link, one action named the way the page names it, and say what you will check when they are back.
|
|
20
|
+
3. Ask one question, or do one thing. If it is a command a key can run (the script's `do:` line), run it now without asking whether to, and show the lines it printed. If it needs a browser, hand over one link, one action named the way the page names it, and say what you will check when they are back.
|
|
21
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
|
|
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.
|
|
23
23
|
|
|
24
24
|
Two or three short sentences per turn is the right size. A turn that lists every part's verdict is a wall of status, not help. The full report exists for you to read, not to paste.
|
|
25
25
|
|
|
@@ -67,8 +67,8 @@ Use the product's words, and name the page label Settings shows today when it di
|
|
|
67
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
68
|
- **Never invent a count or a list.** Every number and every name comes from what a command printed.
|
|
69
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
|
-
- **
|
|
71
|
-
- **The workspace-wide environment declaration is the one setup write you can perform.** `catalyst
|
|
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
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
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
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.
|
|
@@ -29,13 +29,13 @@ Enrolling is a browser step, by construction: the person pastes a credential int
|
|
|
29
29
|
|
|
30
30
|
1. Hand over the page the script printed for the part (Settings → AI accounts). Say: "Choose the provider, give the account a label you will recognise, and paste the credential the page asks for. Nothing on this side sees it."
|
|
31
31
|
2. Wait. Do not run anything while they are on the page.
|
|
32
|
-
3. When they say it is saved, run `node scripts/where-am-i.mjs` and read them the `coding accounts` part. An enrolled and active account, named by its label, is proof. If the part still says none is enrolled, refresh the contract once (`catalyst
|
|
32
|
+
3. When they say it is saved, run `node scripts/where-am-i.mjs` and read them the `coding accounts` part. An enrolled and active account, named by its label, is proof. If the part still says none is enrolled, refresh the contract once (`catalyst contract --refresh`) and read it again.
|
|
33
33
|
|
|
34
34
|
Only a workspace owner or admin can enrol one (the page still says "tenant" in places). If the person is neither, say who can, and stop this step there.
|
|
35
35
|
|
|
36
36
|
## Naming accounts
|
|
37
37
|
|
|
38
|
-
Call an account what the page calls it: its label, else its email, else its slot. `catalyst
|
|
38
|
+
Call an account what the page calls it: its label, else its email, else its slot. `catalyst accounts --json` carries this as `displayName`. Never call one "the first account" or "account 2", and never read out a credential.
|
|
39
39
|
|
|
40
40
|
## An account that already exists
|
|
41
41
|
|
|
@@ -43,4 +43,4 @@ run = ["npm", "ci"]
|
|
|
43
43
|
|
|
44
44
|
## After the merge
|
|
45
45
|
|
|
46
|
-
`catalyst
|
|
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`).
|
|
@@ -2,14 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
**For:** a person who wants an on-machine event file and searchable replica. The normal API-backed skills work without this, so ask before starting a background writer.
|
|
4
4
|
|
|
5
|
-
**You run:** `node scripts/local-sync.mjs` to show the current local state. Only if the person opts in, run `node scripts/local-sync.mjs --start`. The script uses `catalyst
|
|
5
|
+
**You run:** `node scripts/local-sync.mjs` to show the current local state. Only if the person opts in, run `node scripts/local-sync.mjs --start`. The script uses `catalyst replica start --detach`, whose writer also starts the local event cache. It waits up to 90 seconds; `--wait <seconds>` sets a bounded wait from 0 to 300.
|
|
6
6
|
|
|
7
|
-
**Read back:** `Local sync current` only when both the replica and event cache have live writer heartbeats and each cursor equals its own cloud head. A detached process starting, one fresh heartbeat alone, or replica freshness alone does not prove event freshness. `catalyst
|
|
7
|
+
**Read back:** `Local sync current` only when both the replica and event cache have live writer heartbeats and each cursor equals its own cloud head. A detached process starting, one fresh heartbeat alone, 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. Either command can report stale or unknown; unknown means the cloud comparison could not be proved, not that the cache is stale. Exit 0 means current, 1 stale, 2 unknown or not connected, and 3 absent. Do not tell the person local data is current unless the combined check says so.
|
|
8
8
|
|
|
9
9
|
**Owner:** you check and, with the person's opt-in, start. The local writer is optional. A reboot recovery service is separate work; if this machine restarts, recheck status before relying on local data.
|
|
10
10
|
|
|
11
11
|
## First ticket event
|
|
12
12
|
|
|
13
|
-
Ask before starting the local writer. 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
|
|
13
|
+
Ask before starting the local writer. 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. Once the card is moved, run `catalyst events wait-for --ticket <ticket-identifier> --after <cursor-before-move> --timeout 300` with the identifier `explain` printed. Do not guess an event type. The explicit cursor lets `wait-for` find the event if it reached the local cache before the command began.
|
|
14
14
|
|
|
15
15
|
Exit 0 prints a matching event after the recorded baseline and proves 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` remains the API-backed source for why a ticket can or cannot run.
|
|
@@ -23,7 +23,7 @@ The `npx skills add --all` command replaces existing same-named directories and
|
|
|
23
23
|
|
|
24
24
|
## Is each pack there
|
|
25
25
|
|
|
26
|
-
`catalyst
|
|
26
|
+
`catalyst ready` checks the Cloud pack only. Check `catalyst-onboard/SKILL.md` (Cloud pack) and `research-codebase/SKILL.md` (development pack) in the intended directory. If both are there, have the person type `/catalyst-onboard` (`$catalyst-onboard` in Codex).
|
|
27
27
|
|
|
28
28
|
## Migrate an existing installation
|
|
29
29
|
|
|
@@ -18,7 +18,7 @@ Each step states: what it is for, what you ask or run or hand over, **what you r
|
|
|
18
18
|
|
|
19
19
|
**For:** giving this machine a credential, so every later read is the person's own. The installer normally did this; you are here only when the script says the machine is not connected.
|
|
20
20
|
|
|
21
|
-
**You ask:** "Shall I start the login now?" On a yes, run `catalyst
|
|
21
|
+
**You ask:** "Shall I start the login now?" On a yes, run `catalyst login`. It prints a short code and a URL. The person approves it in a browser, from a phone if this machine has none. Do not offer the key form; it exists for a person who already holds a personal key and says so.
|
|
22
22
|
|
|
23
23
|
**Read back:** the `Connected to …` and `Connected as …` lines, then the script again so the machine part flips.
|
|
24
24
|
|
|
@@ -40,7 +40,7 @@ Each step states: what it is for, what you ask or run or hand over, **what you r
|
|
|
40
40
|
|
|
41
41
|
**You hand over:** `<their cloud>/settings/connections` (the Integrations page; Settings labels it Connections today), and say: connect Linear. It sends them to Linear to authorise and brings them back.
|
|
42
42
|
|
|
43
|
-
**Read back:** after they say it is done, re-run the script and read them the `account` line. A resolved workspace is proof. If it still reads unresolved, run `catalyst
|
|
43
|
+
**Read back:** after they say it is done, re-run the script and read them the `account` line. A resolved workspace is proof. If it still reads unresolved, run `catalyst contract --refresh` and read it again.
|
|
44
44
|
|
|
45
45
|
**Owner:** a workspace owner or admin, in a browser. **Browser by construction**: it is an authorization grant, and no key can perform one.
|
|
46
46
|
|
|
@@ -48,11 +48,13 @@ Each step states: what it is for, what you ask or run or hand over, **what you r
|
|
|
48
48
|
|
|
49
49
|
**For:** the project. A project is one Linear team plus the repositories registered to it. Until a project's stages are mapped, a card moved into it does nothing at all; this is the single most common reason a new workspace sees no activity.
|
|
50
50
|
|
|
51
|
-
**You
|
|
51
|
+
**You run:** `catalyst team list` to see the teams without checking readiness. Have the person choose one team key. Then `catalyst team map <KEY>`, or `catalyst team adopt <KEY>` if they want Catalyst's stages created for them: each prints a preview; show it, and pass `--yes --plan-hash <hash>` only after they approve that exact plan. Run `catalyst team check <KEY>` only for the selected team when you need its verdict. The same steps exist on `<their cloud>/settings/linear-teams` (**Map my stages**, **Adopt the Catalyst workflow**) for a person who prefers the page.
|
|
52
52
|
|
|
53
|
-
**Read back:** re-run the script and read the `projects` line. A project that
|
|
53
|
+
**Read back:** re-run the script and read the `projects` line: the verdict and any failing checks by name. A project that reads `blocked` is not set up whatever its gate says; the script names the blocking checks and their owner. Three of them are Linear's own Git automation rules (in Linear: Settings → Teams → the team → Workflow → Git automation, set the named rule to No action). No Catalyst key can change those, so say so, hand it over, and afterwards run `catalyst team check <KEY>`.
|
|
54
54
|
|
|
55
|
-
|
|
55
|
+
For manual setup, `catalyst team checklist <KEY>` prints the same lines as the browser. If it cannot read the live stages, fix the Linear connection and retry. Moving tickets out of old stages is a separate decision: preview with `team migrate <KEY>`, review source and destination ids and counts, then confirm with `--yes --plan-hash <hash>` from that preview. Retiring emptied source stages requires a later `team migrate <KEY> --retire` preview and a separate approval using its preview hash. `team adopt <KEY> --undo` likewise previews the exact stages previously created by Adopt before asking for confirmation.
|
|
56
|
+
|
|
57
|
+
**Owner:** a workspace owner or admin, with their own login. You run the commands; the person picks the team and approves each write after seeing its preview. A run that exits 3 stopped before applying anything.
|
|
56
58
|
|
|
57
59
|
⭐ **One project at a time is safe, and lead with this.** Mapping one project changes no other project's stages and moves no other project's tickets. Encourage a pilot: the project they care least about breaking.
|
|
58
60
|
|
|
@@ -80,9 +82,9 @@ Each step states: what it is for, what you ask or run or hand over, **what you r
|
|
|
80
82
|
|
|
81
83
|
**For:** the person. The integrations serve the whole workspace; a connected account is this person's own Linear or GitHub login, so that what Catalyst does for them is attributed to them, and asks assigned to them can be told apart from everyone else's.
|
|
82
84
|
|
|
83
|
-
**You run:** `catalyst
|
|
85
|
+
**You run:** `catalyst connections personal linear start`. It prints a short-lived URL and tries to open it; if the browser does not open, hand them the URL. Then `catalyst connections personal linear status`. Do GitHub the same way, with `github`, only after the GitHub App is installed and the repository is registered: `catalyst connections personal github start`, then `status`.
|
|
84
86
|
|
|
85
|
-
**Read back:** each `status`, and the script's `person` part: their label and role, whether their Linear identity is matched, and each grant. A URL opening is not proof a grant landed. If Linear identity stays unmatched after consent, `catalyst
|
|
87
|
+
**Read back:** each `status`, and the script's `person` part: their label and role, whether their Linear identity is matched, and each grant. A URL opening is not proof a grant landed. If Linear identity stays unmatched after consent, `catalyst identity linear status`, then `options`; the person picks their own listed identity and you run `catalyst identity linear set <linearUserId>`. An already-resolved or claimed identity, and an inactive seat, need an owner or admin.
|
|
86
88
|
|
|
87
89
|
**Owner:** you start and check; the person approves in a browser.
|
|
88
90
|
|
|
@@ -90,7 +92,7 @@ Each step states: what it is for, what you ask or run or hand over, **what you r
|
|
|
90
92
|
|
|
91
93
|
**For:** the repository's own settings, in `.catalyst/catalyst.toml` on its default branch: the Linear team it belongs to, the names of the variables and secrets its build needs, and its setup commands. Names leave the machine; values are entered once, by them, in the app.
|
|
92
94
|
|
|
93
|
-
**You ask:** one thing at a time. First: "Shall I draft it from your repository's own build files?" On a yes, ask where the repository is checked out on this machine; if it is not, write the file here for them to add. Then `references/declaring-a-repository.md`: the inventory, the file's shape, the pull request. Say what happens after the merge as context, not as a second task for now. After the merge, an owner or admin approves the revision on the repository's Environment page (Settings → Repositories → the repository → Environment → Setup declaration → Approve this revision) and enters the values on the same page. A workspace-wide declaration, if they want one, goes through `catalyst
|
|
95
|
+
**You ask:** one thing at a time. First: "Shall I draft it from your repository's own build files?" On a yes, ask where the repository is checked out on this machine; if it is not, write the file here for them to add. Then `references/declaring-a-repository.md`: the inventory, the file's shape, the pull request. Say what happens after the merge as context, not as a second task for now. After the merge, an owner or admin approves the revision on the repository's Environment page (Settings → Repositories → the repository → Environment → Setup declaration → Approve this revision) and enters the values on the same page. A workspace-wide declaration, if they want one, goes through `catalyst environment` (read, propose, `--approve`), the one setup write you can perform.
|
|
94
96
|
|
|
95
97
|
**Read back:** the script's `repository declarations` part, read from each project's `environment_declared` check: no file yet, invalid, awaiting approval, or in effect, per repository. Names only, never a value.
|
|
96
98
|
|
|
@@ -100,9 +102,9 @@ Each step states: what it is for, what you ask or run or hand over, **what you r
|
|
|
100
102
|
|
|
101
103
|
**For:** the only thing that proves setup worked.
|
|
102
104
|
|
|
103
|
-
**You run:** `catalyst
|
|
105
|
+
**You run:** `catalyst team check <KEY>` first when the script's next step names it (an owner or admin whose CLI has the verb), then `catalyst ready`. Its READY does not cover the coding account or the host; the script does. Read them the verdict and every failing line with its own fix and owner. If it says NOT READY, go to `references/who-fixes-what.md` before you touch anything.
|
|
104
106
|
|
|
105
|
-
**Then:**
|
|
107
|
+
**Then:** one question, worded like this: "Move one ticket into ENG's start stage (usually Todo) and tell me its id." Nothing else in that turn: no offer to explain the pipeline, to look at the board, or to pick one for them. Then watch. `catalyst explain <ticket>` says why it is or is not about to run. If they opted into local sync, use the optional first-event check in `references/local-sync.md`.
|
|
106
108
|
|
|
107
109
|
**Read back:** what `explain` actually said, and the first comment the agent leaves on the ticket. If `explain` says the ticket cannot start, the reason it names is the answer; use the `how-catalyst-works` skill for what it means, then `unstick` if something is holding it.
|
|
108
110
|
|
|
@@ -6,7 +6,7 @@ A person can finish every other step and still see nothing run. A phase needs tw
|
|
|
6
6
|
|
|
7
7
|
**For:** a phase runs on one of the tenant's own enrolled coding accounts. With none active, no phase can start.
|
|
8
8
|
|
|
9
|
-
**Instrument:** `codingAccounts` in `catalyst
|
|
9
|
+
**Instrument:** `codingAccounts` in `catalyst contract`. It carries a `state`, a printable `line`, who enrolls an account (`enrolledByLine`) and the `page`. The script prints all of them. It never shows a credential or an email. When the state is `enrolled`, the script also reads `catalyst accounts` to check each account's credential.
|
|
10
10
|
|
|
11
11
|
**What each state means:**
|
|
12
12
|
|
|
@@ -19,13 +19,13 @@ A person can finish every other step and still see nothing run. A phase needs tw
|
|
|
19
19
|
|
|
20
20
|
**Owner:** the one the contract names. The person does it in the browser. Never ask for the credential, and never handle it. A key cannot enrol one. Which kinds of account exist, what each asks for, and what to do with an ended or cancelled one are in `references/choosing-a-coding-account.md`; it is step 2 of the path, the first thing asked.
|
|
21
21
|
|
|
22
|
-
**Older cloud:** if the contract has no `codingAccounts`, the script says the cloud is older and reads `catalyst
|
|
22
|
+
**Older cloud:** if the contract has no `codingAccounts`, the script says the cloud is older and reads `catalyst accounts` instead. That list counts the accounts enrolled and the ones able to take work. An expired, revoked or quarantined account does not count. The owner is then a tenant owner or admin, at `<their cloud>/settings/coding-accounts`.
|
|
23
23
|
|
|
24
24
|
## Host
|
|
25
25
|
|
|
26
26
|
**For:** the contract carries this as the `hosts_current` readiness check on each project. It reads the same on every project, because it is about the whole account.
|
|
27
27
|
|
|
28
|
-
**Instrument:** the `hosts_current` check in `catalyst
|
|
28
|
+
**Instrument:** the `hosts_current` check in `catalyst contract --path teams`, and its owner in `catalyst contract --path readinessChecks`.
|
|
29
29
|
|
|
30
30
|
**What each reading means:**
|
|
31
31
|
|
|
@@ -35,11 +35,11 @@ A person can finish every other step and still see nothing run. A phase needs tw
|
|
|
35
35
|
| `unknown`, `no_host_connected` | no Catalyst host is connected | name the owner and stop |
|
|
36
36
|
| `unknown`, `hosts_unreported` | a host is connected but has not said which mapping it loaded | name the owner; it clears when the host reconnects |
|
|
37
37
|
| `fail`, `hosts_behind` | a connected host runs an older mapping | name the owner |
|
|
38
|
-
| the part reads `unreadable` | no project has been checked yet | press Re-check on the projects page
|
|
38
|
+
| the part reads `unreadable` | no project has been checked yet | run `catalyst team check <KEY>` when the script names it (it does when the CLI has the verb and the person is an owner or admin); otherwise press Re-check on the projects page; then read it again |
|
|
39
39
|
|
|
40
40
|
**Owner:** the contract names the owner of `hosts_current`, and where they act in its `fixedWhere`. When `fixedWhere` has a page, the script prints it, and the command too when there is one. When it is null, which it is today, the script prints the owner sentence alone. Then there is no page, so do not invent one. Say who owns it and that they connect it.
|
|
41
41
|
|
|
42
|
-
⛔ `catalyst
|
|
42
|
+
⛔ `catalyst ready` treats this check as a note, so it can print READY while no host is connected. READY there is not proof a phase can run. The `host` part is.
|
|
43
43
|
|
|
44
44
|
## Saying it is ready
|
|
45
45
|
|
|
@@ -8,13 +8,13 @@ These will never be a command, on any release. Each is an authorization a person
|
|
|
8
8
|
|
|
9
9
|
| step | where | what you say |
|
|
10
10
|
| -- | -- | -- |
|
|
11
|
-
| approving the login | the URL and short code that `catalyst
|
|
11
|
+
| approving the login | the URL and short code that `catalyst login` printed | "I have started the login. It printed this code and this URL — approve it in your browser, or on your phone, and tell me when it is done." |
|
|
12
12
|
| enrolling a coding account, or replacing its credential | the AI accounts page the script printed for the `coding accounts` part | "Choose the provider, give the account a label you will recognise, and paste the credential the page asks for. Nothing on this side sees it. Tell me when it is saved and I will read it back." |
|
|
13
13
|
| connecting the Linear integration | `<their cloud>/settings/connections` (the Integrations page; Settings labels it Connections today) | "Open this page and connect Linear. It will send you to Linear to authorize it and bring you back." |
|
|
14
14
|
| installing the GitHub App | `<their cloud>/settings/connections` | "Open the same page and install the GitHub App, granting it the repository you want worked and `<your GitHub org>/thoughts`." |
|
|
15
15
|
| creating or confirming `<your GitHub org>/thoughts`, and letting the GitHub App reach it | GitHub, then the GitHub App's installation page for that org | "Catalyst's cloud phases write their notes to `<your GitHub org>/thoughts`, in the org that owns the code repository. Check it exists. If not, create a private repository named `thoughts`, initialized with a README. Then, on the GitHub App's installation page for that org, choose All repositories, or add `thoughts` to the selected repositories." |
|
|
16
|
-
| connecting personal Linear | the URL printed by `catalyst
|
|
17
|
-
| connecting personal GitHub, after the tenant GitHub App is installed and its repository is registered | the URL printed by `catalyst
|
|
16
|
+
| connecting personal Linear | the URL printed by `catalyst connections personal linear start` | "Approve your own Linear account in this browser. I will check the grant status afterward." |
|
|
17
|
+
| connecting personal GitHub, after the tenant GitHub App is installed and its repository is registered | the URL printed by `catalyst connections personal github start` | "Approve your own GitHub account in this browser. I will check the grant status afterward." |
|
|
18
18
|
|
|
19
19
|
Say **by construction**, not "not supported yet". A person who thinks it is a missing feature will wait for it.
|
|
20
20
|
|
|
@@ -24,17 +24,14 @@ These are settings pages today because the routes behind them take a browser ses
|
|
|
24
24
|
|
|
25
25
|
| step | where | what you say |
|
|
26
26
|
| -- | -- | -- |
|
|
27
|
-
| seeing every project they could set up | `<their cloud>/settings/linear-teams` | "I can read the projects that are already mapped, but the full list is only on this page today. Open it and tell me the ones you see." |
|
|
28
|
-
| checking a project's readiness, or re-checking it | the same page | "I can read the verdict your tenant last stored, from the contract. Asking for a fresh check is on that page." |
|
|
29
|
-
| mapping stages, or adopting the workflow | the same page, per project | "Pick one project, then **Map my stages** — or **Adopt the Catalyst workflow** if you want Catalyst's stages created for you." |
|
|
30
27
|
| registering a repository | `<their cloud>/settings/repositories` | "Add the repository here, and attach it to the project you just mapped, in the same form." |
|
|
31
|
-
| approving the environment **for one repository**, and entering its values | that repository's Environment page under `<their cloud>/settings/repositories`: the Setup declaration tab's Approve this revision button approves, and the Environment variables and Secrets tabs take the values | "The names come from `.catalyst/catalyst.toml` in the repository, which I can write with you. Approving it and entering the values happen here, once, by you. Nothing I run ever sees a value." (Account-wide names are **not** on this list: `catalyst
|
|
28
|
+
| approving the environment **for one repository**, and entering its values | that repository's Environment page under `<their cloud>/settings/repositories`: the Setup declaration tab's Approve this revision button approves, and the Environment variables and Secrets tabs take the values | "The names come from `.catalyst/catalyst.toml` in the repository, which I can write with you. Approving it and entering the values happen here, once, by you. Nothing I run ever sees a value." (Account-wide names are **not** on this list: `catalyst environment` does those.) |
|
|
32
29
|
|
|
33
30
|
⛔ **Do not compose a request for any of these.** A skill script never makes a request of its own; only the CLI does, and the CLI has no verb for them. If you find yourself constructing a URL, stop.
|
|
34
31
|
|
|
35
32
|
## The URL to hand over
|
|
36
33
|
|
|
37
|
-
Never type a host from memory. `catalyst
|
|
34
|
+
Never type a host from memory. `catalyst status` prints the API it is connected to on its `API:` line, and `node scripts/where-am-i.mjs` prints ready-made links built from it. Use those. A person pointed at the wrong tenant's settings page has a worse afternoon than one pointed at no page at all.
|
|
38
35
|
|
|
39
36
|
## Handing over, and coming back
|
|
40
37
|
|
|
@@ -50,5 +47,5 @@ When they come back:
|
|
|
50
47
|
|
|
51
48
|
- Re-run `node scripts/where-am-i.mjs` and read them the part that should have changed.
|
|
52
49
|
- If it changed, say what it now says and move on.
|
|
53
|
-
- If it did not, refresh the contract once (`catalyst
|
|
50
|
+
- If it did not, refresh the contract once (`catalyst contract --refresh`) and read it again — the contract is cached, and a page can be ahead of it by a few seconds.
|
|
54
51
|
- If it still did not, report both: what the page told them, and what the instrument says. Ask what they saw. **Never mark a step done because the person said a page worked** — the instrument is the record, and this is exactly where a confident false "all set" costs them an hour later.
|
|
@@ -6,40 +6,59 @@ Setup is eight parts. Each has one instrument, and each instrument answers about
|
|
|
6
6
|
|
|
7
7
|
| part | instrument | what a pass proves | what it does **not** prove | who fixes a failure, and where |
|
|
8
8
|
| -- | -- | -- | -- | -- |
|
|
9
|
-
| **machine** | `catalyst
|
|
10
|
-
| **person** | `catalyst
|
|
11
|
-
| **account** | `catalyst
|
|
12
|
-
| **project** | `catalyst
|
|
13
|
-
| **repository** | `catalyst
|
|
14
|
-
| **coding accounts** | `codingAccounts` in `catalyst
|
|
15
|
-
| **repository declarations** | the `environment_declared` check in `catalyst
|
|
16
|
-
| **host** | the `hosts_current` check in `catalyst
|
|
9
|
+
| **machine** | `catalyst status`, and the non-team checks of `catalyst ready` | Node is new enough, this machine holds a credential, the CLI is where the config says, the contract is cached, the skills are on disk | anything at all about the tenant | the person at this keyboard, here |
|
|
10
|
+
| **person** | `catalyst me`, and `catalyst connections personal <linear|github> status` | the credential resolves to this person, shows their role and Linear identity match, and reports each personal grant's state | that their seat is active, or that they may change tenant settings | the member approves missing or expired personal grants in a browser; an owner or admin handles seat or identity conflicts in Settings → Members |
|
|
11
|
+
| **account** | `catalyst contract --path account` | a resolved Linear workspace means the tenant's Linear grant landed | that the GitHub App is installed — the contract does not carry it | a tenant owner or admin, `<their cloud>/settings/connections` |
|
|
12
|
+
| **project** | `catalyst team list`, then `team check <KEY>` and the `team:` checks of `ready` for the selected team | the live team list and the selected team's latest readiness verdict | that an unchecked team is ready | a tenant owner or admin, through `catalyst team` or `<their cloud>/settings/linear-teams` |
|
|
13
|
+
| **repository** | `catalyst contract --path merge.repositories` | the repository is registered to the account | that it is active, that a project can dispatch into it, or that its environment is declared | a tenant owner or admin, `<their cloud>/settings/repositories` |
|
|
14
|
+
| **coding accounts** | `codingAccounts` in `catalyst contract` (`catalyst accounts` on an older cloud) | an account is enrolled and active | that it has headroom left for the next phase | the enroller and page the contract names; see `references/what-a-phase-needs.md` |
|
|
15
|
+
| **repository declarations** | the `environment_declared` check in `catalyst contract --path teams`, and its per-repository notes | the project's default repository has a committed `.catalyst/catalyst.toml` in effect: ingested, valid, and its latest revision approved | that the values the names refer to exist; that any other repository is declared, unless its note says so | the person, with you, in the repository for the file; a tenant owner or admin for the approval, at the repository's Environment page under `<their cloud>/settings/repositories` |
|
|
16
|
+
| **host** | the `hosts_current` check in `catalyst contract --path teams` | no host is missing or behind, or the tenant runs none | anything before a project has been checked | the owner the contract names for `hosts_current`; see `references/what-a-phase-needs.md` |
|
|
17
17
|
|
|
18
18
|
`node scripts/where-am-i.mjs` runs all eight, in the order a person can act on them, and labels each finding with its part. Use it rather than composing this by hand.
|
|
19
19
|
|
|
20
20
|
## The two silences that are not absences
|
|
21
21
|
|
|
22
|
-
⛔ **An empty project list means nothing is mapped yet — it does not mean they have no projects.** The tenant contract carries a project only once someone has saved a stage mapping for it.
|
|
22
|
+
⛔ **An empty contract project list means nothing is mapped yet — it does not mean they have no projects.** The tenant contract carries a project only once someone has saved a stage mapping for it. Read the available team list with `catalyst team list`, choose one, then go to step 4. `team check --all` performs readiness checks and may create asks for every team.
|
|
23
23
|
|
|
24
|
-
⛔ **A registered repository is not a dispatchable one.** The contract's repository list carries no status and no project attachment, so a paused repository and an active one look identical there, and a repository registered without a project attached looks exactly like a correctly attached one. Registration is all it proves. If a card does not start, `catalyst
|
|
24
|
+
⛔ **A registered repository is not a dispatchable one.** The contract's repository list carries no status and no project attachment, so a paused repository and an active one look identical there, and a repository registered without a project attached looks exactly like a correctly attached one. Registration is all it proves. If a card does not start, `catalyst explain <ticket>` names the real reason; do not conclude anything about the repository from its presence in a list.
|
|
25
25
|
|
|
26
26
|
⭐ And the general form of both: **an instrument that answers about a part it does not own will answer confidently and wrongly.** When you are unsure which part something belongs to, look it up in the table above rather than guessing from the wording of an error.
|
|
27
27
|
|
|
28
28
|
## Triaging NOT READY
|
|
29
29
|
|
|
30
|
-
`catalyst
|
|
30
|
+
`catalyst ready` prints one verdict over every check, machine and project together. That single verdict is correct for "can work run?" and useless for "what should I do now?", because it folds two parts into one word. Split it before you act:
|
|
31
31
|
|
|
32
|
-
1. Run `catalyst
|
|
32
|
+
1. Run `catalyst ready --json`. Every check has an `id`.
|
|
33
33
|
2. A check whose id begins with `team:` is a **project** finding. Everything else is a **machine** finding.
|
|
34
34
|
3. Report the two groups separately, in that order, each with its own owner.
|
|
35
35
|
|
|
36
|
-
- **A machine check failed.** This is the person's, here, now. Each failing check carries its own `fix` line; read it and do it. A missing or partial skill set is `catalyst
|
|
37
|
-
- **A project check failed.**
|
|
38
|
-
- **A check is a note.** Notes never move the verdict. A stale or absent replica or event cache is optional; an unknown freshness probe means the cloud comparison could not be proved.
|
|
36
|
+
- **A machine check failed.** This is the person's, here, now. Each failing check carries its own `fix` line; read it and do it. A missing or partial skill set is `catalyst install`; a stale contract is `catalyst contract --refresh`; a missing CLI path is one more `catalyst login`.
|
|
37
|
+
- **A project check failed.** Name the check, the project, and the owner; the `who` field carries the workspace's own owners and admins. An admin or owner can run the check, preview a stage mapping, or adopt the workflow through `catalyst team`; some failures still need provider consent or a browser action, and `<their cloud>/settings/linear-teams` is where those live. Use the check's reason to choose the next action. Re-running `ready` alone does not fix it.
|
|
38
|
+
- **A check is a note.** Notes never move the verdict. A stale or absent replica or event cache is optional; an unknown freshness probe means the cloud comparison could not be proved. A check that has never been run is waiting, not failing; a check the engine could not run is unknown, which is not a pass and not a failure. Say which it is. The API-backed skills still work; ask before starting the optional writer.
|
|
39
39
|
|
|
40
40
|
## When to stop rather than continue
|
|
41
41
|
|
|
42
42
|
- **They have no account yet.** There is no self-serve sign-up. Coalesce Labs provisions each account, and a person joins one by invitation from its admin. Say so and stop; the next step is theirs.
|
|
43
43
|
- **The account is suspended.** Setup cannot proceed and no retry changes that. Say so and name the conversation they need to have.
|
|
44
44
|
- **Their seat is not active, or they are not an owner or admin where one is required.** Say who is, and what to ask for. Do not offer a workaround.
|
|
45
|
-
- **A page said it worked and the instrument still disagrees.** Refresh the contract once (`catalyst
|
|
45
|
+
- **A page said it worked and the instrument still disagrees.** Refresh the contract once (`catalyst contract --refresh`) and read it again. If it still disagrees, report both facts — what the page said and what the instrument says — and let the person decide. Do not pick one for them.
|
|
46
|
+
|
|
47
|
+
## What still happens in a browser, and why
|
|
48
|
+
|
|
49
|
+
Every step a key can do, the guide does. These are the ones it hands over, each with the reason; when a reason stops being true, the step moves to the CLI and this table changes in the same release.
|
|
50
|
+
|
|
51
|
+
| step | today | why it is still the person's |
|
|
52
|
+
| -- | -- | -- |
|
|
53
|
+
| install Node, or a coding agent | the person, on their machine | outside the CLI |
|
|
54
|
+
| approve the login | the code and URL `login` prints, in a browser | a grant only the person can give |
|
|
55
|
+
| connect the Linear integration | Settings → Connections | an OAuth grant, by construction |
|
|
56
|
+
| install the GitHub App | Settings → Connections | an OAuth grant, by construction |
|
|
57
|
+
| enrol a coding account, or replace its credential | Settings → AI accounts | the credential is theirs to paste; a CLI verb for the paste is being built |
|
|
58
|
+
| register a repository to a project | Settings → Repositories | the route exists; the CLI verb is being built |
|
|
59
|
+
| approve one repository's settings file | the repository's Environment page | the route for a key is being built |
|
|
60
|
+
| enter a secret's value | the repository's Environment page, or `secret set` | a value never passes through the agent |
|
|
61
|
+
| the person's own Linear and GitHub connected accounts | the link `connections personal … start` prints | a grant only the person can give |
|
|
62
|
+
| move the first ticket | Linear, or `write state` when they ask | their call which ticket runs first |
|
|
63
|
+
|
|
64
|
+
A project's readiness check, its stage mapping and adopting the workflow are CLI steps (`team check`, `team map`, `team adopt`) when `catalyst capabilities` says the installed CLI can run them for the person's role; the script names the command, and the page only for a person whose role cannot.
|
|
@@ -8,7 +8,7 @@ import { cliTarget } from "./lib/cli.mjs";
|
|
|
8
8
|
const STATUS_COMMAND = ["replica", "status", "--probe", "--json"];
|
|
9
9
|
const EVENTS_COMMAND = ["events", "status", "--probe", "--json"];
|
|
10
10
|
const START_COMMAND = ["replica", "start", "--detach"];
|
|
11
|
-
const RECOVERY_COMMAND = "catalyst
|
|
11
|
+
const RECOVERY_COMMAND = "catalyst replica start --detach";
|
|
12
12
|
|
|
13
13
|
function defaultRun(args) {
|
|
14
14
|
const target = cliTarget();
|
|
@@ -105,7 +105,7 @@ function readStatus(run) {
|
|
|
105
105
|
current: false,
|
|
106
106
|
reason: `replica status is unknown: ${replicaResult.error || replicaResult.stderr.trim() || "invalid JSON"}`,
|
|
107
107
|
},
|
|
108
|
-
recovery: replicaResult.code === 2 ? "catalyst
|
|
108
|
+
recovery: replicaResult.code === 2 ? "catalyst login" : "catalyst replica status --probe --json",
|
|
109
109
|
};
|
|
110
110
|
}
|
|
111
111
|
const eventsResult = run(EVENTS_COMMAND);
|
|
@@ -120,7 +120,7 @@ function readStatus(run) {
|
|
|
120
120
|
current: false,
|
|
121
121
|
reason: `event freshness is unknown: ${eventsResult.error || eventsResult.stderr.trim() || "invalid JSON"}`,
|
|
122
122
|
},
|
|
123
|
-
recovery: "catalyst
|
|
123
|
+
recovery: "catalyst events status --probe --json",
|
|
124
124
|
};
|
|
125
125
|
}
|
|
126
126
|
return { status, events, assessment: assessLocalSync(status, events) };
|
|
@@ -140,12 +140,12 @@ export async function runLocalSync({
|
|
|
140
140
|
if (reading.assessment.current || !start)
|
|
141
141
|
return { ...reading, started: false, recovery: reading.recovery ?? RECOVERY_COMMAND };
|
|
142
142
|
if (!reading.status)
|
|
143
|
-
return { ...reading, started: false, recovery: reading.recovery ?? "catalyst
|
|
143
|
+
return { ...reading, started: false, recovery: reading.recovery ?? "catalyst replica status --probe --json" };
|
|
144
144
|
if (
|
|
145
145
|
reading.status?.verdict === "not-configured" ||
|
|
146
146
|
reading.status?.dbPath == null
|
|
147
147
|
) {
|
|
148
|
-
return { ...reading, started: false, recovery: "catalyst
|
|
148
|
+
return { ...reading, started: false, recovery: "catalyst login" };
|
|
149
149
|
}
|
|
150
150
|
let started = false;
|
|
151
151
|
if (reading.status.writerAlive !== true && ["absent", "stale"].includes(reading.assessment.verdict)) {
|
|
@@ -177,7 +177,7 @@ export async function runLocalSync({
|
|
|
177
177
|
recovery: reading.assessment.verdict === "unknown"
|
|
178
178
|
? "node scripts/local-sync.mjs --json"
|
|
179
179
|
: reading.status?.writerAlive
|
|
180
|
-
? "catalyst
|
|
180
|
+
? "catalyst replica stop && catalyst replica start --detach"
|
|
181
181
|
: RECOVERY_COMMAND,
|
|
182
182
|
};
|
|
183
183
|
}
|