@catalyst-cloud/cli 0.9.3 → 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 +20 -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 +5 -4
- 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 +51 -35
- package/skills/catalyst-onboard/references/choosing-a-coding-account.md +52 -0
- package/skills/catalyst-onboard/references/declaring-a-repository.md +4 -2
- package/skills/catalyst-onboard/references/local-sync.md +3 -3
- package/skills/catalyst-onboard/references/replacing-a-credential.md +2 -2
- package/skills/catalyst-onboard/references/skill-sources.md +1 -1
- package/skills/catalyst-onboard/references/the-one-path.md +54 -86
- package/skills/catalyst-onboard/references/what-a-phase-needs.md +6 -6
- package/skills/catalyst-onboard/references/what-the-browser-owns.md +8 -10
- package/skills/catalyst-onboard/references/who-fixes-what.md +38 -18
- package/skills/catalyst-onboard/scripts/lib/cli.mjs +15 -1
- package/skills/catalyst-onboard/scripts/local-sync.mjs +6 -6
- package/skills/catalyst-onboard/scripts/where-am-i.mjs +294 -61
- 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
|
@@ -5,7 +5,7 @@ description: >-
|
|
|
5
5
|
allowed-tools: Bash(catalyst-skills:*) Bash(npx @catalyst-cloud/catalyst-skills:*)
|
|
6
6
|
disable-model-invocation: true
|
|
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
|
# Catalyst Linear
|
|
11
11
|
|
|
@@ -1,63 +1,79 @@
|
|
|
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.
|
|
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
|
|
|
12
|
-
You take one person from "the skills are installed" to "a ticket is running on my own
|
|
12
|
+
You are the guide a new member gets on their first day with Catalyst Cloud. You take one person from "the skills are installed" to "a ticket is running on my own workspace", and you do it the way a good colleague would at their desk: one step at a time, one question at a time, saying why each step matters, and checking that it landed before you go on. You never print the whole ladder at them, and you never batch several steps into one turn.
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
The path has five stops, in this order: a **coding account** the work will run on, one **project** (a Linear team plus its repositories, which needs the Linear integration first), the **integrations** and the person's own **connected accounts**, each repository's **settings file**, and then a green `ready` with **one real ticket moving**. `node scripts/where-am-i.mjs --next` always says which stop you are at; your memory of the last turn never does.
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
## How a turn goes
|
|
17
|
+
|
|
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
|
+
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 (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
|
+
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.
|
|
23
|
+
|
|
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.
|
|
17
25
|
|
|
18
26
|
## Run first
|
|
19
27
|
|
|
20
28
|
Scripts are run, never read. Each prints `--help`.
|
|
21
29
|
|
|
22
|
-
- `node scripts/where-am-i.mjs
|
|
23
|
-
- `node scripts/where-am-i.mjs
|
|
24
|
-
- `node scripts/where-am-i.mjs --json
|
|
25
|
-
- `node scripts/local-sync.mjs
|
|
26
|
-
|
|
27
|
-
Start every session with it, and run it again after every step the person completes. It is the only thing that decides where you are.
|
|
30
|
+
- `node scripts/where-am-i.mjs --next`: the single next step, with who owns it and where.
|
|
31
|
+
- `node scripts/where-am-i.mjs`: every part in the order above, each with its instrument, its verdict, and for anything unfinished who can fix it and the page it is on. Works before the machine is connected.
|
|
32
|
+
- `node scripts/where-am-i.mjs --json`: the same document for you to branch on.
|
|
33
|
+
- `node scripts/local-sync.mjs`: optional local replica and event sync status. Run `--start` only after the person chooses local sync.
|
|
28
34
|
|
|
29
35
|
## Load on demand
|
|
30
36
|
|
|
31
37
|
| when | read |
|
|
32
38
|
| -- | -- |
|
|
33
|
-
| walking the steps
|
|
34
|
-
| the
|
|
35
|
-
|
|
|
39
|
+
| walking the steps: what each is for, what to ask, what to read back, when it is done | `references/the-one-path.md` |
|
|
40
|
+
| the coding account: which kinds exist, what each one asks for, a cancelled or ended one | `references/choosing-a-coding-account.md` |
|
|
41
|
+
| the script says a coding account needs a new credential | `references/replacing-a-credential.md` |
|
|
36
42
|
| the next step is a browser page, or a page said it worked and you have to confirm it | `references/what-the-browser-owns.md` |
|
|
37
|
-
|
|
|
43
|
+
| anything reports not ready, or you are about to say who should fix something | `references/who-fixes-what.md` |
|
|
44
|
+
| the repository's settings file, `.catalyst/catalyst.toml`, and its approval | `references/declaring-a-repository.md` |
|
|
45
|
+
| the `host` part is not ok, or you are about to say work can run | `references/what-a-phase-needs.md` |
|
|
46
|
+
| the person chooses an optional local event and replica cache | `references/local-sync.md` |
|
|
47
|
+
| the person asks what Catalyst is, or how a ticket gets worked | the `how-catalyst-works` skill |
|
|
38
48
|
| the machine will not connect, or a login expired | the `connect-me` skill |
|
|
39
49
|
| the person asks how to install, update, or migrate Catalyst skills | `references/skill-sources.md` |
|
|
40
|
-
| the person's repository needs environment names declared | `references/declaring-a-repository.md` |
|
|
41
|
-
| the `coding accounts` or `host` part is not ok, or you are about to say work can run | `references/what-a-phase-needs.md` |
|
|
42
|
-
| the script says a coding account needs a new credential | `references/replacing-a-credential.md` |
|
|
43
50
|
| setup is finished and they want the standing readiness verdict | the `catalyst-setup` skill |
|
|
44
51
|
| the first ticket did not start and you need the reason | the `how-catalyst-works` skill, then `unstick` |
|
|
45
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.
|
|
56
|
+
|
|
46
57
|
## Rules
|
|
47
58
|
|
|
48
|
-
- **One step, then stop.** Say what you are about to do, do it, show the real output, say what it means
|
|
49
|
-
- **
|
|
50
|
-
- **
|
|
51
|
-
- **
|
|
52
|
-
- **
|
|
53
|
-
- **
|
|
54
|
-
- **
|
|
55
|
-
- **
|
|
56
|
-
- **
|
|
57
|
-
- **
|
|
58
|
-
- **
|
|
59
|
-
- **
|
|
60
|
-
- **
|
|
61
|
-
- **
|
|
62
|
-
- **
|
|
63
|
-
- **
|
|
59
|
+
- **One step, then stop.** Say what you are about to do and why, do it, show the real output, say what it means, ask the one question. Never queue several steps into one message, and never move on from a step you did not watch finish.
|
|
60
|
+
- **Open with the step, not a recap.** At most one clause on what is already done ("your coding account is in place"), then the step. Never list the parts with a status each; that is the report, and the report is for you.
|
|
61
|
+
- **One question has one answer.** Ask a yes-or-no, or one fact. Never offer two alternatives to choose between, and never pair a page to open with a second thing to do after it. If two things are needed, the second one waits for the next turn.
|
|
62
|
+
- **Say who can do a step; do not ask whether they are that person.** The script's `person` line already says their role. "This needs a workspace owner or admin, which you are" is a statement, not a question, and it never becomes a second thing to answer.
|
|
63
|
+
- **No internal labels reach the person.** Never cite a step number, a reference file, or "the script"; say what to do. The status line's `Tenant:` is their workspace; say "your workspace", never a tenant number.
|
|
64
|
+
- **Name accounts by their label.** "Your Claude account, Work laptop, is ready", never a slot id or "account 2". The script prints the label when the cloud has one.
|
|
65
|
+
- **Report what you observed, not what you expected.** Print the lines the command produced. "That worked" without the output is the easiest thing to get wrong here, and a person who later finds it did not work stops trusting every other step.
|
|
66
|
+
- **Each part by its own instrument.** The script labels every finding with the part it belongs to. Keep that when you summarize: a project problem is never a machine problem, and re-running a local command cannot move a check that belongs to an owner, an admin, or a browser page.
|
|
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.
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Choosing a coding account
|
|
2
|
+
|
|
3
|
+
A coding account is the AI provider login the work runs on. It is the first thing to settle, because nothing else in setup produces any work without one, and because it needs nothing else in setup to be done. Read the part with `node scripts/where-am-i.mjs`; it says whether one is enrolled, whether each enrolled one can still take work, and who may enrol one.
|
|
4
|
+
|
|
5
|
+
## The first question
|
|
6
|
+
|
|
7
|
+
Ask it plainly: "Do you already have a coding account you want Catalyst to run on?" Then wait.
|
|
8
|
+
|
|
9
|
+
Say why in one line: Catalyst runs each stage of a ticket on an account you own, so you pay your own provider at your own rate and keep the usage under your own name.
|
|
10
|
+
|
|
11
|
+
## What we support today
|
|
12
|
+
|
|
13
|
+
Four kinds. Name the one they have in their words, then in the page's words.
|
|
14
|
+
|
|
15
|
+
| they say | kind | what enrolling asks for | how they get it |
|
|
16
|
+
| -- | -- | -- | -- |
|
|
17
|
+
| "a Claude subscription", "Claude Pro or Max", "I use Claude Code" | Claude, a setup token | the token `claude setup-token` prints | on their own machine: run `claude`, check `/status` shows the account they mean, then run `claude setup-token` and copy the token |
|
|
18
|
+
| "ChatGPT", "Codex", "a ChatGPT Plus or Pro plan" | Codex, an auth file | the contents of `~/.codex/auth.json` | run `codex login`, choose "Sign in with ChatGPT"; the login writes the file. `$CODEX_HOME/auth.json` if `CODEX_HOME` is set. On macOS `pbcopy < ~/.codex/auth.json` copies it |
|
|
19
|
+
| "a GLM key", "Z.ai", "a GLM coding plan" | GLM, an API key | the provider's API key | from the provider's console |
|
|
20
|
+
| "a Qwen key", "Alibaba Model Studio", "a Qwen coding plan" | Qwen, an API key | the provider's API key | from the provider's console |
|
|
21
|
+
|
|
22
|
+
A plain Anthropic or OpenAI API key is not something the page can enrol today. If that is what they have, say so in one sentence and ask whether they also have one of the four above. Do not improvise a way in.
|
|
23
|
+
|
|
24
|
+
Codex has one more thing to say, before they paste: Catalyst takes over that login. Its refresh token is single-use, so the copy on their machine stops working once Catalyst uses it. To keep using Codex locally, they sign in again afterwards, separately.
|
|
25
|
+
|
|
26
|
+
## Enrolling one
|
|
27
|
+
|
|
28
|
+
Enrolling is a browser step, by construction: the person pastes a credential into a write-only field, and nothing you run ever sees it.
|
|
29
|
+
|
|
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
|
+
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 contract --refresh`) and read it again.
|
|
33
|
+
|
|
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
|
+
|
|
36
|
+
## Naming accounts
|
|
37
|
+
|
|
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
|
+
|
|
40
|
+
## An account that already exists
|
|
41
|
+
|
|
42
|
+
The script reads each enrolled account. Read it back in their words:
|
|
43
|
+
|
|
44
|
+
- **Active, or attested.** "Your Claude account, Work laptop, is enrolled and can take work." Move on.
|
|
45
|
+
- **Out of rotation.** Every account is deactivated. Reactivate one on its own page. Never enrol another.
|
|
46
|
+
- **Needs a new credential.** Quarantined, expired or revoked, or its last polls failed on the credential itself. Replace the credential on that account's own page, with a credential from that same login. The steps, and the login check that has to come first, are in `references/replacing-a-credential.md`. Never enrol a second account for this.
|
|
47
|
+
- **Cancelled or ended.** The subscription was cancelled, or the provider ended the account. Say so in one clause and move on: it stays for reporting, it is not used, and it is not counted against setup. Never paste a token from another login into it, which would put a live account's credential onto a dead slot, and never tell them to retire or delete it. If the subscription comes back, they reactivate it on its own page.
|
|
48
|
+
- **Could not be read.** Say the accounts could not be read this time and read again later. It is not "no accounts". Do not tell them to enrol one on this reading.
|
|
49
|
+
|
|
50
|
+
## When more than one is right
|
|
51
|
+
|
|
52
|
+
One account is enough to start. A second one, on a different provider or plan, gives the router somewhere to go when the first is at its limit. Offer it as a later improvement, not as a step now.
|
|
@@ -2,9 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
The cloud containers build and test the repository. They 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.
|
|
4
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.
|
|
6
|
+
|
|
5
7
|
## The inventory, in order
|
|
6
8
|
|
|
7
|
-
1. Start from the commands that already build and test the repository: the README's setup section, the scripts in `package.json` or its equivalent, and the build and test steps in CI. Those are what the container runs. A name they never read does not belong in the file.
|
|
9
|
+
1. Start from the commands that already build and test the repository: the README's setup section, the scripts in `package.json` or its equivalent, and the build and test steps in CI. Those are what the container runs. A name they never read does not belong in the file. Read these files directly; the inventory needs no git command.
|
|
8
10
|
2. For each name, record 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
11
|
3. Mark whether the container needs it to build and test, or only to deploy. Containers build and test. They do not deploy.
|
|
10
12
|
4. Leave platform bindings and deploy-only CI secrets out by default. The platform supplies a binding at run time, and no build or test reads a deploy-only secret. Include one only when the person says the build needs it, and say why.
|
|
@@ -41,4 +43,4 @@ run = ["npm", "ci"]
|
|
|
41
43
|
|
|
42
44
|
## After the merge
|
|
43
45
|
|
|
44
|
-
`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.
|
|
@@ -36,9 +36,9 @@ Say these two things plainly:
|
|
|
36
36
|
|
|
37
37
|
The same page takes a Claude account's new credential. Its field is "Replacement setup token". `claude setup-token` mints a token for whichever Claude account the terminal is logged into, not for the slot. So first match them: read the slot's account on the AI accounts page (its label or email), then have the person run `claude` and `/status` to see the email the terminal is logged into. If they differ, stop, and log in to the slot's account first. Only then run `claude setup-token`, paste the token into that field, and press Replace credential. Then re-run the script.
|
|
38
38
|
|
|
39
|
-
##
|
|
39
|
+
## A cancelled or ended account
|
|
40
40
|
|
|
41
|
-
An account whose subscription is cancelled, or which has ended, is not a credential problem, and no token revives it.
|
|
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.
|
|
42
42
|
|
|
43
43
|
## Any other provider
|
|
44
44
|
|
|
@@ -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
|
|
|
@@ -1,147 +1,115 @@
|
|
|
1
1
|
# The one path
|
|
2
2
|
|
|
3
|
-
The steps run in
|
|
3
|
+
The steps run in the order a person can act on them, and the order says why: the coding account first, because nothing runs without one and it needs nothing else; the Linear integration, because the project list cannot be read without it; one project; the GitHub App and the repository it will work in; the person's own connected accounts, GitHub last because a registered repository is the proof the App is usable; the repository's settings file; then the first ticket. Each step is the cheapest place to catch the failure the next one would otherwise hide.
|
|
4
4
|
|
|
5
|
-
Walk them **one at a time**. Before each step say what
|
|
5
|
+
Walk them **one at a time**. Before each step say what it is for, in a sentence, and ask one question or do one thing. After it, show what actually came back. `node scripts/where-am-i.mjs --next` decides which step you are on, never your memory of the last turn. Two or three short sentences per turn is the right size.
|
|
6
6
|
|
|
7
|
-
Each step
|
|
7
|
+
Each step states: what it is for, what you ask or run or hand over, **what you read back to prove it landed**, and **who owns it**.
|
|
8
8
|
|
|
9
|
-
## 0
|
|
9
|
+
## 0. Where are we
|
|
10
10
|
|
|
11
|
-
**For:** starting from the truth instead of
|
|
11
|
+
**For:** starting from the truth instead of an assumption. A person arrives having done anything from nothing to most of it, and the installer has usually connected the machine already.
|
|
12
12
|
|
|
13
|
-
**You run:** `node scripts/where-am-i.mjs
|
|
14
|
-
|
|
15
|
-
**Read back:** the whole thing, as it printed. Then say in one sentence which part is unfinished and whose it is.
|
|
13
|
+
**You run:** `node scripts/where-am-i.mjs --next`. Read the one line, then say in a sentence which step is next and whose it is. Do not paste the full report.
|
|
16
14
|
|
|
17
15
|
**Owner:** you.
|
|
18
16
|
|
|
19
|
-
## 1
|
|
20
|
-
|
|
21
|
-
**For:** giving this machine a credential, so every later read is the person's own.
|
|
22
|
-
|
|
23
|
-
**You run:** `catalyst-skills login`. It prints a short code and a URL. The person approves it in a browser — from a phone, if this machine has none.
|
|
24
|
-
|
|
25
|
-
**Read back:** the `Connected to …` and `Connected as …` lines the command printed, then `node scripts/where-am-i.mjs` again so the machine part flips.
|
|
26
|
-
|
|
27
|
-
**Owner:** you run it; **the approval is the person's, in a browser, and always will be.** Wait for them. Do not re-run the command while a code is outstanding — that invalidates the code they are typing.
|
|
28
|
-
|
|
29
|
-
If it refuses, stop here and use the `connect-me` skill; it owns every failure mode of this step.
|
|
30
|
-
|
|
31
|
-
## 2 — Who you are
|
|
32
|
-
|
|
33
|
-
**For:** the person grain. A connected machine does not mean an active seat, and an active seat does not mean their Linear identity is matched.
|
|
34
|
-
|
|
35
|
-
**You run:** it is already in the step 0 script's `person` line.
|
|
36
|
-
|
|
37
|
-
**Read back:** their label and role, and whether their Linear identity is matched.
|
|
38
|
-
|
|
39
|
-
**Owner:** a personal Linear connection normally matches the person's Linear identity automatically. If it remains unmatched after personal consent, run `catalyst-skills identity linear status`, then `catalyst-skills identity linear options`. Let the member select their own listed identity and run `catalyst-skills identity linear set <linearUserId>`. The command reads the result back. An automatically resolved identity cannot be replaced; an existing claim conflict needs a tenant owner or admin. An inactive seat also needs an owner or admin. Say which finding the instrument reported.
|
|
40
|
-
|
|
41
|
-
## 3 — Connect Linear
|
|
42
|
-
|
|
43
|
-
**For:** the account grain. Nothing about a project can be read or mapped until the tenant's Linear workspace is connected.
|
|
44
|
-
|
|
45
|
-
**You hand over:** `<their cloud>/settings/connections`, and say: connect Linear.
|
|
46
|
-
|
|
47
|
-
**Read back:** after they say it is done, re-run `node scripts/where-am-i.mjs` and read them the `account` line. A resolved workspace is proof. If it still reads unresolved, say the contract may be cached and run `catalyst-skills contract --refresh`, then read it again.
|
|
17
|
+
## 1. Connect this machine
|
|
48
18
|
|
|
49
|
-
**
|
|
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.
|
|
50
20
|
|
|
51
|
-
|
|
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.
|
|
52
22
|
|
|
53
|
-
**
|
|
23
|
+
**Read back:** the `Connected to …` and `Connected as …` lines, then the script again so the machine part flips.
|
|
54
24
|
|
|
55
|
-
**
|
|
25
|
+
**Owner:** you run it; the approval is the person's, in a browser, and always will be. Do not re-run the command while a code is outstanding. If it refuses, stop and use the `connect-me` skill.
|
|
56
26
|
|
|
57
|
-
|
|
27
|
+
## 2. A coding account
|
|
58
28
|
|
|
59
|
-
**
|
|
29
|
+
**For:** what the work runs on. Catalyst runs each stage of a ticket on an account the person owns, at their own rate, under their own name. With none enrolled, every later step can be finished and nothing will ever start.
|
|
60
30
|
|
|
61
|
-
|
|
31
|
+
**You ask:** "Do you already have a coding account you want Catalyst to run on?" Then `references/choosing-a-coding-account.md`: the four kinds, what each asks for, how to enrol one, and what to do with an account that is out of rotation, needs a new credential, or has ended.
|
|
62
32
|
|
|
63
|
-
**
|
|
33
|
+
**Read back:** the `coding accounts` part: an enrolled, active account, named by its label. A cancelled or ended one is kept for reporting, not used, never re-tokened, and does not hold this step up.
|
|
64
34
|
|
|
65
|
-
**
|
|
35
|
+
**Owner:** a workspace owner or admin, in a browser, on the AI accounts page. Nothing you run ever sees the credential.
|
|
66
36
|
|
|
67
|
-
|
|
37
|
+
## 3. Connect the Linear integration
|
|
68
38
|
|
|
69
|
-
**
|
|
39
|
+
**For:** the workspace. Until the workspace's Linear connection exists, no project can be read or mapped. Say that this is the one connection the whole workspace shares, made once by an admin.
|
|
70
40
|
|
|
71
|
-
|
|
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.
|
|
72
42
|
|
|
73
|
-
|
|
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.
|
|
74
44
|
|
|
75
|
-
**
|
|
45
|
+
**Owner:** a workspace owner or admin, in a browser. **Browser by construction**: it is an authorization grant, and no key can perform one.
|
|
76
46
|
|
|
77
|
-
|
|
47
|
+
## 4. Pick one project, and map its stages
|
|
78
48
|
|
|
79
|
-
**
|
|
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.
|
|
80
50
|
|
|
81
|
-
**
|
|
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.
|
|
82
52
|
|
|
83
|
-
|
|
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>`.
|
|
84
54
|
|
|
85
|
-
|
|
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.
|
|
86
56
|
|
|
87
|
-
|
|
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.
|
|
88
58
|
|
|
89
|
-
**
|
|
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.
|
|
90
60
|
|
|
91
|
-
|
|
61
|
+
## 5. Install the GitHub App
|
|
92
62
|
|
|
93
|
-
**
|
|
63
|
+
**For:** the workspace's GitHub integration. Without it Catalyst can read tickets but cannot touch code.
|
|
94
64
|
|
|
95
|
-
**
|
|
65
|
+
**You hand over:** the same Connections page, and say: install the GitHub App, and grant it the repository they want worked and `<org>/thoughts`. Catalyst's cloud phases write their notes to `<org>/thoughts`, where `<org>` owns the code repository. If it does not exist, they create a private repository named `thoughts`, initialized with a README, and then on the App's installation page for that org choose All repositories, or add `thoughts` to the selected repositories. The script's `repositories` part notes whether `gh` can see that repository, never that the App can reach it, so do not claim that.
|
|
96
66
|
|
|
97
|
-
|
|
67
|
+
**Read back:** it is confirmed by step 6 succeeding. A repository cannot be registered through an App that is not installed. Say that is what you are waiting for.
|
|
98
68
|
|
|
99
|
-
**
|
|
69
|
+
**Owner:** a workspace owner or admin, in a browser. Browser by construction, same reason as step 3.
|
|
100
70
|
|
|
101
|
-
##
|
|
71
|
+
## 6. Register the repository
|
|
102
72
|
|
|
103
|
-
**For:** the
|
|
73
|
+
**For:** the repository. Registering, attached to a project, is what makes a repository something that project can dispatch work into.
|
|
104
74
|
|
|
105
|
-
You
|
|
75
|
+
**You hand over:** `<their cloud>/settings/repositories`, and say: add the repository, **and attach it to the project you mapped in step 4**, in the same form.
|
|
106
76
|
|
|
107
|
-
**
|
|
77
|
+
**Read back:** re-run the script and read the `repositories` line. The repository appearing there proves it was registered, and only that; see `references/who-fixes-what.md` for what registration does not prove.
|
|
108
78
|
|
|
109
|
-
|
|
79
|
+
**Owner:** a workspace owner or admin. ⛔ Registering is settings-page work today. ⛔ A repository registered without a project attached is the trap: the call succeeds, the repository is listed, and nothing can ever dispatch into it.
|
|
110
80
|
|
|
111
|
-
|
|
112
|
-
catalyst-skills environment propose --file declaration.json
|
|
113
|
-
```
|
|
81
|
+
## 7. Connect your own accounts
|
|
114
82
|
|
|
115
|
-
|
|
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.
|
|
116
84
|
|
|
117
|
-
**
|
|
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`.
|
|
118
86
|
|
|
119
|
-
**
|
|
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.
|
|
120
88
|
|
|
121
|
-
|
|
89
|
+
**Owner:** you start and check; the person approves in a browser.
|
|
122
90
|
|
|
123
|
-
|
|
91
|
+
## 8. The repository's settings file
|
|
124
92
|
|
|
125
|
-
|
|
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.
|
|
126
94
|
|
|
127
|
-
**
|
|
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.
|
|
128
96
|
|
|
129
|
-
**
|
|
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.
|
|
130
98
|
|
|
131
|
-
|
|
99
|
+
**Owner:** the person, with you, in the repository; a workspace owner or admin for the approval.
|
|
132
100
|
|
|
133
|
-
## 9
|
|
101
|
+
## 9. Verify, then run the first ticket
|
|
134
102
|
|
|
135
103
|
**For:** the only thing that proves setup worked.
|
|
136
104
|
|
|
137
|
-
**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.
|
|
138
106
|
|
|
139
|
-
**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`.
|
|
140
108
|
|
|
141
|
-
**Read back:** what `explain` actually said. If
|
|
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.
|
|
142
110
|
|
|
143
|
-
**Owner:** the card move is theirs. The verdict is the
|
|
111
|
+
**Owner:** the card move is theirs. The verdict is the workspace's.
|
|
144
112
|
|
|
145
113
|
## When you are done
|
|
146
114
|
|
|
147
|
-
Say what is set up, name anything still unfinished with its owner, and never say work can run while the `coding accounts` or `host` part is unfinished
|
|
115
|
+
Say what is set up, name anything still unfinished with its owner, and never say work can run while the `coding accounts` or `host` part is unfinished. Tell them the standing question "am I set up?" now belongs to the `catalyst-setup` skill, and "what's happening?" to `whats-happening`. You do not need to be invoked again.
|