copilotkit 4.13.0 → 4.14.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 +109 -6
- package/cli-build-info.json +8 -8
- package/index.js +43866 -40955
- package/onboarding/index.json +1 -1
- package/onboarding/prompts/authenticate/start.md +38 -27
- package/onboarding/prompts/conversion/plan.md +3 -3
- package/onboarding/prompts/credentials/finalize-plan.md +14 -12
- package/onboarding/prompts/credentials/plan.md +21 -21
- package/onboarding/prompts/credentials/settle-credentials.md +18 -11
- package/onboarding/prompts/credentials/write-plan.md +19 -12
- package/onboarding/prompts/fallback/best-effort.md +9 -9
- 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 +41 -15
- package/onboarding/prompts/feature/channels/proof.md +12 -10
- package/onboarding/prompts/feature/channels/start.md +13 -12
- 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 +19 -1
- package/onboarding/prompts/feature/learning/implement.md +16 -16
- package/onboarding/prompts/feature/learning/proof.md +7 -7
- package/onboarding/prompts/feature/learning/start.md +8 -8
- 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 +10 -10
- 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 +36 -2
- package/onboarding/prompts/feature/voice/implement.md +7 -7
- package/onboarding/prompts/feature/voice/proof.md +6 -6
- 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 +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 +7 -7
- package/onboarding/prompts/frontend/react-native.md +5 -2
- package/onboarding/prompts/frontend/react-spa.md +5 -2
- package/onboarding/prompts/frontend/vue.md +5 -2
- package/onboarding/prompts/implementation/build-and-validate.md +24 -23
- package/onboarding/prompts/proof/complete.md +8 -8
- package/onboarding/prompts/proof/oss-baseline.md +5 -5
- package/onboarding/prompts/proof/round-trip.md +11 -11
- package/onboarding/prompts/research/gather.md +36 -7
- package/onboarding/prompts/research/merge.md +3 -3
- package/onboarding/prompts/research/preflight.md +4 -4
- package/onboarding/prompts/research/route.md +10 -8
- package/onboarding/prompts/starter/clone.md +97 -26
- package/onboarding/prompts/stopped/run-failed.md +2 -2
- package/onboarding/prompts/subagent/create-plan.md +4 -4
- package/onboarding/prompts/subagent/implement-and-validate.md +26 -6
- package/onboarding/prompts/subagent/inspect-repository.md +2 -2
- package/onboarding/prompts/subagent/prove-oss-baseline.md +2 -2
- package/onboarding/prompts/subagent/prove-round-trip.md +10 -10
- package/onboarding/prompts/unsupported/no-validated-path.md +2 -2
- package/package.json +5 -1
- package/release/release-tool.js +330 -72
|
@@ -6,7 +6,7 @@ read-only, implementation, and proof subagents, each restricted to the target pr
|
|
|
6
6
|
Before any subagent or project process runs, capture the developer's existing work:
|
|
7
7
|
|
|
8
8
|
```text
|
|
9
|
-
npx --yes copilotkit@4.
|
|
9
|
+
npx --yes copilotkit@4.14.0 onboard protect
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
Keep the exact protected path list it prints and give that list to every subagent. No
|
|
@@ -16,14 +16,14 @@ approved authorization before implementation.
|
|
|
16
16
|
Before edits, inspect the runtime route, CopilotKit provider/chat composer, current agent,
|
|
17
17
|
existing provider credential variable names (presence only), package versions, browser
|
|
18
18
|
permissions approach, and test/dev commands. Prove the existing OSS baseline with `/info`,
|
|
19
|
-
`npx --yes copilotkit@4.
|
|
19
|
+
`npx --yes copilotkit@4.14.0 verify --expect-runtime oss --round-trip --agent <agent-id> --json`,
|
|
20
20
|
and a real UI request when a browser is available. If that baseline is absent, change nothing
|
|
21
21
|
and direct the developer to generic onboarding first.
|
|
22
22
|
|
|
23
23
|
Wait for the inspection subagent to finish. Then report that the inspection came back:
|
|
24
24
|
|
|
25
25
|
```text
|
|
26
|
-
npx --yes copilotkit@4.
|
|
26
|
+
npx --yes copilotkit@4.14.0 onboard checkpoint --phase research-returned
|
|
27
27
|
```
|
|
28
28
|
|
|
29
29
|
A refused checkpoint prints its reason and leaves onboarding unaffected. It is not a
|
|
@@ -33,7 +33,7 @@ If the inspection did not prove the baseline this intent extends, stop here with
|
|
|
33
33
|
changing files:
|
|
34
34
|
|
|
35
35
|
```text
|
|
36
|
-
npx --yes copilotkit@4.
|
|
36
|
+
npx --yes copilotkit@4.14.0 onboard read feature/stop
|
|
37
37
|
```
|
|
38
38
|
|
|
39
39
|
Do not run login, select Intelligence, create a credential, read a credential value, or
|
|
@@ -41,7 +41,7 @@ replace the existing chat/runtime. Fetch the official voice guide before plannin
|
|
|
41
41
|
https://docs.copilotkit.ai/voice.md
|
|
42
42
|
Retry it a second way if needed. Use an existing user-owned provider credential only when
|
|
43
43
|
the repository proves its variable name is configured; otherwise explain the setup gate and
|
|
44
|
-
stop rather than writing a placeholder.
|
|
44
|
+
take the feature stop route above rather than writing a placeholder.
|
|
45
45
|
|
|
46
46
|
Show a small plan for the documented transcription service, the existing composer, focused
|
|
47
47
|
tests, and a microphone/canned-transcript proof. Ask for approval separately.
|
|
@@ -54,7 +54,7 @@ one.
|
|
|
54
54
|
After approval, record each approved path before implementation:
|
|
55
55
|
|
|
56
56
|
```text
|
|
57
|
-
npx --yes copilotkit@4.
|
|
57
|
+
npx --yes copilotkit@4.14.0 onboard protect --authorize --path <path> --reason "<the plan's sentence>"
|
|
58
58
|
```
|
|
59
59
|
|
|
60
60
|
If an approved path changed after capture and no implementation step has run, add
|
|
@@ -64,7 +64,7 @@ authorize a path the approved plan did not list.
|
|
|
64
64
|
Then report the plan this run is about to implement:
|
|
65
65
|
|
|
66
66
|
```text
|
|
67
|
-
npx --yes copilotkit@4.
|
|
67
|
+
npx --yes copilotkit@4.14.0 onboard checkpoint --phase plan-written
|
|
68
68
|
```
|
|
69
69
|
|
|
70
|
-
Then run `npx --yes copilotkit@4.
|
|
70
|
+
Then run `npx --yes copilotkit@4.14.0 onboard read feature/voice/implement`.
|
|
@@ -31,7 +31,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
31
31
|
URLs, and the A2UI documentation gap.
|
|
32
32
|
|
|
33
33
|
If the pages support the selection, run
|
|
34
|
-
`npx --yes copilotkit@4.
|
|
34
|
+
`npx --yes copilotkit@4.14.0 onboard read frontend/plan`.
|
|
35
35
|
|
|
36
36
|
If the documentation does not support the selection, run
|
|
37
|
-
`npx --yes copilotkit@4.
|
|
37
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -34,7 +34,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
34
34
|
URLs, the documented dependencies and adapter, and the context documentation gap.
|
|
35
35
|
|
|
36
36
|
If the pages support the selection, run
|
|
37
|
-
`npx --yes copilotkit@4.
|
|
37
|
+
`npx --yes copilotkit@4.14.0 onboard read frontend/plan`.
|
|
38
38
|
|
|
39
39
|
If the documentation does not support the selection, run
|
|
40
|
-
`npx --yes copilotkit@4.
|
|
40
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -29,7 +29,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
29
29
|
these URLs.
|
|
30
30
|
|
|
31
31
|
If the pages support the selection, run
|
|
32
|
-
`npx --yes copilotkit@4.
|
|
32
|
+
`npx --yes copilotkit@4.14.0 onboard read frontend/plan`.
|
|
33
33
|
|
|
34
34
|
If the documentation does not support the selection, run
|
|
35
|
-
`npx --yes copilotkit@4.
|
|
35
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -33,7 +33,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
33
33
|
URLs, and the context limit.
|
|
34
34
|
|
|
35
35
|
If the pages support the selection, run
|
|
36
|
-
`npx --yes copilotkit@4.
|
|
36
|
+
`npx --yes copilotkit@4.14.0 onboard read frontend/plan`.
|
|
37
37
|
|
|
38
38
|
If the documentation does not support the selection, run
|
|
39
|
-
`npx --yes copilotkit@4.
|
|
39
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -37,7 +37,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
37
37
|
URLs, and the context limit.
|
|
38
38
|
|
|
39
39
|
If the pages support the selection, run
|
|
40
|
-
`npx --yes copilotkit@4.
|
|
40
|
+
`npx --yes copilotkit@4.14.0 onboard read frontend/plan`.
|
|
41
41
|
|
|
42
42
|
If the documentation does not support the selection, run
|
|
43
|
-
`npx --yes copilotkit@4.
|
|
43
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -54,7 +54,7 @@ variable names the repository proves or the developer named, these URLs, the ada
|
|
|
54
54
|
shared-state limit.
|
|
55
55
|
|
|
56
56
|
If the pages support the selection, run
|
|
57
|
-
`npx --yes copilotkit@4.
|
|
57
|
+
`npx --yes copilotkit@4.14.0 onboard read frontend/plan`.
|
|
58
58
|
|
|
59
59
|
If the documentation does not support the selection, run
|
|
60
|
-
`npx --yes copilotkit@4.
|
|
60
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -32,7 +32,7 @@ Record the selected framework, language, vendor, model, required credential vari
|
|
|
32
32
|
names, these URLs, and each documentation gap.
|
|
33
33
|
|
|
34
34
|
If the pages support the selection, run
|
|
35
|
-
`npx --yes copilotkit@4.
|
|
35
|
+
`npx --yes copilotkit@4.14.0 onboard read frontend/plan`.
|
|
36
36
|
|
|
37
37
|
If the documentation does not support the selection, run
|
|
38
|
-
`npx --yes copilotkit@4.
|
|
38
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -30,7 +30,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
30
30
|
these URLs.
|
|
31
31
|
|
|
32
32
|
If the pages support the selection, run
|
|
33
|
-
`npx --yes copilotkit@4.
|
|
33
|
+
`npx --yes copilotkit@4.14.0 onboard read frontend/plan`.
|
|
34
34
|
|
|
35
35
|
If the documentation does not support the selection, run
|
|
36
|
-
`npx --yes copilotkit@4.
|
|
36
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -25,7 +25,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
25
25
|
these URLs.
|
|
26
26
|
|
|
27
27
|
If the pages support the selection, run
|
|
28
|
-
`npx --yes copilotkit@4.
|
|
28
|
+
`npx --yes copilotkit@4.14.0 onboard read frontend/plan`.
|
|
29
29
|
|
|
30
30
|
If the documentation does not support the selection, run
|
|
31
|
-
`npx --yes copilotkit@4.
|
|
31
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -19,7 +19,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
19
19
|
these URLs.
|
|
20
20
|
|
|
21
21
|
If the pages support the selection, run
|
|
22
|
-
`npx --yes copilotkit@4.
|
|
22
|
+
`npx --yes copilotkit@4.14.0 onboard read frontend/plan`.
|
|
23
23
|
|
|
24
24
|
If the documentation does not support the selection, run
|
|
25
|
-
`npx --yes copilotkit@4.
|
|
25
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -19,7 +19,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
19
19
|
these URLs.
|
|
20
20
|
|
|
21
21
|
If the pages support the selection, run
|
|
22
|
-
`npx --yes copilotkit@4.
|
|
22
|
+
`npx --yes copilotkit@4.14.0 onboard read frontend/plan`.
|
|
23
23
|
|
|
24
24
|
If the documentation does not support the selection, run
|
|
25
|
-
`npx --yes copilotkit@4.
|
|
25
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -34,7 +34,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
34
34
|
URLs, the documented dependencies and adapter, and both documentation limits.
|
|
35
35
|
|
|
36
36
|
If the pages support the selection, run
|
|
37
|
-
`npx --yes copilotkit@4.
|
|
37
|
+
`npx --yes copilotkit@4.14.0 onboard read frontend/plan`.
|
|
38
38
|
|
|
39
39
|
If the documentation does not support the selection, run
|
|
40
|
-
`npx --yes copilotkit@4.
|
|
40
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -47,7 +47,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
47
47
|
these URLs.
|
|
48
48
|
|
|
49
49
|
If the pages support the selection, run
|
|
50
|
-
`npx --yes copilotkit@4.
|
|
50
|
+
`npx --yes copilotkit@4.14.0 onboard read frontend/plan`.
|
|
51
51
|
|
|
52
52
|
If the documentation does not support the selection, run
|
|
53
|
-
`npx --yes copilotkit@4.
|
|
53
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -36,7 +36,7 @@ Record the selected framework, provider, model, required credential variable nam
|
|
|
36
36
|
these URLs.
|
|
37
37
|
|
|
38
38
|
If the pages support the selection, run
|
|
39
|
-
`npx --yes copilotkit@4.
|
|
39
|
+
`npx --yes copilotkit@4.14.0 onboard read frontend/plan`.
|
|
40
40
|
|
|
41
41
|
If the documentation does not support the selection, run
|
|
42
|
-
`npx --yes copilotkit@4.
|
|
42
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -44,7 +44,7 @@ Record the selected framework, provider, model, required credential variable nam
|
|
|
44
44
|
URLs, and the quickstart gap.
|
|
45
45
|
|
|
46
46
|
If the pages support the selection, run
|
|
47
|
-
`npx --yes copilotkit@4.
|
|
47
|
+
`npx --yes copilotkit@4.14.0 onboard read frontend/plan`.
|
|
48
48
|
|
|
49
49
|
If the documentation does not support the selection, run
|
|
50
|
-
`npx --yes copilotkit@4.
|
|
50
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -30,7 +30,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
30
30
|
these URLs.
|
|
31
31
|
|
|
32
32
|
If the pages support the selection, run
|
|
33
|
-
`npx --yes copilotkit@4.
|
|
33
|
+
`npx --yes copilotkit@4.14.0 onboard read frontend/plan`.
|
|
34
34
|
|
|
35
35
|
If the documentation does not support the selection, run
|
|
36
|
-
`npx --yes copilotkit@4.
|
|
36
|
+
`npx --yes copilotkit@4.14.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.14.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.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -29,7 +29,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
29
29
|
URLs, and the context documentation gap.
|
|
30
30
|
|
|
31
31
|
If the pages support the selection, run
|
|
32
|
-
`npx --yes copilotkit@4.
|
|
32
|
+
`npx --yes copilotkit@4.14.0 onboard read frontend/plan`.
|
|
33
33
|
|
|
34
34
|
If the documentation does not support the selection, run
|
|
35
|
-
`npx --yes copilotkit@4.
|
|
35
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -30,7 +30,7 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
30
30
|
URLs, and the context documentation gap.
|
|
31
31
|
|
|
32
32
|
If the pages support the selection, run
|
|
33
|
-
`npx --yes copilotkit@4.
|
|
33
|
+
`npx --yes copilotkit@4.14.0 onboard read frontend/plan`.
|
|
34
34
|
|
|
35
35
|
If the documentation does not support the selection, run
|
|
36
|
-
`npx --yes copilotkit@4.
|
|
36
|
+
`npx --yes copilotkit@4.14.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 holds no
|
|
6
6
|
project, 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.14.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.14.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.14.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.14.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.14.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.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -36,15 +36,15 @@ CopilotKit web apps. Then recommend the one the developer names, and say what ea
|
|
|
36
36
|
|
|
37
37
|
Use exactly one matching internal route:
|
|
38
38
|
|
|
39
|
-
1. React SPA: `npx --yes copilotkit@4.
|
|
40
|
-
2. Next.js: `npx --yes copilotkit@4.
|
|
41
|
-
3. Angular: `npx --yes copilotkit@4.
|
|
42
|
-
4. Vue 3: `npx --yes copilotkit@4.
|
|
43
|
-
5. React Native: `npx --yes copilotkit@4.
|
|
44
|
-
6. Slack or Microsoft Teams: `npx --yes copilotkit@4.
|
|
39
|
+
1. React SPA: `npx --yes copilotkit@4.14.0 onboard read frontend/react-spa`
|
|
40
|
+
2. Next.js: `npx --yes copilotkit@4.14.0 onboard read frontend/nextjs`
|
|
41
|
+
3. Angular: `npx --yes copilotkit@4.14.0 onboard read frontend/angular`
|
|
42
|
+
4. Vue 3: `npx --yes copilotkit@4.14.0 onboard read frontend/vue`
|
|
43
|
+
5. React Native: `npx --yes copilotkit@4.14.0 onboard read frontend/react-native`
|
|
44
|
+
6. Slack or Microsoft Teams: `npx --yes copilotkit@4.14.0 onboard read feature/channels/start`
|
|
45
45
|
|
|
46
46
|
If they chose Slack or Microsoft Teams, tell that node which one they chose so it
|
|
47
47
|
does not ask again.
|
|
48
48
|
|
|
49
49
|
If no listed frontend fits, run
|
|
50
|
-
`npx --yes copilotkit@4.
|
|
50
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -2,6 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
Preserve an existing React Native frontend. Use the selected page for a new frontend.
|
|
4
4
|
|
|
5
|
+
React Native has no starter. For a target directory that holds no project, build the new
|
|
6
|
+
frontend from the documentation below.
|
|
7
|
+
|
|
5
8
|
## Documentation
|
|
6
9
|
|
|
7
10
|
- https://docs.copilotkit.ai/react-native.md
|
|
@@ -15,7 +18,7 @@ documents `useRenderTool`, which is React Native's own hook for drawing a tool t
|
|
|
15
18
|
already has. That is a different job and needs a tool in the agent.
|
|
16
19
|
|
|
17
20
|
If the pages support the selection, record React Native and these URLs. Then run
|
|
18
|
-
`npx --yes copilotkit@4.
|
|
21
|
+
`npx --yes copilotkit@4.14.0 onboard read credentials/finalize-plan`.
|
|
19
22
|
|
|
20
23
|
If the documentation does not support the selection, run
|
|
21
|
-
`npx --yes copilotkit@4.
|
|
24
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -2,6 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
Preserve an existing React SPA. Use the selected page for a new frontend.
|
|
4
4
|
|
|
5
|
+
React SPA has no starter. For a target directory that holds no project, build the new
|
|
6
|
+
frontend from the documentation below.
|
|
7
|
+
|
|
5
8
|
A React SPA has no server of its own, so the CopilotKit runtime is a separate process
|
|
6
9
|
rather than a route inside the app. Do not add a runtime route to the SPA build, and do
|
|
7
10
|
not move the agent into it.
|
|
@@ -11,7 +14,7 @@ not move the agent into it.
|
|
|
11
14
|
- https://docs.copilotkit.ai/react-spa.md
|
|
12
15
|
|
|
13
16
|
If the page supports the selection, record React SPA and this URL. Then run
|
|
14
|
-
`npx --yes copilotkit@4.
|
|
17
|
+
`npx --yes copilotkit@4.14.0 onboard read credentials/finalize-plan`.
|
|
15
18
|
|
|
16
19
|
If the documentation does not support the selection, run
|
|
17
|
-
`npx --yes copilotkit@4.
|
|
20
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -2,6 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
Preserve an existing Vue 3 frontend. Use the selected page for a new frontend.
|
|
4
4
|
|
|
5
|
+
Vue 3 has no starter. For a target directory that holds no project, build the new
|
|
6
|
+
frontend from the documentation below.
|
|
7
|
+
|
|
5
8
|
## Documentation
|
|
6
9
|
|
|
7
10
|
- https://docs.copilotkit.ai/vue.md
|
|
@@ -16,7 +19,7 @@ page above. Vue has its own `useComponent`, which is not the React package. Take
|
|
|
16
19
|
that reference page rather than from a Vue generative-UI guide, which is not published.
|
|
17
20
|
|
|
18
21
|
If the pages support the selection, record Vue 3 and these URLs. Then run
|
|
19
|
-
`npx --yes copilotkit@4.
|
|
22
|
+
`npx --yes copilotkit@4.14.0 onboard read credentials/finalize-plan`.
|
|
20
23
|
|
|
21
24
|
If the documentation does not support the selection, run
|
|
22
|
-
`npx --yes copilotkit@4.
|
|
25
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -12,7 +12,7 @@ command without another developer question. Do not ask the developer about telem
|
|
|
12
12
|
command applies the setting they already have.
|
|
13
13
|
|
|
14
14
|
```text
|
|
15
|
-
npx --yes copilotkit@4.
|
|
15
|
+
npx --yes copilotkit@4.14.0 onboard friction --phase stop --category <slug>
|
|
16
16
|
```
|
|
17
17
|
|
|
18
18
|
Write one or two sentences to standard input: the step you stopped at and what stopped it.
|
|
@@ -27,8 +27,8 @@ run.
|
|
|
27
27
|
|
|
28
28
|
## Departing from the approved plan
|
|
29
29
|
|
|
30
|
-
The developer approved a written plan and was told that approval was the last
|
|
31
|
-
run
|
|
30
|
+
The developer approved a written plan and was told that approval was the last question this
|
|
31
|
+
run asked them. A step that cannot be built as written is therefore a change to the
|
|
32
32
|
only thing they agreed to.
|
|
33
33
|
|
|
34
34
|
Where you depart from a path, a version, or a step the plan named, record it: what the
|
|
@@ -40,11 +40,12 @@ The existing agent's behavior is never a departure to record and carry on from.
|
|
|
40
40
|
things: its system prompt and instructions, its tools and what those tools do, its model
|
|
41
41
|
and provider configuration, and its memory or state handling. Repair a failing check on
|
|
42
42
|
the CopilotKit side first -- the frontend rendering, the tool schema, the runtime wiring.
|
|
43
|
-
Where the only fix you can find is a change to the agent's instructions or tools,
|
|
44
|
-
report the failing predicate and the change you propose,
|
|
45
|
-
developer
|
|
46
|
-
|
|
47
|
-
|
|
43
|
+
Where the only fix you can find is a change to the agent's instructions or tools, pause:
|
|
44
|
+
report the failing predicate and the change you propose, then end your turn and wait for
|
|
45
|
+
the developer's approval. Continue only after the developer approves it. An approved
|
|
46
|
+
change is a behavior change, and the closing report names it as one. Never call a change
|
|
47
|
+
to the agent's instructions or tools a repair. If you cannot ask, or the developer
|
|
48
|
+
declines, use the route-out rules below.
|
|
48
49
|
|
|
49
50
|
## Authorization requested by the plan
|
|
50
51
|
|
|
@@ -53,7 +54,7 @@ Approving the plan is the developer agreeing to every path it listed under
|
|
|
53
54
|
app directory:
|
|
54
55
|
|
|
55
56
|
```text
|
|
56
|
-
npx --yes copilotkit@4.
|
|
57
|
+
npx --yes copilotkit@4.14.0 onboard protect --authorize --path <path> --reason "<the plan's sentence>"
|
|
57
58
|
```
|
|
58
59
|
|
|
59
60
|
Consent has to be on the record before the file moves, so a call made after the change is
|
|
@@ -70,7 +71,7 @@ No implementation step has run yet, so the change is theirs rather than this run
|
|
|
70
71
|
consent over it by adding one flag:
|
|
71
72
|
|
|
72
73
|
```text
|
|
73
|
-
npx --yes copilotkit@4.
|
|
74
|
+
npx --yes copilotkit@4.14.0 onboard protect --authorize --path <path> --reason "<the plan's sentence>" --with-prior-change
|
|
74
75
|
```
|
|
75
76
|
|
|
76
77
|
The flag records their change as drift beside the consent, so the closing report names both
|
|
@@ -89,7 +90,7 @@ rather than this section.
|
|
|
89
90
|
Run the audit from the target app directory:
|
|
90
91
|
|
|
91
92
|
```text
|
|
92
|
-
npx --yes copilotkit@4.
|
|
93
|
+
npx --yes copilotkit@4.14.0 onboard audit
|
|
93
94
|
```
|
|
94
95
|
|
|
95
96
|
It compares every protected path with the digest the CLI captured for it. Its result starts
|
|
@@ -124,18 +125,18 @@ A path that no Files changed section names changed outside the run, and it is th
|
|
|
124
125
|
developer's own file. Accept it by name:
|
|
125
126
|
|
|
126
127
|
```text
|
|
127
|
-
npx --yes copilotkit@4.
|
|
128
|
+
npx --yes copilotkit@4.14.0 onboard protect --accept-external --path <path>
|
|
128
129
|
```
|
|
129
130
|
|
|
130
131
|
A changed env file is its own case. This run asked the developer to place a credential
|
|
131
132
|
there, so it takes the credential route rather than this one:
|
|
132
133
|
|
|
133
134
|
```text
|
|
134
|
-
npx --yes copilotkit@4.
|
|
135
|
+
npx --yes copilotkit@4.14.0 onboard protect --accept-credential --path <path>
|
|
135
136
|
```
|
|
136
137
|
|
|
137
138
|
That route proves no recorded credential was lost, instead of taking the run's word that it
|
|
138
|
-
did not write the file. Read its refusal and stop if it names a lost variable.
|
|
139
|
+
did not write the file. Read its refusal and stop onboarding if it names a lost variable.
|
|
139
140
|
|
|
140
141
|
Pass one `--path` for each path you accept. Accept only a path the audit named, and only
|
|
141
142
|
when no step of this run wrote it. The command re-captures that path, records that this
|
|
@@ -150,7 +151,7 @@ neither does a one-line fix. Never repair, reset, or revert it. Ask the develope
|
|
|
150
151
|
the change, and record the answer they give:
|
|
151
152
|
|
|
152
153
|
```text
|
|
153
|
-
npx --yes copilotkit@4.
|
|
154
|
+
npx --yes copilotkit@4.14.0 onboard protect --authorize --unplanned --path <path> --reason "<what the developer said>"
|
|
154
155
|
```
|
|
155
156
|
|
|
156
157
|
Use it only for an answer a developer actually gave. It records the consent as taken
|
|
@@ -171,7 +172,7 @@ create it now, from the target app directory. The developer approved the id befo
|
|
|
171
172
|
made, so this is the first point at which it can be created:
|
|
172
173
|
|
|
173
174
|
```text
|
|
174
|
-
npx --yes copilotkit@4.
|
|
175
|
+
npx --yes copilotkit@4.14.0 learning containers create --id <id> --name <name> --json
|
|
175
176
|
```
|
|
176
177
|
|
|
177
178
|
Pass the id the plan names. Take the name from the selected project's own display name, so
|
|
@@ -187,7 +188,7 @@ hold.
|
|
|
187
188
|
Then report that the container is settled, before any edit:
|
|
188
189
|
|
|
189
190
|
```text
|
|
190
|
-
npx --yes copilotkit@4.
|
|
191
|
+
npx --yes copilotkit@4.14.0 onboard checkpoint --phase container-settled
|
|
191
192
|
```
|
|
192
193
|
|
|
193
194
|
Where the plan names a container the platform already held, report the same checkpoint and
|
|
@@ -196,11 +197,11 @@ create nothing. Where the plan names no container, skip this section.
|
|
|
196
197
|
Report the plan this run is about to implement:
|
|
197
198
|
|
|
198
199
|
```text
|
|
199
|
-
npx --yes copilotkit@4.
|
|
200
|
+
npx --yes copilotkit@4.14.0 onboard checkpoint --phase plan-written
|
|
200
201
|
```
|
|
201
202
|
|
|
202
203
|
Spawn one implementation subagent. Tell it to run
|
|
203
|
-
`npx --yes copilotkit@4.
|
|
204
|
+
`npx --yes copilotkit@4.14.0 onboard read subagent/implement-and-validate` first and follow
|
|
204
205
|
the prompt it returns. If that read fails because the subagent cannot use the shell, stop that
|
|
205
206
|
subagent. Run the same command yourself, then spawn a fresh subagent with the returned prompt
|
|
206
207
|
and the same handoff. Give it the plan, selected framework, frontend, model, exact target app
|
|
@@ -228,11 +229,11 @@ returned. Continue to proof only when that audit passes.
|
|
|
228
229
|
After the selected implementation path passes, report it:
|
|
229
230
|
|
|
230
231
|
```text
|
|
231
|
-
npx --yes copilotkit@4.
|
|
232
|
+
npx --yes copilotkit@4.14.0 onboard checkpoint --phase build-validated
|
|
232
233
|
```
|
|
233
234
|
|
|
234
235
|
Then run
|
|
235
|
-
`npx --yes copilotkit@4.
|
|
236
|
+
`npx --yes copilotkit@4.14.0 onboard read proof/round-trip`.
|
|
236
237
|
|
|
237
238
|
## Repair rules
|
|
238
239
|
|
|
@@ -254,9 +255,9 @@ the same command still fails after three repair attempts, or a result starts wit
|
|
|
254
255
|
`Status: blocked`. A defect in a package this run installed is not a stack CopilotKit does
|
|
255
256
|
not serve, a command this run cannot get to pass is not one either, and a blocked audit
|
|
256
257
|
proved nothing about the stack. In those cases run
|
|
257
|
-
`npx --yes copilotkit@4.
|
|
258
|
+
`npx --yes copilotkit@4.14.0 onboard read stopped/run-failed`.
|
|
258
259
|
|
|
259
260
|
A plan with no path to follow takes the unsupported ending: the fix requires changing the
|
|
260
261
|
developer's existing agent or frontend, or the documentation does not support the plan. In
|
|
261
262
|
those cases run
|
|
262
|
-
`npx --yes copilotkit@4.
|
|
263
|
+
`npx --yes copilotkit@4.14.0 onboard read unsupported/no-validated-path`.
|
|
@@ -84,7 +84,7 @@ Name the debugging surface this journey's frontend can reach, rather than the on
|
|
|
84
84
|
of the documentation leads with. For a web frontend it is the CopilotKit Inspector. For
|
|
85
85
|
React Native there is no Inspector: it is a browser overlay built on a DOM custom element,
|
|
86
86
|
and `@copilotkit/react-native` does not ship it. Give a mobile developer
|
|
87
|
-
`npx --yes copilotkit@4.
|
|
87
|
+
`npx --yes copilotkit@4.14.0 verify --round-trip`, the runtime's own log, the AG-UI
|
|
88
88
|
Event Inspector in the CopilotKit VS Code extension, and the CopilotKit Intelligence
|
|
89
89
|
thread view
|
|
90
90
|
instead. Naming the Inspector to a developer who cannot open it costs them the time it
|
|
@@ -114,7 +114,7 @@ the friction commands without another developer question. Do not ask the develop
|
|
|
114
114
|
telemetry: the command applies the setting they already have.
|
|
115
115
|
|
|
116
116
|
```text
|
|
117
|
-
npx --yes copilotkit@4.
|
|
117
|
+
npx --yes copilotkit@4.14.0 onboard friction --category <slug> --cost-seconds <seconds>
|
|
118
118
|
```
|
|
119
119
|
|
|
120
120
|
Write one or two sentences on the command's standard input. Pick one category from
|
|
@@ -126,7 +126,7 @@ Pass --docs-path only for a docs-missing or docs-wrong report, naming the page t
|
|
|
126
126
|
is about:
|
|
127
127
|
|
|
128
128
|
```text
|
|
129
|
-
npx --yes copilotkit@4.
|
|
129
|
+
npx --yes copilotkit@4.14.0 onboard friction --category docs-wrong --cost-seconds 300 --docs-path /docs/threads/drawer
|
|
130
130
|
```
|
|
131
131
|
|
|
132
132
|
Give the page's site-relative path or its full URL, with no spaces, query string, or
|
|
@@ -143,14 +143,14 @@ Tell the developer when you send a friction report. Do not quote or summarize th
|
|
|
143
143
|
unless the developer asks. If the CLI says the report was not sent,
|
|
144
144
|
state what it said and continue without another question.
|
|
145
145
|
|
|
146
|
-
When the evidence is gathered, run `npx --yes copilotkit@4.
|
|
146
|
+
When the evidence is gathered, run `npx --yes copilotkit@4.14.0 onboard complete`, carrying
|
|
147
147
|
the surface-check outcome the proof subagent returned. Pass exactly one flag, and pass the
|
|
148
148
|
one that matches this journey's surface.
|
|
149
149
|
|
|
150
150
|
For a web frontend -- React SPA, Next.js, Angular, Vue:
|
|
151
151
|
|
|
152
152
|
```text
|
|
153
|
-
npx --yes copilotkit@4.
|
|
153
|
+
npx --yes copilotkit@4.14.0 onboard complete --visual-check <outcome>
|
|
154
154
|
```
|
|
155
155
|
|
|
156
156
|
The outcome is one of `performed`, `skipped-no-browser-tool`, `skipped-cloned-starter`, or
|
|
@@ -160,7 +160,7 @@ open no browser. It is the one skip that does not block.
|
|
|
160
160
|
For React Native:
|
|
161
161
|
|
|
162
162
|
```text
|
|
163
|
-
npx --yes copilotkit@4.
|
|
163
|
+
npx --yes copilotkit@4.14.0 onboard complete --device-check <outcome>
|
|
164
164
|
```
|
|
165
165
|
|
|
166
166
|
The outcome is one of `performed`, `skipped-no-device`, `skipped-cloned-starter`, or
|
|
@@ -173,7 +173,7 @@ browser-origin CORS, so the flag you pass is how this run states which surface i
|
|
|
173
173
|
For a web frontend, also pass the URL the browser opened:
|
|
174
174
|
|
|
175
175
|
```text
|
|
176
|
-
npx --yes copilotkit@4.
|
|
176
|
+
npx --yes copilotkit@4.14.0 onboard complete --visual-check <outcome> \
|
|
177
177
|
--frontend-url <the url you opened>
|
|
178
178
|
```
|
|
179
179
|
|
|
@@ -192,7 +192,7 @@ If the round trip proved and something after it still blocked this run, add `--b
|
|
|
192
192
|
to the same command:
|
|
193
193
|
|
|
194
194
|
```text
|
|
195
|
-
npx --yes copilotkit@4.
|
|
195
|
+
npx --yes copilotkit@4.14.0 onboard complete --visual-check performed --blocked-by <cause>
|
|
196
196
|
```
|
|
197
197
|
|
|
198
198
|
The cause is one of `inspector` for a debugging surface that did not open,
|