copilotkit 4.25.1 → 4.26.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -10
- package/cli-build-info.json +6 -6
- package/index.js +795 -716
- package/onboarding/index.json +2 -2
- package/onboarding/prompts/authenticate/start.md +13 -13
- package/onboarding/prompts/conversion/plan.md +3 -3
- package/onboarding/prompts/credentials/finalize-plan.md +13 -13
- package/onboarding/prompts/credentials/plan.md +23 -23
- package/onboarding/prompts/credentials/settle-credentials.md +8 -7
- package/onboarding/prompts/credentials/write-plan.md +7 -7
- package/onboarding/prompts/deployment/choose-local.md +10 -10
- package/onboarding/prompts/deployment/local-evaluation.md +7 -7
- package/onboarding/prompts/fallback/best-effort.md +6 -6
- package/onboarding/prompts/feature/a2ui/implement.md +4 -4
- package/onboarding/prompts/feature/a2ui/plan.md +3 -3
- package/onboarding/prompts/feature/a2ui/proof.md +5 -5
- package/onboarding/prompts/feature/a2ui/start.md +8 -8
- package/onboarding/prompts/feature/channels/implement.md +6 -6
- package/onboarding/prompts/feature/channels/plan.md +3 -3
- package/onboarding/prompts/feature/channels/proof.md +5 -5
- package/onboarding/prompts/feature/channels/start.md +8 -8
- package/onboarding/prompts/feature/chat-suggestions/implement.md +4 -4
- package/onboarding/prompts/feature/chat-suggestions/plan.md +3 -3
- package/onboarding/prompts/feature/chat-suggestions/proof.md +5 -5
- package/onboarding/prompts/feature/chat-suggestions/start.md +8 -8
- package/onboarding/prompts/feature/complete.md +2 -2
- package/onboarding/prompts/feature/learning/implement.md +12 -12
- package/onboarding/prompts/feature/learning/plan.md +4 -4
- package/onboarding/prompts/feature/learning/proof.md +12 -12
- package/onboarding/prompts/feature/learning/start.md +8 -8
- package/onboarding/prompts/feature/open-generative-ui/implement.md +4 -4
- package/onboarding/prompts/feature/open-generative-ui/plan.md +3 -3
- package/onboarding/prompts/feature/open-generative-ui/proof.md +5 -5
- package/onboarding/prompts/feature/open-generative-ui/start.md +8 -8
- package/onboarding/prompts/feature/realtime-sync/implement.md +5 -5
- package/onboarding/prompts/feature/realtime-sync/plan.md +3 -3
- package/onboarding/prompts/feature/realtime-sync/proof.md +5 -5
- package/onboarding/prompts/feature/realtime-sync/start.md +7 -7
- package/onboarding/prompts/feature/rich-threads/implement.md +6 -6
- package/onboarding/prompts/feature/rich-threads/plan.md +3 -3
- package/onboarding/prompts/feature/rich-threads/proof.md +5 -5
- package/onboarding/prompts/feature/rich-threads/start.md +7 -7
- package/onboarding/prompts/feature/stop.md +4 -4
- package/onboarding/prompts/feature/voice/implement.md +4 -4
- package/onboarding/prompts/feature/voice/plan.md +4 -4
- package/onboarding/prompts/feature/voice/proof.md +5 -5
- package/onboarding/prompts/feature/voice/start.md +8 -8
- package/onboarding/prompts/framework/ag2.md +2 -2
- package/onboarding/prompts/framework/agno.md +2 -2
- package/onboarding/prompts/framework/built-in.md +2 -2
- package/onboarding/prompts/framework/claude-sdk-python.md +2 -2
- package/onboarding/prompts/framework/claude-sdk-typescript.md +2 -2
- package/onboarding/prompts/framework/crewai-flows.md +3 -3
- package/onboarding/prompts/framework/custom-ag-ui.md +3 -3
- package/onboarding/prompts/framework/deep-agents.md +2 -2
- package/onboarding/prompts/framework/google-adk.md +2 -2
- package/onboarding/prompts/framework/langgraph-fastapi.md +2 -2
- package/onboarding/prompts/framework/langgraph-python.md +2 -2
- package/onboarding/prompts/framework/langgraph-typescript.md +2 -2
- package/onboarding/prompts/framework/llamaindex.md +2 -2
- package/onboarding/prompts/framework/mastra.md +2 -2
- package/onboarding/prompts/framework/ms-agent-dotnet.md +4 -4
- package/onboarding/prompts/framework/ms-agent-harness-dotnet.md +4 -4
- package/onboarding/prompts/framework/ms-agent-python.md +2 -2
- package/onboarding/prompts/framework/pydantic-ai.md +2 -2
- package/onboarding/prompts/framework/strands-python.md +2 -2
- package/onboarding/prompts/framework/strands-typescript.md +2 -2
- package/onboarding/prompts/frontend/angular.md +4 -4
- package/onboarding/prompts/frontend/nextjs.md +4 -4
- package/onboarding/prompts/frontend/plan.md +8 -8
- package/onboarding/prompts/frontend/react-native.md +3 -3
- package/onboarding/prompts/frontend/react-spa.md +3 -3
- package/onboarding/prompts/frontend/vue.md +3 -3
- package/onboarding/prompts/implementation/build-and-validate.md +10 -10
- package/onboarding/prompts/proof/complete.md +3 -3
- package/onboarding/prompts/proof/oss-baseline.md +5 -5
- package/onboarding/prompts/proof/round-trip.md +10 -10
- package/onboarding/prompts/research/gather.md +8 -8
- package/onboarding/prompts/research/merge.md +3 -3
- package/onboarding/prompts/research/preflight.md +2 -2
- package/onboarding/prompts/research/route.md +4 -4
- package/onboarding/prompts/setup/questions.md +31 -29
- package/onboarding/prompts/starter/clone.md +23 -23
- package/onboarding/prompts/stopped/run-failed.md +3 -3
- package/onboarding/prompts/subagent/create-plan.md +9 -5
- package/onboarding/prompts/subagent/implement-and-validate.md +6 -3
- package/onboarding/prompts/subagent/inspect-repository.md +1 -1
- package/onboarding/prompts/subagent/prove-oss-baseline.md +1 -1
- package/onboarding/prompts/subagent/prove-round-trip.md +5 -5
- package/onboarding/prompts/unsupported/no-validated-path.md +3 -3
- package/package.json +1 -1
|
@@ -13,7 +13,7 @@ acted on. Send one short report before you stop. The friction command follows th
|
|
|
13
13
|
setting the developer already chose, so it needs no separate question.
|
|
14
14
|
|
|
15
15
|
```text
|
|
16
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
16
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard friction --phase stop --category <slug> --message "<sentences>"
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
`--message` takes one or two sentences: the step you stopped at and what stopped it.
|
|
@@ -53,7 +53,7 @@ This prompt pauses for the developer in several places. Before you end your turn
|
|
|
53
53
|
for the developer, report the pause:
|
|
54
54
|
|
|
55
55
|
```text
|
|
56
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
56
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard checkpoint --phase awaiting-developer
|
|
57
57
|
```
|
|
58
58
|
|
|
59
59
|
The existing agent's behavior is never a departure to record and carry on from. It is four
|
|
@@ -70,7 +70,7 @@ declines, use the route-out rules below.
|
|
|
70
70
|
Before you end your turn to wait for the developer, report the pause:
|
|
71
71
|
|
|
72
72
|
```text
|
|
73
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
73
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard checkpoint --phase awaiting-developer
|
|
74
74
|
```
|
|
75
75
|
|
|
76
76
|
## The developer's uncommitted files
|
|
@@ -92,12 +92,12 @@ or from an environment variable.
|
|
|
92
92
|
If the CLI prints `## Stop: this run deleted or moved the developer's work` instead of a
|
|
93
93
|
step, show the developer the list it printed, and run what they choose:
|
|
94
94
|
the `onboard restore` command the tripwire stop prints, which names each deleted file, or
|
|
95
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
95
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard tripwire --continue`. Then read the step again. If
|
|
96
96
|
you cannot ask, use the route-out rules below. Before you end your turn to wait for the
|
|
97
97
|
developer, report the pause:
|
|
98
98
|
|
|
99
99
|
```text
|
|
100
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
100
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard checkpoint --phase awaiting-developer
|
|
101
101
|
```
|
|
102
102
|
|
|
103
103
|
## Implement the plan
|
|
@@ -111,7 +111,7 @@ Run this from the target app directory. The developer approved the id with the p
|
|
|
111
111
|
is the first point at which it can be created:
|
|
112
112
|
|
|
113
113
|
```text
|
|
114
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
114
|
+
npx --prefer-offline --yes copilotkit@4.26.0 learning containers create --id <id> --name <name> --json
|
|
115
115
|
```
|
|
116
116
|
|
|
117
117
|
Pass the id the plan names. Take the name from the selected project's own display name, so
|
|
@@ -125,7 +125,7 @@ failure to repair and not a reason to pick a new id. Any other error code: repor
|
|
|
125
125
|
stop onboarding, so no run wires a selector to an id the platform does not hold.
|
|
126
126
|
|
|
127
127
|
Spawn one implementation subagent. Tell it to run
|
|
128
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
128
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard read subagent/implement-and-validate` first and
|
|
129
129
|
follow the prompt it returns. Tell it to return at once, and say so, if that read is refused
|
|
130
130
|
or fails, and not to wait for an approval. If it returns that way, stop that subagent. Run
|
|
131
131
|
the same command yourself, then spawn a fresh subagent with the returned prompt and the same
|
|
@@ -160,7 +160,7 @@ Report it and take the failure ending.
|
|
|
160
160
|
If the implementation result does not start with `Status: passed`, do not continue to proof.
|
|
161
161
|
|
|
162
162
|
Then run
|
|
163
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
163
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard read proof/round-trip`.
|
|
164
164
|
|
|
165
165
|
## Repair rules
|
|
166
166
|
|
|
@@ -188,9 +188,9 @@ developer
|
|
|
188
188
|
declined a file the plan does not name, or the run cannot ask them about it. A defect in a
|
|
189
189
|
package this run installed is not a stack CopilotKit does not serve, and a command this run
|
|
190
190
|
cannot get to pass is not one either. In those cases run
|
|
191
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
191
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard read stopped/run-failed`.
|
|
192
192
|
|
|
193
193
|
A plan with no path to follow takes the unsupported ending: the fix requires changing the
|
|
194
194
|
developer's existing agent or frontend, or the documentation does not support the plan. In
|
|
195
195
|
those cases run
|
|
196
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
196
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard read unsupported/no-validated-path`.
|
|
@@ -24,7 +24,7 @@ friction commands follow the telemetry setting the developer already chose, so t
|
|
|
24
24
|
separate question.
|
|
25
25
|
|
|
26
26
|
```text
|
|
27
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
27
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard friction --category <slug> --cost-seconds <seconds> --message "<sentences>"
|
|
28
28
|
```
|
|
29
29
|
|
|
30
30
|
Put one or two sentences in `--message`. Pick one category from docs-missing, docs-wrong,
|
|
@@ -46,7 +46,7 @@ Pass the surface-check outcome the proof subagent returned, not the one you want
|
|
|
46
46
|
web frontend, pass `--visual-check` and the URL the browser opened, unchanged:
|
|
47
47
|
|
|
48
48
|
```text
|
|
49
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
49
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard complete --visual-check <outcome> \
|
|
50
50
|
--frontend-url <the url you opened>
|
|
51
51
|
```
|
|
52
52
|
|
|
@@ -74,7 +74,7 @@ this graph opens.
|
|
|
74
74
|
nothing drove the frontend:
|
|
75
75
|
|
|
76
76
|
```text
|
|
77
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
77
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard complete --visual-check failed --blocked-by browser-control-unresponsive
|
|
78
78
|
```
|
|
79
79
|
|
|
80
80
|
## Write the handoff
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Prove the existing OSS baseline
|
|
2
2
|
|
|
3
3
|
Do not prove the baseline yourself. Spawn one proof subagent. Tell it to run
|
|
4
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
4
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard read subagent/prove-oss-baseline` first and follow
|
|
5
5
|
the prompt it returns. Tell it to return at once, and say so, if that read is refused or
|
|
6
6
|
fails, and not to wait for an approval. If it returns that way, stop that subagent. Run the
|
|
7
7
|
same command yourself, then spawn a fresh subagent with the returned prompt and the same
|
|
@@ -18,7 +18,7 @@ Wait for the subagent to finish.
|
|
|
18
18
|
Record what that proof returned before you route on it:
|
|
19
19
|
|
|
20
20
|
```text
|
|
21
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
21
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard proof --step oss-baseline --outcome <passed|failed|skipped> [--predicate <1-6>]
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
Report the gate whatever it returned. Use the list below. A proof that never ran is `skipped`, not failed. The command prints one line and sends
|
|
@@ -40,7 +40,7 @@ Do not change project files before this proof ends. Starting existing developmen
|
|
|
40
40
|
processes and their ignored runtime files is allowed.
|
|
41
41
|
|
|
42
42
|
If the subagent proves the `both-oss` predicate, keep its evidence with the plan and run
|
|
43
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
43
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard read conversion/plan`. That project already works.
|
|
44
44
|
What it needs is the conversion, not a build.
|
|
45
45
|
|
|
46
46
|
A failed baseline does not end the run, and this step does not repair it. Decide which
|
|
@@ -55,7 +55,7 @@ pass. This proof only reads.
|
|
|
55
55
|
A failed baseline whose cause is in the project is the starting state of this project. So
|
|
56
56
|
is an operational failure still there after the third attempt. Record the starting state
|
|
57
57
|
`both-copilotkit-unproved` and run
|
|
58
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
58
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard read credentials/plan`. This prompt is served
|
|
59
59
|
whenever a project looks like an OSS integration, so a baseline that did not prove is an
|
|
60
60
|
ordinary starting state rather than a failure. The build that follows fixes the
|
|
61
61
|
integration, and `proof/round-trip` proves the result, with its own bounded repair cycle.
|
|
@@ -75,5 +75,5 @@ operational. Run the proof again, three times in total, then record the starting
|
|
|
75
75
|
above and go on. Both causes lead to the same plan.
|
|
76
76
|
|
|
77
77
|
If the proof cannot identify the running process safely, or it exposes a secret, run
|
|
78
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
78
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard read stopped/run-failed`. Neither means the
|
|
79
79
|
project is unsupported: each means this run did not establish what it needed to.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Prove the user journey
|
|
2
2
|
|
|
3
3
|
Do not do the proof work yourself. Spawn one proof subagent. Tell it to run
|
|
4
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
4
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard read subagent/prove-round-trip` first and follow the
|
|
5
5
|
prompt it returns. Tell it to return at once, and say so, if that read is refused or fails,
|
|
6
6
|
and not to wait for an approval. If it returns that way, stop that subagent. Run the same
|
|
7
7
|
command yourself, then spawn a fresh subagent with the returned prompt and the same handoff.
|
|
@@ -41,7 +41,7 @@ pass the time.
|
|
|
41
41
|
Record what that proof returned before you route on it:
|
|
42
42
|
|
|
43
43
|
```text
|
|
44
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
44
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard proof --step round-trip --outcome <passed|failed|skipped>
|
|
45
45
|
```
|
|
46
46
|
|
|
47
47
|
Report the gate whatever it returned. A proof that never ran is `skipped`, not failed. A
|
|
@@ -53,7 +53,7 @@ the next one starts. Until then, `onboard proof-check` counts the next failure a
|
|
|
53
53
|
If the CLI prints `## Stop: this run deleted or moved the developer's work` instead of a
|
|
54
54
|
step, show the developer the list it printed, and run what they choose:
|
|
55
55
|
the `onboard restore` command the tripwire stop prints, which names each deleted file, or
|
|
56
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
56
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard tripwire --continue`. Then read the step again. If
|
|
57
57
|
you cannot ask, use the route-out rules below.
|
|
58
58
|
|
|
59
59
|
Never repair, reset, or revert a file the developer changed outside this run. That holds for
|
|
@@ -66,11 +66,11 @@ This prompt pauses for the developer in several places. Before you end your turn
|
|
|
66
66
|
for the developer, report the pause:
|
|
67
67
|
|
|
68
68
|
```text
|
|
69
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
69
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard checkpoint --phase awaiting-developer
|
|
70
70
|
```
|
|
71
71
|
|
|
72
72
|
If the proof result starts with `Status: passed`, run
|
|
73
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
73
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard read proof/complete`. A performed surface outcome with
|
|
74
74
|
the full round trip is core success even if a continued-development tool fails. A skipped
|
|
75
75
|
surface outcome still enters `proof/complete`. The CLI records `skipped-cloned-starter` and
|
|
76
76
|
`skipped-no-browser-tool` after a passed round trip as complete, and `skipped-no-device` as
|
|
@@ -97,7 +97,7 @@ credentials step found the model key missing, or the vendor refused it, and the
|
|
|
97
97
|
started nothing. Do not send it to a repair worker. Run the `onboard credentials` command
|
|
98
98
|
that its detail names, and act on its answer as `credentials/settle-credentials` says. Ask
|
|
99
99
|
the developer its question, report the pause with
|
|
100
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
100
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard checkpoint --phase awaiting-model-credential`, and
|
|
101
101
|
end your turn. When the key settles, run the proof subagent again. If you have not recorded
|
|
102
102
|
this attempt yet, record it first, with the outcome it ended with. This attempt does not
|
|
103
103
|
count toward the three.
|
|
@@ -124,7 +124,7 @@ fault, so this is not a route-out. Ask the developer to send one message in the
|
|
|
124
124
|
thread, and to give you that thread's id. Give them the app URL and the request words from
|
|
125
125
|
the result. Tell them where the id is: in the browser's network tools, the request the page
|
|
126
126
|
sends to the runtime URL carries `threadId` in its body. Report the pause with
|
|
127
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
127
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard checkpoint --phase awaiting-developer` and end your
|
|
128
128
|
turn. When the developer gives the id, start a new proof subagent with
|
|
129
129
|
the full original proof handoff, the pinned Step 1 record, and the thread id. Tell it to run
|
|
130
130
|
the proof checks with `--thread <id>`. This attempt does not count toward the three. Use the
|
|
@@ -173,7 +173,7 @@ files the developer allowed, and the developer's answer on the Skills install.
|
|
|
173
173
|
Before you end your turn to wait for the developer, report the pause:
|
|
174
174
|
|
|
175
175
|
```text
|
|
176
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
176
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard checkpoint --phase awaiting-developer
|
|
177
177
|
```
|
|
178
178
|
|
|
179
179
|
Restart each project-owned process changed by the repair. Then spawn a fresh proof subagent
|
|
@@ -191,7 +191,7 @@ takes the developer path above instead.
|
|
|
191
191
|
|
|
192
192
|
Route out only when the failure is not yours to fix, when the same proof still fails after
|
|
193
193
|
three attempts, or when no evidence of the round trip can be produced. In those cases run
|
|
194
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
194
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard read stopped/run-failed`. The stack is supported:
|
|
195
195
|
this run did not finish, which is a different ending and a different report. All three are
|
|
196
196
|
about the round trip itself. A round trip that proved is not one of them, whatever failed
|
|
197
197
|
after it.
|
|
@@ -202,7 +202,7 @@ friction command follows the telemetry setting the developer already chose, so i
|
|
|
202
202
|
separate question.
|
|
203
203
|
|
|
204
204
|
```text
|
|
205
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
205
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard friction --phase stop --category <slug> --message "<sentences>"
|
|
206
206
|
```
|
|
207
207
|
|
|
208
208
|
`--message` takes one or two sentences: the step you stopped at and what stopped it.
|
|
@@ -14,10 +14,10 @@ own bookkeeping. Say what the run is doing in the developer's words instead.
|
|
|
14
14
|
|
|
15
15
|
Every later command must run from the directory this run is bound to. Elsewhere, the
|
|
16
16
|
command cannot find its run and refuses. Do not report that refusal as a stop. Run
|
|
17
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
17
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard start --run <onboarding_run_id>` where you are
|
|
18
18
|
standing, then run the refused command again.
|
|
19
19
|
|
|
20
|
-
If you no longer hold the id, run `npx --prefer-offline --yes copilotkit@4.
|
|
20
|
+
If you no longer hold the id, run `npx --prefer-offline --yes copilotkit@4.26.0 onboard start` in the
|
|
21
21
|
directory this run started in, with no `--run` and no `--intent`. It reprints the id
|
|
22
22
|
and starts nothing. An id this project does not already hold starts a second
|
|
23
23
|
run, and the work already done stops counting toward the first.
|
|
@@ -82,7 +82,7 @@ When that thing arrives, continue. A pause waits for one of two things:
|
|
|
82
82
|
Before you end your turn to wait for the developer, report the pause:
|
|
83
83
|
|
|
84
84
|
```text
|
|
85
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
85
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard checkpoint --phase awaiting-developer
|
|
86
86
|
```
|
|
87
87
|
|
|
88
88
|
When the answer or the result arrives, continue from the step that paused. Do not read an
|
|
@@ -102,7 +102,7 @@ Both research subagents failing means this harness has no working subagent at al
|
|
|
102
102
|
is worth recording once:
|
|
103
103
|
|
|
104
104
|
```text
|
|
105
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
105
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard checkpoint --phase delegation-unavailable
|
|
106
106
|
```
|
|
107
107
|
|
|
108
108
|
Then say once, in your own words, that this environment has no working subagents. Say that
|
|
@@ -118,8 +118,8 @@ Prepare two research assignments. Before you spawn either subagent, run these tw
|
|
|
118
118
|
read-only commands yourself, from the target project directory:
|
|
119
119
|
|
|
120
120
|
```text
|
|
121
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
122
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
121
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard read subagent/inspect-repository
|
|
122
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard inspect --json
|
|
123
123
|
```
|
|
124
124
|
|
|
125
125
|
Give each research subagent the prompt that the first command returns, the whole JSON that
|
|
@@ -140,8 +140,8 @@ Start both research subagents in parallel:
|
|
|
140
140
|
The research is under way. Continue to the surface-control preflight while it runs:
|
|
141
141
|
|
|
142
142
|
```text
|
|
143
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
143
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard read research/preflight
|
|
144
144
|
```
|
|
145
145
|
|
|
146
146
|
If inspection stops onboarding, run
|
|
147
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
147
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard read stopped/run-failed`.
|
|
@@ -51,11 +51,11 @@ waits on the developer, end your turn and wait for it: that is a pause.
|
|
|
51
51
|
Before you end your turn to wait for the developer, report the pause:
|
|
52
52
|
|
|
53
53
|
```text
|
|
54
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
54
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard checkpoint --phase awaiting-developer
|
|
55
55
|
```
|
|
56
56
|
|
|
57
57
|
When both research results are merged and sign-in is done, run
|
|
58
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
58
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard read research/route`.
|
|
59
59
|
|
|
60
60
|
If inspection stops onboarding, run
|
|
61
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
61
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard read stopped/run-failed`.
|
|
@@ -32,8 +32,8 @@ Where the device probe found no booted device, that is the whole finding.
|
|
|
32
32
|
Then merge the research:
|
|
33
33
|
|
|
34
34
|
```text
|
|
35
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
35
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard read research/merge
|
|
36
36
|
```
|
|
37
37
|
|
|
38
38
|
If inspection stops onboarding, run
|
|
39
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
39
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard read stopped/run-failed`.
|
|
@@ -21,7 +21,7 @@ On any one of them, run this before you read the three findings below, and witho
|
|
|
21
21
|
the purpose question:
|
|
22
22
|
|
|
23
23
|
```text
|
|
24
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
24
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard read feature/channels/start
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
Name the provider to that node so it does not ask again. A `/slack` page names Slack. A
|
|
@@ -82,7 +82,7 @@ settle these three from your own reading of the project. Each one comes from the
|
|
|
82
82
|
packets or it is not proved.
|
|
83
83
|
|
|
84
84
|
If all three are proved, prove the live starting state before any project file changes. Run
|
|
85
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
85
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard read proof/oss-baseline`.
|
|
86
86
|
|
|
87
87
|
Route there before any other question to the developer. The questions after this prompt
|
|
88
88
|
select a framework and a frontend that the findings already name, so a developer who
|
|
@@ -91,10 +91,10 @@ application is what that node protects. Whether it works is what the proof decid
|
|
|
91
91
|
these three findings.
|
|
92
92
|
|
|
93
93
|
For every other combination of the three, run
|
|
94
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
94
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard read setup/questions`. That node asks every
|
|
95
95
|
remaining setup question in one message, including what the project is for when nothing
|
|
96
96
|
proves it.
|
|
97
97
|
|
|
98
98
|
If authentication or inspection stops onboarding, run
|
|
99
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
99
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard read stopped/run-failed`. Neither says anything
|
|
100
100
|
about whether this project's stack is supported, which is not yet known at this point.
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
# Ask the setup questions together
|
|
2
2
|
|
|
3
3
|
The route is chosen. This node asks, in one message, every setup choice that the findings
|
|
4
|
-
and the developer's request do not settle.
|
|
5
|
-
goes on without them until the plan is ready for approval. Do not change application code
|
|
4
|
+
and the developer's request do not settle. Do not change application code
|
|
6
5
|
in this phase. Do not read, show, store, or request a secret value.
|
|
7
6
|
|
|
8
7
|
## Settle what the findings already answer
|
|
@@ -37,8 +36,8 @@ about a missing toolchain before they choose, and not after.
|
|
|
37
36
|
Ask every choice that is still open at this point in one message, one numbered line per
|
|
38
37
|
choice, so that one reply can accept every recommendation. Put the recommendation first,
|
|
39
38
|
give its evidence in one sentence, and keep the alternatives short. Do not ask a yes-or-no
|
|
40
|
-
question first. Leave out a line whose answer is settled. Do not ask about the plan
|
|
41
|
-
|
|
39
|
+
question first. Leave out a line whose answer is settled. Do not ask about the plan
|
|
40
|
+
here.
|
|
42
41
|
|
|
43
42
|
**Line 1: what the project is for.**
|
|
44
43
|
|
|
@@ -94,8 +93,7 @@ the framework's CopilotKit pages:
|
|
|
94
93
|
|
|
95
94
|
"Project-defined" is not a missing default. It means that framework's own route settles
|
|
96
95
|
the vendor with the developer: it keeps the one the repository already uses, and asks a
|
|
97
|
-
single question when the repository shows none.
|
|
98
|
-
cannot onboard.
|
|
96
|
+
single question when the repository shows none.
|
|
99
97
|
|
|
100
98
|
"The agent's own" means that the route keeps the vendor the existing agent already uses.
|
|
101
99
|
Ask no vendor question for it.
|
|
@@ -103,25 +101,34 @@ Ask no vendor question for it.
|
|
|
103
101
|
Do not offer a framework that is not listed above. Do not port an existing agent to another
|
|
104
102
|
framework.
|
|
105
103
|
|
|
106
|
-
**Line 3: the model
|
|
104
|
+
**Line 3: the model and its key.**
|
|
107
105
|
|
|
108
|
-
|
|
109
|
-
cannot answer
|
|
106
|
+
Settle the vendor and where its key is here: without a key from that vendor, the developer
|
|
107
|
+
cannot answer the later key question.
|
|
110
108
|
|
|
111
109
|
For a new agent, ask this line, even if the framework needed no question. Skip it for an
|
|
112
110
|
existing agent, and when the default vendor is "Project-defined" or "The agent's own":
|
|
113
|
-
those routes settle the vendor themselves.
|
|
114
|
-
|
|
115
|
-
|
|
111
|
+
those routes settle the vendor themselves. Recommend the row's default vendor and, in the
|
|
112
|
+
same sentence, ask where its key is: a file, or that they will add it later. When the row
|
|
113
|
+
documents more than one vendor, name the others. Offer no vendor the row does not name. For
|
|
114
|
+
example, for the built-in agent: "Model: OpenAI, with the key in a file outside this folder,
|
|
115
|
+
or 'later'. Anthropic and Google work too." Never ask for the key itself.
|
|
116
|
+
|
|
117
|
+
With no file named, record that they will add it later. A path the developer names is
|
|
118
|
+
theirs to give, including one outside the project. Recommend the project's env file when it
|
|
119
|
+
exists, git ignores and does not track it, and it already holds the key. Otherwise recommend
|
|
120
|
+
a file outside the project, or "later". Never recommend an env file in the project while an
|
|
121
|
+
`env-file-exposed` line is open, or when git tracks it or does not ignore it. For an empty
|
|
122
|
+
target, a new key file goes outside the target directory, because `init` refuses a target
|
|
123
|
+
that holds a `.env` file. Tell the developer only where the file goes, not that reason.
|
|
116
124
|
|
|
117
125
|
**Line 4: the frontend.**
|
|
118
126
|
|
|
119
127
|
If the project has no frontend, ask this line. The valid choices are React SPA,
|
|
120
|
-
Next.js, Angular, Vue 3, React Native, Slack, and Microsoft Teams.
|
|
121
|
-
starting state.
|
|
128
|
+
Next.js, Angular, Vue 3, React Native, Slack, and Microsoft Teams.
|
|
122
129
|
|
|
123
130
|
Where there is no existing frontend, include Slack and Microsoft Teams in the frontend
|
|
124
|
-
question.
|
|
131
|
+
question. Then recommend the one the developer
|
|
125
132
|
names, and say what each choice implies for where the CopilotKit runtime lives: Next.js
|
|
126
133
|
hosts it in a route handler, Angular in its SSR server, and Vue 3, React SPA and React
|
|
127
134
|
Native reach a runtime that runs as its own process. Slack and Microsoft Teams use a
|
|
@@ -129,7 +136,7 @@ long-running Channel host, not a CopilotKit web app.
|
|
|
129
136
|
|
|
130
137
|
**Line 5: the project.** Leave out the project line on the local route: local evaluation
|
|
131
138
|
creates its own project. For an existing app, first
|
|
132
|
-
run `npx --prefer-offline --yes copilotkit@4.
|
|
139
|
+
run `npx --prefer-offline --yes copilotkit@4.26.0 onboard credentials --json` from the target app directory.
|
|
133
140
|
It only reads: it creates no project and writes no file. Read `status`:
|
|
134
141
|
|
|
135
142
|
- `ready`: the app already has a project. Leave the line out.
|
|
@@ -137,7 +144,8 @@ It only reads: it creates no project and writes no file. Read `status`:
|
|
|
137
144
|
the developer already has. If there is no `suggestedName`, ask for a name. Do not list
|
|
138
145
|
the organization's projects.
|
|
139
146
|
- `needs-developer` with `env-file-exposed`: git tracks the env file the key goes into, or
|
|
140
|
-
does not ignore it. Add `question.ask` as its own line,
|
|
147
|
+
does not ignore it. Add `question.ask` as its own line, word for word: never shorten it or
|
|
148
|
+
drop what it says about teammates. When
|
|
141
149
|
`question.untrack` is absent, recommend approving it: without it, the run writes no key. A
|
|
142
150
|
reply that accepts every recommendation approves it. When `question.untrack` is present,
|
|
143
151
|
git tracks the file. If `question.alternative` is present, recommend it: the key goes into
|
|
@@ -145,24 +153,18 @@ It only reads: it creates no project and writes no file. Read `status`:
|
|
|
145
153
|
recommendation takes it. Without `question.alternative`, recommend nothing for this line.
|
|
146
154
|
Untracking removes the file for everyone who pulls the next commit, so only an answer to
|
|
147
155
|
this line approves it. A reply that accepts every recommendation never approves the
|
|
148
|
-
untrack. Then offer a new project for this app, or
|
|
156
|
+
untrack. Never suggest a reply that approves it. Then offer a new project for this app, or
|
|
157
|
+
a project the developer already has.
|
|
149
158
|
- `stopped`: the command already filed the stop report. Tell the developer
|
|
150
159
|
`stopReason.detail` in one sentence, then stop onboarding.
|
|
151
160
|
|
|
152
161
|
For an empty target, offer a new project named after the target directory, or a project the
|
|
153
162
|
developer already has.
|
|
154
163
|
|
|
155
|
-
**Line 6: where the model key lives.** For a new agent, ask this line beside the provider
|
|
156
|
-
line. Ask where the developer keeps the key for that provider: the file that holds it, or
|
|
157
|
-
that they will add it later. With no file named, record that they will add it later. Never
|
|
158
|
-
ask for the key itself. A path the developer names is
|
|
159
|
-
theirs to give, including one outside the project. For an empty target, a new key file
|
|
160
|
-
goes outside the target directory: `init` refuses a target that holds a `.env` file.
|
|
161
|
-
|
|
162
164
|
Before you end your turn to wait for the developer, report the pause:
|
|
163
165
|
|
|
164
166
|
```text
|
|
165
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
167
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard checkpoint --phase awaiting-developer
|
|
166
168
|
```
|
|
167
169
|
|
|
168
170
|
If no line is open, ask nothing and continue.
|
|
@@ -190,12 +192,12 @@ developer three things in one message:
|
|
|
190
192
|
2. That the coding agent's shell reads PATH when it starts, so it cannot see the new
|
|
191
193
|
toolchain until the developer restarts the coding agent.
|
|
192
194
|
3. That the run resumes after the restart with
|
|
193
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
195
|
+
`npx --prefer-offline --yes copilotkit@4.26.0 onboard start --run <onboarding_run_id>`.
|
|
194
196
|
|
|
195
197
|
Before you end your turn to wait for the developer, report the pause:
|
|
196
198
|
|
|
197
199
|
```text
|
|
198
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
200
|
+
npx --prefer-offline --yes copilotkit@4.26.0 onboard checkpoint --phase awaiting-developer
|
|
199
201
|
```
|
|
200
202
|
|
|
201
203
|
Then end your turn and wait for the developer. That restart is a step here, not an error.
|
|
@@ -208,4 +210,4 @@ which is the row's default vendor. An existing agent's vendor: `existing`. Give
|
|
|
208
210
|
every later node and subagent. They answer the framework, provider, and frontend questions
|
|
209
211
|
for the rest of the run. The project and key answers answer those questions too.
|
|
210
212
|
|
|
211
|
-
Then run `npx --prefer-offline --yes copilotkit@4.
|
|
213
|
+
Then run `npx --prefer-offline --yes copilotkit@4.26.0 onboard read credentials/plan`.
|