copilotkit 4.24.0 → 4.25.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.
Files changed (91) hide show
  1. package/README.md +75 -14
  2. package/cli-build-info.json +7 -7
  3. package/index.js +8544 -6674
  4. package/onboarding/index.json +2 -2
  5. package/onboarding/prompts/authenticate/start.md +50 -45
  6. package/onboarding/prompts/conversion/plan.md +3 -3
  7. package/onboarding/prompts/credentials/finalize-plan.md +30 -8
  8. package/onboarding/prompts/credentials/plan.md +115 -49
  9. package/onboarding/prompts/credentials/settle-credentials.md +7 -5
  10. package/onboarding/prompts/credentials/write-plan.md +15 -15
  11. package/onboarding/prompts/deployment/choose-local.md +44 -7
  12. package/onboarding/prompts/deployment/local-evaluation.md +12 -6
  13. package/onboarding/prompts/fallback/best-effort.md +8 -8
  14. package/onboarding/prompts/feature/a2ui/implement.md +15 -8
  15. package/onboarding/prompts/feature/a2ui/plan.md +15 -7
  16. package/onboarding/prompts/feature/a2ui/proof.md +14 -7
  17. package/onboarding/prompts/feature/a2ui/start.md +15 -14
  18. package/onboarding/prompts/feature/channels/implement.md +21 -9
  19. package/onboarding/prompts/feature/channels/plan.md +15 -7
  20. package/onboarding/prompts/feature/channels/proof.md +14 -7
  21. package/onboarding/prompts/feature/channels/start.md +20 -13
  22. package/onboarding/prompts/feature/chat-suggestions/implement.md +15 -8
  23. package/onboarding/prompts/feature/chat-suggestions/plan.md +15 -7
  24. package/onboarding/prompts/feature/chat-suggestions/proof.md +14 -7
  25. package/onboarding/prompts/feature/chat-suggestions/start.md +15 -14
  26. package/onboarding/prompts/feature/complete.md +2 -2
  27. package/onboarding/prompts/feature/learning/implement.md +32 -18
  28. package/onboarding/prompts/feature/learning/plan.md +15 -7
  29. package/onboarding/prompts/feature/learning/proof.md +37 -13
  30. package/onboarding/prompts/feature/learning/start.md +15 -14
  31. package/onboarding/prompts/feature/open-generative-ui/implement.md +15 -8
  32. package/onboarding/prompts/feature/open-generative-ui/plan.md +15 -7
  33. package/onboarding/prompts/feature/open-generative-ui/proof.md +14 -7
  34. package/onboarding/prompts/feature/open-generative-ui/start.md +15 -14
  35. package/onboarding/prompts/feature/realtime-sync/implement.md +20 -12
  36. package/onboarding/prompts/feature/realtime-sync/plan.md +15 -7
  37. package/onboarding/prompts/feature/realtime-sync/proof.md +14 -7
  38. package/onboarding/prompts/feature/realtime-sync/start.md +14 -13
  39. package/onboarding/prompts/feature/rich-threads/implement.md +21 -13
  40. package/onboarding/prompts/feature/rich-threads/plan.md +15 -7
  41. package/onboarding/prompts/feature/rich-threads/proof.md +14 -7
  42. package/onboarding/prompts/feature/rich-threads/start.md +14 -13
  43. package/onboarding/prompts/feature/stop.md +9 -3
  44. package/onboarding/prompts/feature/voice/implement.md +15 -8
  45. package/onboarding/prompts/feature/voice/plan.md +16 -8
  46. package/onboarding/prompts/feature/voice/proof.md +14 -7
  47. package/onboarding/prompts/feature/voice/start.md +15 -14
  48. package/onboarding/prompts/framework/ag2.md +6 -5
  49. package/onboarding/prompts/framework/agno.md +6 -5
  50. package/onboarding/prompts/framework/built-in.md +9 -6
  51. package/onboarding/prompts/framework/claude-sdk-python.md +2 -2
  52. package/onboarding/prompts/framework/claude-sdk-typescript.md +2 -2
  53. package/onboarding/prompts/framework/crewai-flows.md +12 -4
  54. package/onboarding/prompts/framework/custom-ag-ui.md +8 -2
  55. package/onboarding/prompts/framework/deep-agents.md +6 -5
  56. package/onboarding/prompts/framework/google-adk.md +2 -2
  57. package/onboarding/prompts/framework/langgraph-fastapi.md +8 -5
  58. package/onboarding/prompts/framework/langgraph-python.md +8 -5
  59. package/onboarding/prompts/framework/langgraph-typescript.md +8 -5
  60. package/onboarding/prompts/framework/llamaindex.md +6 -5
  61. package/onboarding/prompts/framework/mastra.md +9 -6
  62. package/onboarding/prompts/framework/ms-agent-dotnet.md +12 -4
  63. package/onboarding/prompts/framework/ms-agent-harness-dotnet.md +12 -4
  64. package/onboarding/prompts/framework/ms-agent-python.md +6 -5
  65. package/onboarding/prompts/framework/pydantic-ai.md +6 -5
  66. package/onboarding/prompts/framework/strands-python.md +10 -6
  67. package/onboarding/prompts/framework/strands-typescript.md +10 -6
  68. package/onboarding/prompts/frontend/angular.md +10 -3
  69. package/onboarding/prompts/frontend/nextjs.md +36 -3
  70. package/onboarding/prompts/frontend/plan.md +13 -7
  71. package/onboarding/prompts/frontend/react-native.md +9 -2
  72. package/onboarding/prompts/frontend/react-spa.md +9 -2
  73. package/onboarding/prompts/frontend/vue.md +9 -2
  74. package/onboarding/prompts/implementation/build-and-validate.md +45 -19
  75. package/onboarding/prompts/proof/complete.md +3 -3
  76. package/onboarding/prompts/proof/oss-baseline.md +30 -13
  77. package/onboarding/prompts/proof/round-trip.md +55 -17
  78. package/onboarding/prompts/research/gather.md +21 -11
  79. package/onboarding/prompts/research/merge.md +8 -2
  80. package/onboarding/prompts/research/preflight.md +2 -2
  81. package/onboarding/prompts/research/route.md +14 -7
  82. package/onboarding/prompts/starter/clone.md +73 -16
  83. package/onboarding/prompts/stopped/run-failed.md +8 -2
  84. package/onboarding/prompts/subagent/create-plan.md +9 -2
  85. package/onboarding/prompts/subagent/implement-and-validate.md +2 -2
  86. package/onboarding/prompts/subagent/inspect-repository.md +12 -6
  87. package/onboarding/prompts/subagent/prove-oss-baseline.md +6 -1
  88. package/onboarding/prompts/subagent/prove-round-trip.md +50 -9
  89. package/onboarding/prompts/unsupported/no-validated-path.md +8 -2
  90. package/package.json +1 -1
  91. package/release/release-tool.js +9 -3
@@ -1,8 +1,9 @@
1
1
  # Configure AG2
2
2
 
3
- Preserve an existing AG2 model setup. Start with OpenAI for a new agent. Offer another
4
- vendor only after an exact CopilotKit Markdown page names it. The page must name its
5
- credential variables and setup steps.
3
+ Preserve an existing AG2 model setup. For a new agent, use the vendor that the framework
4
+ step recorded. If it recorded none, use OpenAI. Offer another vendor only after an exact
5
+ CopilotKit Markdown page names it. The page must name its credential variables and setup
6
+ steps.
6
7
 
7
8
  Name the default model credential `OPENAI_API_KEY`.
8
9
 
@@ -31,7 +32,7 @@ Record the selected framework, vendor, model, required credential variable names
31
32
  URLs, and the A2UI documentation gap.
32
33
 
33
34
  If the pages support the selection, run
34
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
35
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
35
36
 
36
37
  If the documentation does not support the selection, run
37
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
38
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -1,8 +1,9 @@
1
1
  # Configure Agno
2
2
 
3
- Preserve an existing Agno model setup. Start with OpenAI for a new agent. Offer another
4
- vendor only after an exact CopilotKit Markdown page names it. The page must name its
5
- credential variables and setup steps.
3
+ Preserve an existing Agno model setup. For a new agent, use the vendor that the framework
4
+ step recorded. If it recorded none, use OpenAI. Offer another vendor only after an exact
5
+ CopilotKit Markdown page names it. The page must name its credential variables and setup
6
+ steps.
6
7
 
7
8
  Name the default model credential `OPENAI_API_KEY`.
8
9
 
@@ -34,7 +35,7 @@ Record the selected framework, vendor, model, required credential variable names
34
35
  URLs, the documented dependencies and adapter, and the context documentation gap.
35
36
 
36
37
  If the pages support the selection, run
37
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
38
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
38
39
 
39
40
  If the documentation does not support the selection, run
40
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
41
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -1,10 +1,13 @@
1
1
  # Configure the built-in CopilotKit agent
2
2
 
3
- Preserve an existing built-in agent model setup. Start with OpenAI for a new agent. Offer
4
- another vendor only after an exact CopilotKit Markdown page names it. The page must name
5
- its credential variables and setup steps.
3
+ Preserve an existing built-in agent model setup. For a new agent, use the vendor that the
4
+ framework step recorded. If it recorded none, use OpenAI. Offer another vendor only after
5
+ an exact CopilotKit Markdown page names it. The page must name its credential variables
6
+ and setup steps.
6
7
 
7
- Name the default model credential `OPENAI_API_KEY`.
8
+ Name the default model credential `OPENAI_API_KEY`. For Anthropic, name it
9
+ `ANTHROPIC_API_KEY`. For Google, name it `GOOGLE_API_KEY`. Take the model id for the
10
+ chosen vendor, in the `provider:model` form, from the model selection page.
8
11
 
9
12
  The built-in agent runs in the CopilotKit Runtime process.
10
13
  Do not create or start a separate agent server.
@@ -29,7 +32,7 @@ Record the selected framework, vendor, model, required credential variable names
29
32
  these URLs.
30
33
 
31
34
  If the pages support the selection, run
32
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
35
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
33
36
 
34
37
  If the documentation does not support the selection, run
35
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
38
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -34,7 +34,7 @@ Record the selected framework, vendor, model, required credential variable names
34
34
  these URLs.
35
35
 
36
36
  If the pages support the selection, run
37
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
37
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
38
38
 
39
39
  If the documentation does not support the selection, run
40
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
40
+ `npx --prefer-offline --yes copilotkit@4.25.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 --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
40
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
41
41
 
42
42
  If the documentation does not support the selection, run
43
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
43
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -18,8 +18,16 @@ CrewAI pages name no vendor, so this release makes no recommendation here and wi
18
18
  pick one. If the developer names a vendor and no variable name, propose the variable name
19
19
  that vendor's own client reads and ask them to confirm it. A proposal the developer
20
20
  confirms is theirs. Ask for a variable name, never the value it holds. Do not combine this
21
- with a frontend, project, or plan-approval question. Record the answer as the
22
- project-defined provider, model, and credential variable name, and continue.
21
+ with a frontend, project, or plan-approval question.
22
+
23
+ Before you end your turn to wait for the developer, report the pause:
24
+
25
+ ```text
26
+ npx --prefer-offline --yes copilotkit@4.25.0 onboard checkpoint --phase awaiting-developer
27
+ ```
28
+
29
+ When the developer answers, record the answer as the project-defined provider, model, and
30
+ credential variable name, and continue.
23
31
 
24
32
  A vendor nobody has chosen yet is not a missing supported path. This release supports
25
33
  CrewAI Flows. Do not run the unsupported route below because the project defines no
@@ -62,7 +70,7 @@ Record the selected framework, project-defined provider and model, the credentia
62
70
  variable names the repository proves or the developer named, these URLs, and the adapter.
63
71
 
64
72
  If the pages support the selection, run
65
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
73
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
66
74
 
67
75
  If the documentation does not support the selection, run
68
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
76
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -60,6 +60,12 @@ If the project's `@ag-ui/client` version is not the runtime's version, name both
60
60
  in the plan. The agent depends on its own version, so ask the developer before you change
61
61
  it.
62
62
 
63
+ Before you end your turn to wait for the developer, report the pause:
64
+
65
+ ```text
66
+ npx --prefer-offline --yes copilotkit@4.25.0 onboard checkpoint --phase awaiting-developer
67
+ ```
68
+
63
69
  ## Keep the agent working on a clone
64
70
 
65
71
  The runtime clones the registered agent for every request. `AbstractAgent.clone()`
@@ -95,7 +101,7 @@ credential variable names that the agent already uses, the `clone()` finding, an
95
101
  URLs.
96
102
 
97
103
  If the pages support the selection, run
98
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
104
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
99
105
 
100
106
  If the documentation does not support the selection, run
101
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
107
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -1,8 +1,9 @@
1
1
  # Configure Deep Agents
2
2
 
3
- Preserve an existing Deep Agents language and model setup. Start with OpenAI for a new
4
- agent. Offer another vendor only after an exact CopilotKit Markdown page names it. The
5
- page must name its credential variables and setup steps.
3
+ Preserve an existing Deep Agents language and model setup. For a new agent, use the vendor
4
+ that the framework step recorded. If it recorded none, use OpenAI. Offer another vendor
5
+ only after an exact CopilotKit Markdown page names it. The page must name its credential
6
+ variables and setup steps.
6
7
 
7
8
  Name the default model credential `OPENAI_API_KEY`.
8
9
 
@@ -33,7 +34,7 @@ Record the selected framework, language, vendor, model, required credential vari
33
34
  names, these URLs, and each documentation gap.
34
35
 
35
36
  If the pages support the selection, run
36
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
37
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
37
38
 
38
39
  If the documentation does not support the selection, run
39
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
40
+ `npx --prefer-offline --yes copilotkit@4.25.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 --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
33
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
34
34
 
35
35
  If the documentation does not support the selection, run
36
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
36
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -1,8 +1,11 @@
1
1
  # Configure LangGraph FastAPI
2
2
 
3
- Preserve an existing LangGraph FastAPI model setup. Start with OpenAI for a new agent.
4
- Offer another vendor only after an exact CopilotKit Markdown page names it. The page must
5
- name its credential variables and setup steps.
3
+ Preserve an existing LangGraph FastAPI model setup. For a new agent, use the vendor that
4
+ the framework step recorded. If it recorded none, use OpenAI. Offer another vendor only
5
+ after an exact CopilotKit Markdown page names it. The page must name its credential
6
+ variables and setup steps.
7
+
8
+ Name the default model credential `OPENAI_API_KEY`.
6
9
 
7
10
  ## Documentation
8
11
 
@@ -25,7 +28,7 @@ Record the selected framework, vendor, model, required credential variable names
25
28
  these URLs.
26
29
 
27
30
  If the pages support the selection, run
28
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
31
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
29
32
 
30
33
  If the documentation does not support the selection, run
31
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
34
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -1,8 +1,11 @@
1
1
  # Configure LangGraph Python
2
2
 
3
- Preserve an existing LangGraph Python model setup. Start with OpenAI for a new agent.
4
- Offer another vendor only after an exact CopilotKit Markdown page names it. The page must
5
- name its credential variables and setup steps.
3
+ Preserve an existing LangGraph Python model setup. For a new agent, use the vendor that
4
+ the framework step recorded. If it recorded none, use OpenAI. Offer another vendor only
5
+ after an exact CopilotKit Markdown page names it. The page must name its credential
6
+ variables and setup steps.
7
+
8
+ Name the default model credential `OPENAI_API_KEY`.
6
9
 
7
10
  ## Documentation
8
11
 
@@ -19,7 +22,7 @@ Record the selected framework, vendor, model, required credential variable names
19
22
  these URLs.
20
23
 
21
24
  If the pages support the selection, run
22
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
25
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
23
26
 
24
27
  If the documentation does not support the selection, run
25
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
28
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -1,8 +1,11 @@
1
1
  # Configure LangGraph TypeScript
2
2
 
3
- Preserve an existing LangGraph TypeScript model setup. Start with OpenAI for a new agent.
4
- Offer another vendor only after an exact CopilotKit Markdown page names it. The page must
5
- name its credential variables and setup steps.
3
+ Preserve an existing LangGraph TypeScript model setup. For a new agent, use the vendor
4
+ that the framework step recorded. If it recorded none, use OpenAI. Offer another vendor
5
+ only after an exact CopilotKit Markdown page names it. The page must name its credential
6
+ variables and setup steps.
7
+
8
+ Name the default model credential `OPENAI_API_KEY`.
6
9
 
7
10
  ## Documentation
8
11
 
@@ -19,7 +22,7 @@ Record the selected framework, vendor, model, required credential variable names
19
22
  these URLs.
20
23
 
21
24
  If the pages support the selection, run
22
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
25
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
23
26
 
24
27
  If the documentation does not support the selection, run
25
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
28
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -1,8 +1,9 @@
1
1
  # Configure LlamaIndex
2
2
 
3
- Preserve an existing LlamaIndex model setup. Start with OpenAI for a new agent. Offer
4
- another vendor only after an exact CopilotKit Markdown page names it. The page must name
5
- its credential variables and setup steps.
3
+ Preserve an existing LlamaIndex model setup. For a new agent, use the vendor that the
4
+ framework step recorded. If it recorded none, use OpenAI. Offer another vendor only after
5
+ an exact CopilotKit Markdown page names it. The page must name its credential variables
6
+ and setup steps.
6
7
 
7
8
  Name the default model credential `OPENAI_API_KEY`.
8
9
 
@@ -34,7 +35,7 @@ Record the selected framework, vendor, model, required credential variable names
34
35
  URLs, the documented dependencies and adapter, and both documentation limits.
35
36
 
36
37
  If the pages support the selection, run
37
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
38
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
38
39
 
39
40
  If the documentation does not support the selection, run
40
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
41
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -1,10 +1,13 @@
1
1
  # Configure Mastra
2
2
 
3
- Preserve an existing Mastra model setup. Start with OpenAI for a new agent. Offer
4
- another vendor only after an exact CopilotKit Markdown page names it. The page must name
5
- its credential variables and setup steps.
3
+ Preserve an existing Mastra model setup. For a new agent, use the vendor that the
4
+ framework step recorded. If it recorded none, use OpenAI. Offer another vendor only after
5
+ an exact CopilotKit Markdown page names it. The page must name its credential variables
6
+ and setup steps.
6
7
 
7
- Name the model credential `OPENAI_API_KEY`.
8
+ Name the default model credential `OPENAI_API_KEY`. For Anthropic, follow the
9
+ quickstart's steps to run the agent on Anthropic, and name the credential
10
+ `ANTHROPIC_API_KEY`.
8
11
 
9
12
  `mastra dev` loads the `.env` beside the project it serves and does not look in a
10
13
  parent directory. When one credential file serves more than one part of the repository,
@@ -47,7 +50,7 @@ Record the selected framework, vendor, model, required credential variable names
47
50
  these URLs.
48
51
 
49
52
  If the pages support the selection, run
50
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
53
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
51
54
 
52
55
  If the documentation does not support the selection, run
53
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
56
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -15,8 +15,16 @@ Run `dotnet --version` before you change the project. If it fails, no .NET SDK i
15
15
  shell's PATH. Do not change the project, and do not install the SDK yourself. Tell the
16
16
  developer to install the .NET SDK from https://dotnet.microsoft.com/download. Say that the
17
17
  coding agent's shell cannot see a new install until the developer restarts the coding
18
- agent. Give them `npx --prefer-offline --yes copilotkit@4.24.0 onboard start --run <onboarding_run_id>`
19
- to resume the run after the restart. Then end your turn and wait for the developer.
18
+ agent. Give them `npx --prefer-offline --yes copilotkit@4.25.0 onboard start --run <onboarding_run_id>`
19
+ to resume the run after the restart.
20
+
21
+ Before you end your turn to wait for the developer, report the pause:
22
+
23
+ ```text
24
+ npx --prefer-offline --yes copilotkit@4.25.0 onboard checkpoint --phase awaiting-developer
25
+ ```
26
+
27
+ Then end your turn and wait for the developer.
20
28
 
21
29
  ## Documentation
22
30
 
@@ -41,7 +49,7 @@ Record the selected framework, provider, model, required credential variable nam
41
49
  these URLs.
42
50
 
43
51
  If the pages support the selection, run
44
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
52
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
45
53
 
46
54
  If the documentation does not support the selection, run
47
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
55
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -9,8 +9,16 @@ you change the project. If it fails, no .NET SDK is on this shell's PATH. Do not
9
9
  the project, and do not install the SDK yourself. Tell the developer to install the .NET
10
10
  SDK from https://dotnet.microsoft.com/download. Say that the coding agent's shell cannot
11
11
  see a new install until the developer restarts the coding agent. Give them
12
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard start --run <onboarding_run_id>` to resume the run
13
- after the restart. Then end your turn and wait for the developer.
12
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard start --run <onboarding_run_id>` to resume the run
13
+ after the restart.
14
+
15
+ Before you end your turn to wait for the developer, report the pause:
16
+
17
+ ```text
18
+ npx --prefer-offline --yes copilotkit@4.25.0 onboard checkpoint --phase awaiting-developer
19
+ ```
20
+
21
+ Then end your turn and wait for the developer.
14
22
 
15
23
  ## Documentation
16
24
 
@@ -49,7 +57,7 @@ Record the selected framework, provider, model, required credential variable nam
49
57
  URLs, and the quickstart gap.
50
58
 
51
59
  If the pages support the selection, run
52
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
60
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
53
61
 
54
62
  If the documentation does not support the selection, run
55
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
63
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -1,8 +1,9 @@
1
1
  # Configure Microsoft Agent Framework for Python
2
2
 
3
- Preserve an existing Microsoft Agent Framework model setup. Start with OpenAI for a new
4
- agent. Offer another vendor only after an exact CopilotKit Markdown page names it. The
5
- page must name its credential variables and setup steps.
3
+ Preserve an existing Microsoft Agent Framework model setup. For a new agent, use the
4
+ vendor that the framework step recorded. If it recorded none, use OpenAI. Offer another
5
+ vendor only after an exact CopilotKit Markdown page names it. The page must name its
6
+ credential variables and setup steps.
6
7
 
7
8
  Name the model credential `OPENAI_API_KEY`, in `agent/.env`, for a new agent. This
8
9
  framework also accepts Azure OpenAI, through `AZURE_OPENAI_ENDPOINT` and
@@ -30,7 +31,7 @@ Record the selected framework, vendor, model, required credential variable names
30
31
  these URLs.
31
32
 
32
33
  If the pages support the selection, run
33
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
34
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
34
35
 
35
36
  If the documentation does not support the selection, run
36
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
37
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -1,8 +1,9 @@
1
1
  # Configure Pydantic AI
2
2
 
3
- Preserve an existing Pydantic AI model setup. Start with OpenAI for a new agent. Offer
4
- another vendor only after an exact CopilotKit Markdown page names it. The page must name
5
- its credential variables and setup steps.
3
+ Preserve an existing Pydantic AI model setup. For a new agent, use the vendor that the
4
+ framework step recorded. If it recorded none, use OpenAI. Offer another vendor only after
5
+ an exact CopilotKit Markdown page names it. The page must name its credential variables
6
+ and setup steps.
6
7
 
7
8
  Name the default model credential `OPENAI_API_KEY`.
8
9
 
@@ -43,7 +44,7 @@ Record the selected framework, vendor, model, required credential variable names
43
44
  URLs, and the two-step context route.
44
45
 
45
46
  If the pages support the selection, run
46
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
47
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
47
48
 
48
49
  If the documentation does not support the selection, run
49
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
50
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -1,10 +1,14 @@
1
1
  # Configure Strands Agents Python
2
2
 
3
- Preserve an existing Strands model setup. Start with OpenAI for a new agent. Offer another
4
- vendor only after an exact CopilotKit Markdown page names it. The page must name its
5
- credential variables and setup steps.
3
+ Preserve an existing Strands model setup. For a new agent, use the vendor that the
4
+ framework step recorded. If it recorded none, use OpenAI. Offer another vendor only after
5
+ an exact CopilotKit Markdown page names it. The page must name its credential variables
6
+ and setup steps.
6
7
 
7
- Name the default model credential `OPENAI_API_KEY`.
8
+ Name the default model credential `OPENAI_API_KEY`. For Anthropic, follow the
9
+ quickstart's "Using Anthropic instead" steps, and name the credential `ANTHROPIC_API_KEY`.
10
+ The dynamic A2UI tool still calls OpenAI, so a developer who later adds A2UI also needs
11
+ `OPENAI_API_KEY`.
8
12
 
9
13
  ## Documentation
10
14
 
@@ -29,7 +33,7 @@ Record the selected framework, vendor, model, required credential variable names
29
33
  URLs, and the context documentation gap.
30
34
 
31
35
  If the pages support the selection, run
32
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
36
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
33
37
 
34
38
  If the documentation does not support the selection, run
35
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
39
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -1,10 +1,14 @@
1
1
  # Configure Strands Agents TypeScript
2
2
 
3
- Preserve an existing Strands model setup. Start with OpenAI for a new agent. Offer another
4
- vendor only after an exact CopilotKit Markdown page names it. The page must name its
5
- credential variables and setup steps.
3
+ Preserve an existing Strands model setup. For a new agent, use the vendor that the
4
+ framework step recorded. If it recorded none, use OpenAI. Offer another vendor only after
5
+ an exact CopilotKit Markdown page names it. The page must name its credential variables
6
+ and setup steps.
6
7
 
7
- Name the default model credential `OPENAI_API_KEY`.
8
+ Name the default model credential `OPENAI_API_KEY`. For Anthropic, follow the
9
+ quickstart's "Using Anthropic instead" steps, and name the credential `ANTHROPIC_API_KEY`.
10
+ The dynamic A2UI tool still calls OpenAI, so a developer who later adds A2UI also needs
11
+ `OPENAI_API_KEY`.
8
12
 
9
13
  ## Documentation
10
14
 
@@ -30,7 +34,7 @@ Record the selected framework, vendor, model, required credential variable names
30
34
  URLs, and the context documentation gap.
31
35
 
32
36
  If the pages support the selection, run
33
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
37
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/plan`.
34
38
 
35
39
  If the documentation does not support the selection, run
36
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
40
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -2,10 +2,17 @@
2
2
 
3
3
  Preserve an existing Angular frontend. Use the selected page for a new frontend.
4
4
 
5
+ This step asks the developer nothing. If the run must wait for the developer anyway, report
6
+ the pause first:
7
+
8
+ ```text
9
+ npx --prefer-offline --yes copilotkit@4.25.0 onboard checkpoint --phase awaiting-developer
10
+ ```
11
+
5
12
  Use the starter shortcut only if all these facts are true: the target directory holds no
6
13
  project, its name is a valid `init` project name, and the selected framework is ADK.
7
14
  If all three facts are true, record Angular as the selected frontend. Then run
8
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read starter/clone` before you fetch documentation.
15
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read starter/clone` before you fetch documentation.
9
16
 
10
17
  ## Documentation
11
18
 
@@ -52,7 +59,7 @@ you create or build an Angular project. If the installed version is lower, selec
52
59
  supported version first and use it for every later command in this project.
53
60
 
54
61
  If the pages support the selection, record Angular and these URLs. Then run
55
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read credentials/finalize-plan`.
62
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read credentials/finalize-plan`.
56
63
 
57
64
  If the documentation does not support the selection, or the two version lines do not fit
58
- together, run `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
65
+ together, run `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -2,6 +2,13 @@
2
2
 
3
3
  Preserve an existing Next.js frontend. Use the selected pages for a new frontend.
4
4
 
5
+ This step asks the developer nothing. If the run must wait for the developer anyway, report
6
+ the pause first:
7
+
8
+ ```text
9
+ npx --prefer-offline --yes copilotkit@4.25.0 onboard checkpoint --phase awaiting-developer
10
+ ```
11
+
5
12
  Use the starter shortcut only if the target directory holds no project and its name is
6
13
  a valid `init` project name. The selected framework must also match one of these options.
7
14
 
@@ -15,7 +22,7 @@ These TypeScript options have starters: Claude Agent SDK TypeScript, LangGraph T
15
22
  Mastra, and Strands Agents TypeScript. The .NET option is Microsoft Agent Framework .NET.
16
23
 
17
24
  If all shortcut conditions are true, record Next.js as the selected frontend. Then run
18
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read starter/clone` before you fetch documentation.
25
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read starter/clone` before you fetch documentation.
19
26
 
20
27
  ## Documentation
21
28
 
@@ -39,8 +46,34 @@ developer's work.
39
46
  - For an existing frontend, do not change `next.config.ts` for this.
40
47
  - Do not claim, revert, or delete these files. Name them in the report as Next.js output.
41
48
 
49
+ ## Lockfile in a parent folder
50
+
51
+ Next.js 16 uses the highest folder with a lockfile as the workspace root. If a parent
52
+ folder holds a lockfile, Next.js takes that folder as the root. It then resolves packages
53
+ and traces output from the wrong folder. `next dev` and `next build` print this warning:
54
+
55
+ ```text
56
+ Warning: Next.js inferred your workspace root, but it may not be correct.
57
+ ```
58
+
59
+ If you see the warning, read the lockfile paths that it lists. If the parent folder is a
60
+ workspace that lists this app, do not set the root. Next.js chose the correct folder.
61
+ Otherwise, set the root to the app folder in `next.config.ts`:
62
+
63
+ ```ts
64
+ import { fileURLToPath } from 'node:url';
65
+
66
+ const nextConfig = {
67
+ turbopack: { root: fileURLToPath(new URL('.', import.meta.url)) },
68
+ };
69
+ ```
70
+
71
+ In a CommonJS `next.config.js`, use `turbopack: { root: __dirname }` instead. This value
72
+ also sets `outputFileTracingRoot`. Do not set `outputFileTracingRoot` to a
73
+ different folder. For an existing frontend, name this change in the report.
74
+
42
75
  If the page supports the selection, record Next.js and this URL. Then run
43
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read credentials/finalize-plan`.
76
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read credentials/finalize-plan`.
44
77
 
45
78
  If the documentation does not support the selection, run
46
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
79
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.
@@ -27,6 +27,12 @@ If the project has a frontend, preserve it and use the matching route below. If
27
27
  needs a frontend, show the valid choices and one recommendation based on repository
28
28
  evidence, then ask the developer to choose.
29
29
 
30
+ Before you end your turn to wait for the developer, report the pause:
31
+
32
+ ```text
33
+ npx --prefer-offline --yes copilotkit@4.25.0 onboard checkpoint --phase awaiting-developer
34
+ ```
35
+
30
36
  The valid choices are React SPA, Next.js, Angular, Vue 3, React Native, Slack, and
31
37
  Microsoft Teams. They are valid in every starting state. Route names are this graph's own
32
38
  bookkeeping. Say what the run is doing in the developer's words instead.
@@ -37,15 +43,15 @@ CopilotKit web apps. Then recommend the one the developer names, and say what ea
37
43
 
38
44
  Use exactly one matching internal route:
39
45
 
40
- 1. React SPA: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/react-spa`
41
- 2. Next.js: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/nextjs`
42
- 3. Angular: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/angular`
43
- 4. Vue 3: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/vue`
44
- 5. React Native: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/react-native`
45
- 6. Slack or Microsoft Teams: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read feature/channels/start`
46
+ 1. React SPA: `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/react-spa`
47
+ 2. Next.js: `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/nextjs`
48
+ 3. Angular: `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/angular`
49
+ 4. Vue 3: `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/vue`
50
+ 5. React Native: `npx --prefer-offline --yes copilotkit@4.25.0 onboard read frontend/react-native`
51
+ 6. Slack or Microsoft Teams: `npx --prefer-offline --yes copilotkit@4.25.0 onboard read feature/channels/start`
46
52
 
47
53
  If they chose Slack or Microsoft Teams, tell that node which one they chose so it
48
54
  does not ask again.
49
55
 
50
56
  If no listed frontend fits, run
51
- `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
57
+ `npx --prefer-offline --yes copilotkit@4.25.0 onboard read unsupported/no-validated-path`.