copilotkit 4.10.0 → 4.11.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 +14 -4
- package/cli-build-info.json +8 -8
- package/index.js +150 -43
- package/onboarding/index.json +26 -1
- package/onboarding/prompts/authenticate/start.md +27 -13
- package/onboarding/prompts/conversion/plan.md +3 -3
- package/onboarding/prompts/credentials/finalize-plan.md +30 -21
- package/onboarding/prompts/credentials/plan.md +20 -20
- package/onboarding/prompts/credentials/settle-credentials.md +9 -9
- package/onboarding/prompts/credentials/write-plan.md +7 -7
- package/onboarding/prompts/fallback/best-effort.md +9 -8
- package/onboarding/prompts/feature/a2ui/implement.md +6 -6
- package/onboarding/prompts/feature/a2ui/proof.md +6 -6
- package/onboarding/prompts/feature/a2ui/start.md +7 -7
- package/onboarding/prompts/feature/channels/implement.md +70 -0
- package/onboarding/prompts/feature/channels/proof.md +60 -0
- package/onboarding/prompts/feature/channels/start.md +90 -0
- package/onboarding/prompts/feature/chat-suggestions/implement.md +6 -6
- package/onboarding/prompts/feature/chat-suggestions/proof.md +6 -6
- package/onboarding/prompts/feature/chat-suggestions/start.md +7 -7
- package/onboarding/prompts/feature/complete.md +1 -1
- package/onboarding/prompts/feature/learning/implement.md +12 -12
- package/onboarding/prompts/feature/learning/proof.md +7 -7
- package/onboarding/prompts/feature/learning/start.md +6 -6
- package/onboarding/prompts/feature/open-generative-ui/implement.md +6 -6
- package/onboarding/prompts/feature/open-generative-ui/proof.md +6 -6
- package/onboarding/prompts/feature/open-generative-ui/start.md +7 -7
- package/onboarding/prompts/feature/realtime-sync/implement.md +7 -7
- package/onboarding/prompts/feature/realtime-sync/proof.md +6 -6
- package/onboarding/prompts/feature/realtime-sync/start.md +6 -6
- package/onboarding/prompts/feature/rich-threads/implement.md +8 -8
- package/onboarding/prompts/feature/rich-threads/proof.md +6 -6
- package/onboarding/prompts/feature/rich-threads/start.md +6 -6
- package/onboarding/prompts/feature/stop.md +12 -6
- package/onboarding/prompts/feature/voice/implement.md +6 -6
- package/onboarding/prompts/feature/voice/proof.md +6 -6
- package/onboarding/prompts/feature/voice/start.md +7 -7
- 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 +2 -2
- 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 +2 -2
- package/onboarding/prompts/framework/ms-agent-harness-dotnet.md +2 -2
- 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 +3 -3
- package/onboarding/prompts/frontend/nextjs.md +3 -3
- package/onboarding/prompts/frontend/plan.md +17 -12
- package/onboarding/prompts/frontend/react-native.md +2 -2
- package/onboarding/prompts/frontend/react-spa.md +2 -2
- package/onboarding/prompts/frontend/vue.md +2 -2
- package/onboarding/prompts/implementation/build-and-validate.md +29 -17
- package/onboarding/prompts/proof/complete.md +22 -14
- package/onboarding/prompts/proof/oss-baseline.md +5 -5
- package/onboarding/prompts/proof/round-trip.md +16 -15
- package/onboarding/prompts/research/gather.md +18 -4
- package/onboarding/prompts/research/route.md +9 -10
- package/onboarding/prompts/starter/clone.md +6 -6
- package/onboarding/prompts/stopped/run-failed.md +3 -3
- package/onboarding/prompts/subagent/create-plan.md +1 -1
- package/onboarding/prompts/subagent/prove-oss-baseline.md +1 -1
- package/onboarding/prompts/subagent/prove-round-trip.md +32 -15
- package/onboarding/prompts/unsupported/no-validated-path.md +4 -4
- package/package.json +1 -1
- package/release/release-tool.js +1 -1
|
@@ -28,7 +28,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
28
28
|
these URLs.
|
|
29
29
|
|
|
30
30
|
If the pages support the selection, run
|
|
31
|
-
`npx --yes copilotkit@4.
|
|
31
|
+
`npx --yes copilotkit@4.11.0 onboard read frontend/plan`.
|
|
32
32
|
|
|
33
33
|
If the documentation does not support the selection, run
|
|
34
|
-
`npx --yes copilotkit@4.
|
|
34
|
+
`npx --yes copilotkit@4.11.0 onboard read unsupported/no-validated-path`.
|
|
@@ -43,7 +43,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
43
43
|
URLs, and the two-step context route.
|
|
44
44
|
|
|
45
45
|
If the pages support the selection, run
|
|
46
|
-
`npx --yes copilotkit@4.
|
|
46
|
+
`npx --yes copilotkit@4.11.0 onboard read frontend/plan`.
|
|
47
47
|
|
|
48
48
|
If the documentation does not support the selection, run
|
|
49
|
-
`npx --yes copilotkit@4.
|
|
49
|
+
`npx --yes copilotkit@4.11.0 onboard read unsupported/no-validated-path`.
|
|
@@ -27,7 +27,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
27
27
|
URLs, and the context documentation gap.
|
|
28
28
|
|
|
29
29
|
If the pages support the selection, run
|
|
30
|
-
`npx --yes copilotkit@4.
|
|
30
|
+
`npx --yes copilotkit@4.11.0 onboard read frontend/plan`.
|
|
31
31
|
|
|
32
32
|
If the documentation does not support the selection, run
|
|
33
|
-
`npx --yes copilotkit@4.
|
|
33
|
+
`npx --yes copilotkit@4.11.0 onboard read unsupported/no-validated-path`.
|
|
@@ -28,7 +28,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
28
28
|
URLs, and the context documentation gap.
|
|
29
29
|
|
|
30
30
|
If the pages support the selection, run
|
|
31
|
-
`npx --yes copilotkit@4.
|
|
31
|
+
`npx --yes copilotkit@4.11.0 onboard read frontend/plan`.
|
|
32
32
|
|
|
33
33
|
If the documentation does not support the selection, run
|
|
34
|
-
`npx --yes copilotkit@4.
|
|
34
|
+
`npx --yes copilotkit@4.11.0 onboard read unsupported/no-validated-path`.
|
|
@@ -5,7 +5,7 @@ Preserve an existing Angular frontend. Use the selected page for a new frontend.
|
|
|
5
5
|
Use the starter shortcut only if all these facts are true: the target directory contains
|
|
6
6
|
no entries, its name is a valid `init` project name, and the selected framework is ADK.
|
|
7
7
|
If all three facts are true, record Angular as the selected frontend. Then run
|
|
8
|
-
`npx --yes copilotkit@4.
|
|
8
|
+
`npx --yes copilotkit@4.11.0 onboard read starter/clone` before you fetch documentation.
|
|
9
9
|
|
|
10
10
|
## Documentation
|
|
11
11
|
|
|
@@ -63,7 +63,7 @@ you create or build an Angular project. If the installed version is lower, selec
|
|
|
63
63
|
supported version first and use it for every later command in this project.
|
|
64
64
|
|
|
65
65
|
If the pages support the selection, record Angular and these URLs. Then run
|
|
66
|
-
`npx --yes copilotkit@4.
|
|
66
|
+
`npx --yes copilotkit@4.11.0 onboard read credentials/finalize-plan`.
|
|
67
67
|
|
|
68
68
|
If the documentation does not support the selection, or the two version lines do not fit
|
|
69
|
-
together, run `npx --yes copilotkit@4.
|
|
69
|
+
together, run `npx --yes copilotkit@4.11.0 onboard read unsupported/no-validated-path`.
|
|
@@ -15,7 +15,7 @@ These TypeScript options have starters: Claude Agent SDK TypeScript, LangGraph T
|
|
|
15
15
|
Mastra, and Strands Agents TypeScript. The .NET option is Microsoft Agent Framework .NET.
|
|
16
16
|
|
|
17
17
|
If all shortcut conditions are true, record Next.js as the selected frontend. Then run
|
|
18
|
-
`npx --yes copilotkit@4.
|
|
18
|
+
`npx --yes copilotkit@4.11.0 onboard read starter/clone` before you fetch documentation.
|
|
19
19
|
|
|
20
20
|
## Documentation
|
|
21
21
|
|
|
@@ -27,7 +27,7 @@ agent as the default agent, which is correct only for a project that has no agen
|
|
|
27
27
|
Do not replace the developer's existing agent with the built-in agent.
|
|
28
28
|
|
|
29
29
|
If the page supports the selection, record Next.js and this URL. Then run
|
|
30
|
-
`npx --yes copilotkit@4.
|
|
30
|
+
`npx --yes copilotkit@4.11.0 onboard read credentials/finalize-plan`.
|
|
31
31
|
|
|
32
32
|
If the documentation does not support the selection, run
|
|
33
|
-
`npx --yes copilotkit@4.
|
|
33
|
+
`npx --yes copilotkit@4.11.0 onboard read unsupported/no-validated-path`.
|
|
@@ -9,26 +9,31 @@ the alternatives short. When the frontend is unknown, use this rule: Ask one fro
|
|
|
9
9
|
question that lists the recommendation and valid choices. Do not ask a yes-or-no question
|
|
10
10
|
first. Do not ask about the model or project in this step.
|
|
11
11
|
|
|
12
|
+
If the developer already named Slack or Microsoft Teams, use that choice.
|
|
13
|
+
If the copied prompt came from a Slack or Teams docs page, use that page as the named frontend.
|
|
14
|
+
|
|
12
15
|
If the project has a frontend, preserve it and use the matching route below. If the project
|
|
13
16
|
needs a frontend, show the valid choices and one recommendation based on repository
|
|
14
17
|
evidence, then ask the developer to choose.
|
|
15
18
|
|
|
16
|
-
The valid choices are React SPA, Next.js, Angular, Vue 3,
|
|
17
|
-
in every starting state. Do not show the internal route.
|
|
19
|
+
The valid choices are React SPA, Next.js, Angular, Vue 3, React Native, Slack, and
|
|
20
|
+
Microsoft Teams. They are valid in every starting state. Do not show the internal route.
|
|
18
21
|
|
|
19
22
|
Recommend the frontend the project already uses. Where there is no existing frontend,
|
|
20
|
-
|
|
21
|
-
CopilotKit runtime lives: Next.js hosts it in a route handler, Angular in its SSR
|
|
22
|
-
server, and Vue 3, React SPA and React Native reach a runtime that runs as its own
|
|
23
|
-
process.
|
|
23
|
+
include Slack and Microsoft Teams in the frontend question. They are chat UIs, not
|
|
24
|
+
CopilotKit web apps. Then recommend the one the developer names, and say what each choice implies for where the CopilotKit runtime lives: Next.js hosts it in a route handler, Angular in its SSR server, and Vue 3, React SPA and React Native reach a runtime that runs as its own process. Slack and Microsoft Teams use a long-running Channel host, not a CopilotKit web app.
|
|
24
25
|
|
|
25
26
|
Use exactly one matching internal route:
|
|
26
27
|
|
|
27
|
-
1. React SPA: `npx --yes copilotkit@4.
|
|
28
|
-
2. Next.js: `npx --yes copilotkit@4.
|
|
29
|
-
3. Angular: `npx --yes copilotkit@4.
|
|
30
|
-
4. Vue 3: `npx --yes copilotkit@4.
|
|
31
|
-
5. React Native: `npx --yes copilotkit@4.
|
|
28
|
+
1. React SPA: `npx --yes copilotkit@4.11.0 onboard read frontend/react-spa`
|
|
29
|
+
2. Next.js: `npx --yes copilotkit@4.11.0 onboard read frontend/nextjs`
|
|
30
|
+
3. Angular: `npx --yes copilotkit@4.11.0 onboard read frontend/angular`
|
|
31
|
+
4. Vue 3: `npx --yes copilotkit@4.11.0 onboard read frontend/vue`
|
|
32
|
+
5. React Native: `npx --yes copilotkit@4.11.0 onboard read frontend/react-native`
|
|
33
|
+
6. Slack or Microsoft Teams: `npx --yes copilotkit@4.11.0 onboard read feature/channels/start`
|
|
34
|
+
|
|
35
|
+
If they chose Slack or Microsoft Teams, tell that node which one they chose so it
|
|
36
|
+
does not ask again.
|
|
32
37
|
|
|
33
38
|
If no listed frontend fits, run
|
|
34
|
-
`npx --yes copilotkit@4.
|
|
39
|
+
`npx --yes copilotkit@4.11.0 onboard read unsupported/no-validated-path`.
|
|
@@ -15,7 +15,7 @@ documents `useRenderTool`, which is React Native's own hook for drawing a tool t
|
|
|
15
15
|
already has. That is a different job and needs a tool in the agent.
|
|
16
16
|
|
|
17
17
|
If the pages support the selection, record React Native and these URLs. Then run
|
|
18
|
-
`npx --yes copilotkit@4.
|
|
18
|
+
`npx --yes copilotkit@4.11.0 onboard read credentials/finalize-plan`.
|
|
19
19
|
|
|
20
20
|
If the documentation does not support the selection, run
|
|
21
|
-
`npx --yes copilotkit@4.
|
|
21
|
+
`npx --yes copilotkit@4.11.0 onboard read unsupported/no-validated-path`.
|
|
@@ -11,7 +11,7 @@ not move the agent into it.
|
|
|
11
11
|
- https://docs.copilotkit.ai/react-spa.md
|
|
12
12
|
|
|
13
13
|
If the page supports the selection, record React SPA and this URL. Then run
|
|
14
|
-
`npx --yes copilotkit@4.
|
|
14
|
+
`npx --yes copilotkit@4.11.0 onboard read credentials/finalize-plan`.
|
|
15
15
|
|
|
16
16
|
If the documentation does not support the selection, run
|
|
17
|
-
`npx --yes copilotkit@4.
|
|
17
|
+
`npx --yes copilotkit@4.11.0 onboard read unsupported/no-validated-path`.
|
|
@@ -16,7 +16,7 @@ page above. Vue has its own `useComponent`, which is not the React package. Take
|
|
|
16
16
|
that reference page rather than from a Vue generative-UI guide, which is not published.
|
|
17
17
|
|
|
18
18
|
If the pages support the selection, record Vue 3 and these URLs. Then run
|
|
19
|
-
`npx --yes copilotkit@4.
|
|
19
|
+
`npx --yes copilotkit@4.11.0 onboard read credentials/finalize-plan`.
|
|
20
20
|
|
|
21
21
|
If the documentation does not support the selection, run
|
|
22
|
-
`npx --yes copilotkit@4.
|
|
22
|
+
`npx --yes copilotkit@4.11.0 onboard read unsupported/no-validated-path`.
|
|
@@ -7,11 +7,12 @@ Do not implement the plan yourself. Use the step order in the approved plan.
|
|
|
7
7
|
One rule below stops onboarding: a Learning Container create that fails for a reason other
|
|
8
8
|
than the container already existing. It ends a run the developer has already approved a
|
|
9
9
|
plan for. Name the exact command, id, and error code that stopped you: a report that names
|
|
10
|
-
only the step cannot be acted on. Send one short report before you stop. Run the friction
|
|
11
|
-
|
|
10
|
+
only the step cannot be acted on. Send one short report before you stop. Run the friction
|
|
11
|
+
command without another developer question. Do not ask the developer about telemetry: the
|
|
12
|
+
command applies the setting they already have.
|
|
12
13
|
|
|
13
14
|
```text
|
|
14
|
-
npx --yes copilotkit@4.
|
|
15
|
+
npx --yes copilotkit@4.11.0 onboard friction --phase stop --category <slug>
|
|
15
16
|
```
|
|
16
17
|
|
|
17
18
|
Write one or two sentences to standard input: the step you stopped at and what stopped it.
|
|
@@ -24,6 +25,17 @@ carries any of those, prints the reason, and exits zero. A refused report is not
|
|
|
24
25
|
step. Send the report, then stop. Reporting is not a route change and does not resume the
|
|
25
26
|
run.
|
|
26
27
|
|
|
28
|
+
## Departing from the approved plan
|
|
29
|
+
|
|
30
|
+
The developer approved a written plan and was told that approval was the last thing this
|
|
31
|
+
run needed from them. A step that cannot be built as written is therefore a change to the
|
|
32
|
+
only thing they agreed to.
|
|
33
|
+
|
|
34
|
+
Where you depart from a path, a version, or a step the plan named, record it: what the
|
|
35
|
+
plan said, what you did instead, and why. Carry that record into the closing summary,
|
|
36
|
+
which has an item for it. Do not stop for a departure that is the right call, and do not
|
|
37
|
+
leave it unrecorded either.
|
|
38
|
+
|
|
27
39
|
## Authorization requested by the plan
|
|
28
40
|
|
|
29
41
|
Approving the plan is the developer agreeing to every path it listed under
|
|
@@ -31,7 +43,7 @@ Approving the plan is the developer agreeing to every path it listed under
|
|
|
31
43
|
app directory:
|
|
32
44
|
|
|
33
45
|
```text
|
|
34
|
-
npx --yes copilotkit@4.
|
|
46
|
+
npx --yes copilotkit@4.11.0 onboard protect --authorize --path <path> --reason "<the plan's sentence>"
|
|
35
47
|
```
|
|
36
48
|
|
|
37
49
|
Consent has to be on the record before the file moves, so a call made after the change is
|
|
@@ -43,7 +55,7 @@ No implementation step has run yet, so the change is theirs rather than this run
|
|
|
43
55
|
consent over it by adding one flag:
|
|
44
56
|
|
|
45
57
|
```text
|
|
46
|
-
npx --yes copilotkit@4.
|
|
58
|
+
npx --yes copilotkit@4.11.0 onboard protect --authorize --path <path> --reason "<the plan's sentence>" --with-prior-change
|
|
47
59
|
```
|
|
48
60
|
|
|
49
61
|
The flag records their change as drift beside the consent, so the closing report names both
|
|
@@ -62,7 +74,7 @@ rather than this section.
|
|
|
62
74
|
Run the audit from the target app directory:
|
|
63
75
|
|
|
64
76
|
```text
|
|
65
|
-
npx --yes copilotkit@4.
|
|
77
|
+
npx --yes copilotkit@4.11.0 onboard audit
|
|
66
78
|
```
|
|
67
79
|
|
|
68
80
|
It compares every protected path with the digest the CLI captured for it. Its result starts
|
|
@@ -97,14 +109,14 @@ A path that no Files changed section names changed outside the run, and it is th
|
|
|
97
109
|
developer's own file. Accept it by name:
|
|
98
110
|
|
|
99
111
|
```text
|
|
100
|
-
npx --yes copilotkit@4.
|
|
112
|
+
npx --yes copilotkit@4.11.0 onboard protect --accept-external --path <path>
|
|
101
113
|
```
|
|
102
114
|
|
|
103
115
|
A changed env file is its own case. This run asked the developer to place a credential
|
|
104
116
|
there, so it takes the credential route rather than this one:
|
|
105
117
|
|
|
106
118
|
```text
|
|
107
|
-
npx --yes copilotkit@4.
|
|
119
|
+
npx --yes copilotkit@4.11.0 onboard protect --accept-credential --path <path>
|
|
108
120
|
```
|
|
109
121
|
|
|
110
122
|
That route proves no recorded credential was lost, instead of taking the run's word that it
|
|
@@ -123,7 +135,7 @@ neither does a one-line fix. Never repair, reset, or revert it. Ask the develope
|
|
|
123
135
|
the change, and record the answer they give:
|
|
124
136
|
|
|
125
137
|
```text
|
|
126
|
-
npx --yes copilotkit@4.
|
|
138
|
+
npx --yes copilotkit@4.11.0 onboard protect --authorize --unplanned --path <path> --reason "<what the developer said>"
|
|
127
139
|
```
|
|
128
140
|
|
|
129
141
|
Use it only for an answer a developer actually gave. It records the consent as taken
|
|
@@ -144,7 +156,7 @@ create it now, from the target app directory. The developer approved the id befo
|
|
|
144
156
|
made, so this is the first point at which it can be created:
|
|
145
157
|
|
|
146
158
|
```text
|
|
147
|
-
npx --yes copilotkit@4.
|
|
159
|
+
npx --yes copilotkit@4.11.0 learning containers create --id <id> --name <name> --json
|
|
148
160
|
```
|
|
149
161
|
|
|
150
162
|
Pass the id the plan names. Take the name from the selected project's own display name, so
|
|
@@ -160,7 +172,7 @@ hold.
|
|
|
160
172
|
Then report that the container is settled, before any edit:
|
|
161
173
|
|
|
162
174
|
```text
|
|
163
|
-
npx --yes copilotkit@4.
|
|
175
|
+
npx --yes copilotkit@4.11.0 onboard checkpoint --phase container-settled
|
|
164
176
|
```
|
|
165
177
|
|
|
166
178
|
Where the plan names a container the platform already held, report the same checkpoint and
|
|
@@ -169,11 +181,11 @@ create nothing. Where the plan names no container, skip this section.
|
|
|
169
181
|
Report the plan this run is about to implement:
|
|
170
182
|
|
|
171
183
|
```text
|
|
172
|
-
npx --yes copilotkit@4.
|
|
184
|
+
npx --yes copilotkit@4.11.0 onboard checkpoint --phase plan-written
|
|
173
185
|
```
|
|
174
186
|
|
|
175
187
|
Spawn one implementation subagent. Tell it to run
|
|
176
|
-
`npx --yes copilotkit@4.
|
|
188
|
+
`npx --yes copilotkit@4.11.0 onboard read subagent/implement-and-validate` first and follow
|
|
177
189
|
the prompt it returns. If that read fails because the subagent cannot use the shell, stop that
|
|
178
190
|
subagent. Run the same command yourself, then spawn a fresh subagent with the returned prompt
|
|
179
191
|
and the same handoff. Give it the plan, selected framework, frontend, model, exact target app
|
|
@@ -193,11 +205,11 @@ returned. Continue to proof only when that audit passes.
|
|
|
193
205
|
After the selected implementation path passes, report it:
|
|
194
206
|
|
|
195
207
|
```text
|
|
196
|
-
npx --yes copilotkit@4.
|
|
208
|
+
npx --yes copilotkit@4.11.0 onboard checkpoint --phase build-validated
|
|
197
209
|
```
|
|
198
210
|
|
|
199
211
|
Then run
|
|
200
|
-
`npx --yes copilotkit@4.
|
|
212
|
+
`npx --yes copilotkit@4.11.0 onboard read proof/round-trip`.
|
|
201
213
|
|
|
202
214
|
## Repair rules
|
|
203
215
|
|
|
@@ -219,9 +231,9 @@ the same command still fails after three repair attempts, or a result starts wit
|
|
|
219
231
|
`Status: blocked`. A defect in a package this run installed is not a stack CopilotKit does
|
|
220
232
|
not serve, a command this run cannot get to pass is not one either, and a blocked audit
|
|
221
233
|
proved nothing about the stack. In those cases run
|
|
222
|
-
`npx --yes copilotkit@4.
|
|
234
|
+
`npx --yes copilotkit@4.11.0 onboard read stopped/run-failed`.
|
|
223
235
|
|
|
224
236
|
A plan with no path to follow takes the unsupported ending: the fix requires changing the
|
|
225
237
|
developer's existing agent or frontend, or the documentation does not support the plan. In
|
|
226
238
|
those cases run
|
|
227
|
-
`npx --yes copilotkit@4.
|
|
239
|
+
`npx --yes copilotkit@4.11.0 onboard read unsupported/no-validated-path`.
|
|
@@ -37,11 +37,15 @@ The handoff must include:
|
|
|
37
37
|
- The URL of the running app.
|
|
38
38
|
- The command that starts the app in the future.
|
|
39
39
|
- The debugging surface this journey's frontend can reach, named below.
|
|
40
|
-
- How to use https://intelligence.copilotkit.ai to manage the Intelligence
|
|
40
|
+
- How to use https://intelligence.copilotkit.ai to manage the CopilotKit Intelligence
|
|
41
41
|
installation. Do not open it. This item makes the developer aware the dashboard is
|
|
42
42
|
there, and it is a sentence to write rather than a check to perform. Nothing in this
|
|
43
43
|
graph gates on the dashboard, so a dashboard this run never opened is not a finding,
|
|
44
44
|
not a caveat, and not a blocker.
|
|
45
|
+
- What changed since the developer approved the plan. Name every path, version, or step
|
|
46
|
+
the run departed from, and why. A deviation can be the right call and still has to
|
|
47
|
+
reach the person who approved the thing it departed from. Where nothing departed, say
|
|
48
|
+
that in one line rather than leaving the item out.
|
|
45
49
|
- The process IDs and stop commands for the running agent and frontend.
|
|
46
50
|
- The `@copilotkit/*` versions this conversion changed, and what they were before.
|
|
47
51
|
- On a conversion, the criterion this run was judged against, in the words the run was
|
|
@@ -66,8 +70,9 @@ Name the debugging surface this journey's frontend can reach, rather than the on
|
|
|
66
70
|
of the documentation leads with. For a web frontend it is the CopilotKit Inspector. For
|
|
67
71
|
React Native there is no Inspector: it is a browser overlay built on a DOM custom element,
|
|
68
72
|
and `@copilotkit/react-native` does not ship it. Give a mobile developer
|
|
69
|
-
`npx --yes copilotkit@4.
|
|
70
|
-
Event Inspector in the CopilotKit VS Code extension, and the Intelligence
|
|
73
|
+
`npx --yes copilotkit@4.11.0 verify --round-trip`, the runtime's own log, the AG-UI
|
|
74
|
+
Event Inspector in the CopilotKit VS Code extension, and the CopilotKit Intelligence
|
|
75
|
+
thread view
|
|
71
76
|
instead. Naming the Inspector to a developer who cannot open it costs them the time it
|
|
72
77
|
takes to conclude their own wiring is broken.
|
|
73
78
|
|
|
@@ -85,11 +90,11 @@ exists, and the developer then waits for insights from a container this run neve
|
|
|
85
90
|
State that the servers remain running after proof.
|
|
86
91
|
|
|
87
92
|
Report each thing that slowed this run down. Send at most four reports, worst first. Run
|
|
88
|
-
the friction commands without another developer question.
|
|
89
|
-
|
|
93
|
+
the friction commands without another developer question. Do not ask the developer about
|
|
94
|
+
telemetry: the command applies the setting they already have.
|
|
90
95
|
|
|
91
96
|
```text
|
|
92
|
-
npx --yes copilotkit@4.
|
|
97
|
+
npx --yes copilotkit@4.11.0 onboard friction --category <slug> --cost-seconds <seconds>
|
|
93
98
|
```
|
|
94
99
|
|
|
95
100
|
Write one or two sentences on the command's standard input. Pick one category from
|
|
@@ -101,7 +106,7 @@ Pass --docs-path only for a docs-missing or docs-wrong report, naming the page t
|
|
|
101
106
|
is about:
|
|
102
107
|
|
|
103
108
|
```text
|
|
104
|
-
npx --yes copilotkit@4.
|
|
109
|
+
npx --yes copilotkit@4.11.0 onboard friction --category docs-wrong --cost-seconds 300 --docs-path /docs/threads/drawer
|
|
105
110
|
```
|
|
106
111
|
|
|
107
112
|
Give the page's site-relative path or its full URL, with no spaces, query string, or
|
|
@@ -118,25 +123,28 @@ Tell the developer when you send a friction report. Do not quote or summarize th
|
|
|
118
123
|
unless the developer asks. If the CLI says the report was not sent,
|
|
119
124
|
state what it said and continue without another question.
|
|
120
125
|
|
|
121
|
-
When the evidence is gathered, run `npx --yes copilotkit@4.
|
|
126
|
+
When the evidence is gathered, run `npx --yes copilotkit@4.11.0 onboard complete`, carrying
|
|
122
127
|
the surface-check outcome the proof subagent returned. Pass exactly one flag, and pass the
|
|
123
128
|
one that matches this journey's surface.
|
|
124
129
|
|
|
125
130
|
For a web frontend -- React SPA, Next.js, Angular, Vue:
|
|
126
131
|
|
|
127
132
|
```text
|
|
128
|
-
npx --yes copilotkit@4.
|
|
133
|
+
npx --yes copilotkit@4.11.0 onboard complete --visual-check <outcome>
|
|
129
134
|
```
|
|
130
135
|
|
|
131
|
-
The outcome is one of `performed`, `skipped-no-browser-tool`, or
|
|
136
|
+
The outcome is one of `performed`, `skipped-no-browser-tool`, `skipped-cloned-starter`, or
|
|
137
|
+
`failed`. Use `skipped-cloned-starter` only for a run that cloned a starter and was told to
|
|
138
|
+
open no browser. It is the one skip that does not block.
|
|
132
139
|
|
|
133
140
|
For React Native:
|
|
134
141
|
|
|
135
142
|
```text
|
|
136
|
-
npx --yes copilotkit@4.
|
|
143
|
+
npx --yes copilotkit@4.11.0 onboard complete --device-check <outcome>
|
|
137
144
|
```
|
|
138
145
|
|
|
139
|
-
The outcome is one of `performed`, `skipped-no-device`, or
|
|
146
|
+
The outcome is one of `performed`, `skipped-no-device`, `skipped-cloned-starter`, or
|
|
147
|
+
`failed`.
|
|
140
148
|
|
|
141
149
|
The two flags are not interchangeable and neither takes the other's outcomes. A browser
|
|
142
150
|
proves nothing about a React Native view tree, and a device capture proves nothing about
|
|
@@ -145,7 +153,7 @@ browser-origin CORS, so the flag you pass is how this run states which surface i
|
|
|
145
153
|
For a web frontend, also pass the URL the browser opened:
|
|
146
154
|
|
|
147
155
|
```text
|
|
148
|
-
npx --yes copilotkit@4.
|
|
156
|
+
npx --yes copilotkit@4.11.0 onboard complete --visual-check <outcome> \
|
|
149
157
|
--frontend-url <the url you opened>
|
|
150
158
|
```
|
|
151
159
|
|
|
@@ -164,7 +172,7 @@ If the round trip proved and something after it still blocked this run, add `--b
|
|
|
164
172
|
to the same command:
|
|
165
173
|
|
|
166
174
|
```text
|
|
167
|
-
npx --yes copilotkit@4.
|
|
175
|
+
npx --yes copilotkit@4.11.0 onboard complete --visual-check performed --blocked-by <cause>
|
|
168
176
|
```
|
|
169
177
|
|
|
170
178
|
The cause is one of `inspector` for a debugging surface that did not open,
|
|
@@ -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 --yes copilotkit@4.
|
|
4
|
+
`npx --yes copilotkit@4.11.0 onboard read subagent/prove-oss-baseline` first and follow the
|
|
5
5
|
prompt it returns. If that read fails because the subagent cannot use the shell, stop that
|
|
6
6
|
subagent. Run the same command yourself, then spawn a fresh subagent with the returned prompt
|
|
7
7
|
and the same handoff. Give it the repository findings and exact CLI package spec.
|
|
@@ -17,7 +17,7 @@ Wait for the subagent to finish.
|
|
|
17
17
|
Record what that proof returned before you route on it:
|
|
18
18
|
|
|
19
19
|
```text
|
|
20
|
-
npx --yes copilotkit@4.
|
|
20
|
+
npx --yes copilotkit@4.11.0 onboard proof --step oss-baseline --outcome <passed|failed|skipped> [--predicate <1-6>]
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
Report the gate whatever it returned. Pass `passed` when the subagent proved a predicate,
|
|
@@ -35,12 +35,12 @@ Do not change project files before this proof ends. Starting existing developmen
|
|
|
35
35
|
processes and their ignored runtime files is allowed.
|
|
36
36
|
|
|
37
37
|
If the subagent proves the `both-oss` predicate, keep its evidence with the plan and run
|
|
38
|
-
`npx --yes copilotkit@4.
|
|
38
|
+
`npx --yes copilotkit@4.11.0 onboard read conversion/plan`. That project already works.
|
|
39
39
|
What it needs is the conversion, not a build.
|
|
40
40
|
|
|
41
41
|
If the proof does not establish the baseline, record the starting state
|
|
42
42
|
`both-copilotkit-unproved` and run
|
|
43
|
-
`npx --yes copilotkit@4.
|
|
43
|
+
`npx --yes copilotkit@4.11.0 onboard read credentials/plan`. This prompt is served
|
|
44
44
|
whenever a project looks like an OSS integration, so a baseline that did not prove is an
|
|
45
45
|
ordinary starting state rather than a failure. Keep the failing predicate with the plan.
|
|
46
46
|
|
|
@@ -54,5 +54,5 @@ and the plan preserves it rather than repeating it.
|
|
|
54
54
|
|
|
55
55
|
If it cannot identify the running process safely, exposes a secret, or finds a baseline
|
|
56
56
|
failure that cannot be classified, run
|
|
57
|
-
`npx --yes copilotkit@4.
|
|
57
|
+
`npx --yes copilotkit@4.11.0 onboard read stopped/run-failed`. None of those mean the
|
|
58
58
|
project is unsupported: they mean 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 --yes copilotkit@4.
|
|
4
|
+
`npx --yes copilotkit@4.11.0 onboard read subagent/prove-round-trip` first and follow the
|
|
5
5
|
prompt it returns. If that read fails because the subagent cannot use the shell, stop that
|
|
6
6
|
subagent. Run the same command yourself, then spawn a fresh subagent with the returned prompt
|
|
7
7
|
and the same handoff. Give it the selected framework, frontend, model, approved plan, selected
|
|
@@ -20,8 +20,9 @@ starter smoke jobs already drive on every change, so opening a browser re-proves
|
|
|
20
20
|
developer's run what those jobs prove before the starter ships, and it is the most
|
|
21
21
|
expensive step in this setup. `verify --round-trip` reads the answer back off the thread,
|
|
22
22
|
so it holds for every runtime mount and needs no browser. Give that subagent no browser or
|
|
23
|
-
device control, and
|
|
24
|
-
|
|
23
|
+
device control, and have it report `skipped-cloned-starter` rather than a missing
|
|
24
|
+
capability: nothing was unavailable, the run declined to spend it. That outcome completes
|
|
25
|
+
the run. Every other skip says nothing drove the surface, and blocks it.
|
|
25
26
|
|
|
26
27
|
Give the subagent this guide for continued-development tools:
|
|
27
28
|
https://docs.copilotkit.ai/build-with-agents.md
|
|
@@ -32,13 +33,13 @@ pass the time.
|
|
|
32
33
|
Report each attempt at the journey as it ends, counting from one:
|
|
33
34
|
|
|
34
35
|
```text
|
|
35
|
-
npx --yes copilotkit@4.
|
|
36
|
+
npx --yes copilotkit@4.11.0 onboard checkpoint --phase journey-attempted --attempt 1
|
|
36
37
|
```
|
|
37
38
|
|
|
38
39
|
Record what that proof returned before you route on it:
|
|
39
40
|
|
|
40
41
|
```text
|
|
41
|
-
npx --yes copilotkit@4.
|
|
42
|
+
npx --yes copilotkit@4.11.0 onboard proof --step round-trip --outcome <passed|failed|skipped>
|
|
42
43
|
```
|
|
43
44
|
|
|
44
45
|
Report the gate whatever it returned. A proof that never ran is `skipped`, not failed. The
|
|
@@ -46,7 +47,7 @@ command prints one line and sends nothing else. Where a repair cycle runs the pr
|
|
|
46
47
|
record each attempt as it ends.
|
|
47
48
|
|
|
48
49
|
For every protected-path audit in this prompt, run
|
|
49
|
-
`npx --yes copilotkit@4.
|
|
50
|
+
`npx --yes copilotkit@4.11.0 onboard audit` from the target app directory. If its result
|
|
50
51
|
starts with `Status: blocked`, report the printed reason and use the route-out rules below.
|
|
51
52
|
A blocked audit proved nothing changed and is not a preservation failure. If a
|
|
52
53
|
protected-path audit reports a changed path, decide it the way the implementation prompt
|
|
@@ -55,7 +56,7 @@ returns none, so a finding with no Files changed section to test against routes
|
|
|
55
56
|
path one of those sections names is this run's own change and routes out too. Accept a
|
|
56
57
|
path only when a section this run collected covers the step that wrote it and does not
|
|
57
58
|
name it:
|
|
58
|
-
`npx --yes copilotkit@4.
|
|
59
|
+
`npx --yes copilotkit@4.11.0 onboard protect --accept-external --path <path>`. Then run
|
|
59
60
|
the audit again and name the path in the closing summary. Never repair, reset, or revert a
|
|
60
61
|
protected path.
|
|
61
62
|
|
|
@@ -63,12 +64,12 @@ That holds for a repair cycle too. When the fix for a failing check lands on a p
|
|
|
63
64
|
path, the path is still the developer's, however right the diagnosis is and however small
|
|
64
65
|
the fix. Reading the file never settles who wrote it. Ask the developer to allow the
|
|
65
66
|
change, and record their answer with
|
|
66
|
-
`npx --yes copilotkit@4.
|
|
67
|
+
`npx --yes copilotkit@4.11.0 onboard protect --authorize --unplanned --path <path> --reason "<what the developer said>"`,
|
|
67
68
|
or route out. Never repair it, and never send it to a repair worker.
|
|
68
69
|
|
|
69
70
|
If the proof result starts with `Status: passed`, run the protected-path audit. Continue to
|
|
70
71
|
`proof/complete` only if that audit passes. After the audit passes, run
|
|
71
|
-
`npx --yes copilotkit@4.
|
|
72
|
+
`npx --yes copilotkit@4.11.0 onboard read proof/complete`. A performed surface outcome with
|
|
72
73
|
the full round trip is core success even if a continued-development tool fails. A skipped
|
|
73
74
|
surface outcome still enters `proof/complete` so the CLI records the blocked result. Do not
|
|
74
75
|
describe a skipped surface as proved. Keep the Skills and MCP results separate from the proof
|
|
@@ -124,7 +125,7 @@ Restart each project-owned process changed by the repair. Report the cycle, coun
|
|
|
124
125
|
one:
|
|
125
126
|
|
|
126
127
|
```text
|
|
127
|
-
npx --yes copilotkit@4.
|
|
128
|
+
npx --yes copilotkit@4.11.0 onboard checkpoint --phase repair-attempted --attempt 1
|
|
128
129
|
```
|
|
129
130
|
|
|
130
131
|
Then spawn a fresh proof subagent
|
|
@@ -142,18 +143,18 @@ and proof cycles.
|
|
|
142
143
|
|
|
143
144
|
Route out only when the failure is not yours to fix, when the same proof still fails after
|
|
144
145
|
three attempts, or when no evidence of the round trip can be produced. In those cases run
|
|
145
|
-
`npx --yes copilotkit@4.
|
|
146
|
+
`npx --yes copilotkit@4.11.0 onboard read stopped/run-failed`. The stack is supported:
|
|
146
147
|
this run did not finish, which is a different ending and a different report. All three are
|
|
147
148
|
about the round trip itself. A round trip that proved is not one of them, whatever failed
|
|
148
149
|
after it.
|
|
149
150
|
|
|
150
151
|
If you stop here without taking that route -- a repair cycle you cannot finish, a limit in
|
|
151
|
-
your own harness, a run that has run out -- send one short report before you stop.
|
|
152
|
-
|
|
153
|
-
|
|
152
|
+
your own harness, a run that has run out -- send one short report before you stop. Run the
|
|
153
|
+
friction command without another developer question. Do not ask the developer about
|
|
154
|
+
telemetry: the command applies the setting they already have.
|
|
154
155
|
|
|
155
156
|
```text
|
|
156
|
-
npx --yes copilotkit@4.
|
|
157
|
+
npx --yes copilotkit@4.11.0 onboard friction --phase stop --category <slug>
|
|
157
158
|
```
|
|
158
159
|
|
|
159
160
|
Write one or two sentences to standard input: the step you stopped at and what stopped it.
|
|
@@ -27,7 +27,7 @@ Before you ask the developer any setup question, finish every read-only investig
|
|
|
27
27
|
preflight check in this section.
|
|
28
28
|
|
|
29
29
|
Prepare two research assignments. Give each research subagent one assignment. Tell it to run
|
|
30
|
-
`npx --yes copilotkit@4.
|
|
30
|
+
`npx --yes copilotkit@4.11.0 onboard read subagent/inspect-repository` first and follow the
|
|
31
31
|
prompt it returns. If that read fails because the subagent cannot use the shell, stop that
|
|
32
32
|
subagent. Run the same command yourself, then spawn a fresh subagent with the returned prompt
|
|
33
33
|
and the same handoff. Require only its assigned packet.
|
|
@@ -89,10 +89,24 @@ whole finding, and a browser is not a substitute for a device.
|
|
|
89
89
|
|
|
90
90
|
Wait for both research subagents to finish.
|
|
91
91
|
|
|
92
|
+
## Settle the port
|
|
93
|
+
|
|
94
|
+
The findings name the ports this project declares and the ports already held on this
|
|
95
|
+
machine. Pick one free port for the frontend now, and use that number for the rest of the
|
|
96
|
+
run: in the plan, in the implementation, and in the proof. Record it with the findings you
|
|
97
|
+
hand to every later subagent.
|
|
98
|
+
|
|
99
|
+
Do not let a later step pick again. A run that decides the port three times produces three
|
|
100
|
+
numbers, and `verify` reads none of them: with no recorded URL it assumes port 3000, and
|
|
101
|
+
whatever holds that port answers. An unrelated checkout on this machine then reports as
|
|
102
|
+
this project's proven wiring.
|
|
103
|
+
|
|
104
|
+
Project selection is where the settled port is written down, through `--runtime-url`.
|
|
105
|
+
|
|
92
106
|
Then report that the research came back:
|
|
93
107
|
|
|
94
108
|
```text
|
|
95
|
-
npx --yes copilotkit@4.
|
|
109
|
+
npx --yes copilotkit@4.11.0 onboard checkpoint --phase research-returned
|
|
96
110
|
```
|
|
97
111
|
|
|
98
112
|
A refused checkpoint prints its reason and leaves onboarding unaffected. It is not a
|
|
@@ -115,7 +129,7 @@ both workers return the same one target app directory. Both results must start w
|
|
|
115
129
|
`Status: passed`. Otherwise, use the stop route.
|
|
116
130
|
|
|
117
131
|
When both research results are merged, run
|
|
118
|
-
`npx --yes copilotkit@4.
|
|
132
|
+
`npx --yes copilotkit@4.11.0 onboard read research/route`.
|
|
119
133
|
|
|
120
134
|
If inspection stops onboarding, run
|
|
121
|
-
`npx --yes copilotkit@4.
|
|
135
|
+
`npx --yes copilotkit@4.11.0 onboard read stopped/run-failed`.
|
|
@@ -9,7 +9,7 @@ sends the run down one path.
|
|
|
9
9
|
Before you route on, run this from the target app directory:
|
|
10
10
|
|
|
11
11
|
```text
|
|
12
|
-
npx --yes copilotkit@4.
|
|
12
|
+
npx --yes copilotkit@4.11.0 onboard protect
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
It reads the working tree itself, records every changed or untracked path with a digest,
|
|
@@ -51,7 +51,7 @@ settle these three from your own reading of the project. Each one comes from the
|
|
|
51
51
|
packets or it is not proved.
|
|
52
52
|
|
|
53
53
|
If all three are proved, prove the live starting state before any project file changes. Run
|
|
54
|
-
`npx --yes copilotkit@4.
|
|
54
|
+
`npx --yes copilotkit@4.11.0 onboard read proof/oss-baseline`.
|
|
55
55
|
|
|
56
56
|
Route there before you ask the developer anything else. The questions after this prompt
|
|
57
57
|
select a framework and a frontend that the findings already name, so a developer who
|
|
@@ -64,18 +64,17 @@ developer nor the repository findings prove what the project is for, ask one gui
|
|
|
64
64
|
question about the user outcome. This asks what the developer wants to build before you
|
|
65
65
|
select a framework. Give two or three short examples and offer a minimal starter. Record
|
|
66
66
|
the answer and give it to each later subagent. Then run
|
|
67
|
-
`npx --yes copilotkit@4.
|
|
67
|
+
`npx --yes copilotkit@4.11.0 onboard read credentials/plan`.
|
|
68
68
|
|
|
69
69
|
Do not ask that question on the route above. A project carrying all three states its
|
|
70
70
|
purpose in the application it already serves.
|
|
71
71
|
|
|
72
|
-
Do not ask it when the target directory holds no project either.
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
named above without asking, and let the starter state the domain.
|
|
72
|
+
Do not ask it when the target directory holds no project either.
|
|
73
|
+
The frontend they pick next decides the starter.
|
|
74
|
+
Slack and Microsoft Teams are choices at that step.
|
|
75
|
+
A purpose question here names a domain before that choice.
|
|
76
|
+
Take the same read named above without asking.
|
|
78
77
|
|
|
79
78
|
If authentication or inspection stops onboarding, run
|
|
80
|
-
`npx --yes copilotkit@4.
|
|
79
|
+
`npx --yes copilotkit@4.11.0 onboard read stopped/run-failed`. Neither says anything
|
|
81
80
|
about whether this project's stack is supported, which is not yet known at this point.
|