copilotkit 4.25.1 → 4.27.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 (92) hide show
  1. package/README.md +286 -35
  2. package/cli-build-info.json +8 -8
  3. package/index.js +7469 -3899
  4. package/onboarding/index.json +2 -2
  5. package/onboarding/prompts/authenticate/start.md +28 -23
  6. package/onboarding/prompts/conversion/plan.md +3 -3
  7. package/onboarding/prompts/credentials/finalize-plan.md +35 -26
  8. package/onboarding/prompts/credentials/plan.md +46 -33
  9. package/onboarding/prompts/credentials/settle-credentials.md +41 -16
  10. package/onboarding/prompts/credentials/write-plan.md +104 -47
  11. package/onboarding/prompts/deployment/choose-local.md +17 -20
  12. package/onboarding/prompts/deployment/local-evaluation.md +45 -21
  13. package/onboarding/prompts/fallback/best-effort.md +11 -9
  14. package/onboarding/prompts/feature/a2ui/implement.md +4 -4
  15. package/onboarding/prompts/feature/a2ui/plan.md +3 -3
  16. package/onboarding/prompts/feature/a2ui/proof.md +5 -5
  17. package/onboarding/prompts/feature/a2ui/start.md +10 -8
  18. package/onboarding/prompts/feature/channels/implement.md +11 -8
  19. package/onboarding/prompts/feature/channels/plan.md +15 -7
  20. package/onboarding/prompts/feature/channels/proof.md +5 -5
  21. package/onboarding/prompts/feature/channels/start.md +11 -10
  22. package/onboarding/prompts/feature/chat-suggestions/implement.md +4 -4
  23. package/onboarding/prompts/feature/chat-suggestions/plan.md +3 -3
  24. package/onboarding/prompts/feature/chat-suggestions/proof.md +5 -5
  25. package/onboarding/prompts/feature/chat-suggestions/start.md +10 -8
  26. package/onboarding/prompts/feature/complete.md +2 -2
  27. package/onboarding/prompts/feature/learning/implement.md +14 -12
  28. package/onboarding/prompts/feature/learning/plan.md +4 -4
  29. package/onboarding/prompts/feature/learning/proof.md +24 -14
  30. package/onboarding/prompts/feature/learning/start.md +8 -8
  31. package/onboarding/prompts/feature/open-generative-ui/implement.md +4 -4
  32. package/onboarding/prompts/feature/open-generative-ui/plan.md +3 -3
  33. package/onboarding/prompts/feature/open-generative-ui/proof.md +5 -5
  34. package/onboarding/prompts/feature/open-generative-ui/start.md +10 -8
  35. package/onboarding/prompts/feature/realtime-sync/implement.md +7 -5
  36. package/onboarding/prompts/feature/realtime-sync/plan.md +3 -3
  37. package/onboarding/prompts/feature/realtime-sync/proof.md +5 -5
  38. package/onboarding/prompts/feature/realtime-sync/start.md +7 -7
  39. package/onboarding/prompts/feature/rich-threads/implement.md +8 -6
  40. package/onboarding/prompts/feature/rich-threads/plan.md +3 -3
  41. package/onboarding/prompts/feature/rich-threads/proof.md +5 -5
  42. package/onboarding/prompts/feature/rich-threads/start.md +7 -7
  43. package/onboarding/prompts/feature/stop.md +4 -4
  44. package/onboarding/prompts/feature/voice/implement.md +4 -4
  45. package/onboarding/prompts/feature/voice/plan.md +4 -4
  46. package/onboarding/prompts/feature/voice/proof.md +5 -5
  47. package/onboarding/prompts/feature/voice/start.md +10 -8
  48. package/onboarding/prompts/framework/ag2.md +20 -5
  49. package/onboarding/prompts/framework/agno.md +25 -9
  50. package/onboarding/prompts/framework/built-in.md +21 -6
  51. package/onboarding/prompts/framework/claude-sdk-python.md +11 -5
  52. package/onboarding/prompts/framework/claude-sdk-typescript.md +13 -6
  53. package/onboarding/prompts/framework/crewai-flows.md +24 -10
  54. package/onboarding/prompts/framework/custom-ag-ui.md +62 -28
  55. package/onboarding/prompts/framework/deep-agents.md +26 -9
  56. package/onboarding/prompts/framework/google-adk.md +18 -5
  57. package/onboarding/prompts/framework/langgraph-fastapi.md +20 -5
  58. package/onboarding/prompts/framework/langgraph-python.md +20 -5
  59. package/onboarding/prompts/framework/langgraph-typescript.md +27 -7
  60. package/onboarding/prompts/framework/llamaindex.md +24 -8
  61. package/onboarding/prompts/framework/mastra.md +21 -8
  62. package/onboarding/prompts/framework/ms-agent-dotnet.md +24 -6
  63. package/onboarding/prompts/framework/ms-agent-harness-dotnet.md +24 -5
  64. package/onboarding/prompts/framework/ms-agent-python.md +21 -5
  65. package/onboarding/prompts/framework/pydantic-ai.md +20 -5
  66. package/onboarding/prompts/framework/strands-python.md +27 -12
  67. package/onboarding/prompts/framework/strands-typescript.md +27 -12
  68. package/onboarding/prompts/frontend/angular.md +4 -4
  69. package/onboarding/prompts/frontend/nextjs.md +4 -4
  70. package/onboarding/prompts/frontend/plan.md +21 -13
  71. package/onboarding/prompts/frontend/react-native.md +3 -3
  72. package/onboarding/prompts/frontend/react-spa.md +3 -3
  73. package/onboarding/prompts/frontend/vue.md +3 -3
  74. package/onboarding/prompts/implementation/build-and-validate.md +25 -20
  75. package/onboarding/prompts/proof/complete.md +10 -7
  76. package/onboarding/prompts/proof/oss-baseline.md +6 -6
  77. package/onboarding/prompts/proof/round-trip.md +10 -10
  78. package/onboarding/prompts/research/gather.md +8 -8
  79. package/onboarding/prompts/research/merge.md +3 -3
  80. package/onboarding/prompts/research/preflight.md +2 -2
  81. package/onboarding/prompts/research/route.md +4 -4
  82. package/onboarding/prompts/setup/questions.md +193 -158
  83. package/onboarding/prompts/starter/clone.md +129 -54
  84. package/onboarding/prompts/stopped/run-failed.md +5 -3
  85. package/onboarding/prompts/subagent/create-plan.md +80 -23
  86. package/onboarding/prompts/subagent/implement-and-validate.md +33 -14
  87. package/onboarding/prompts/subagent/inspect-repository.md +3 -2
  88. package/onboarding/prompts/subagent/prove-oss-baseline.md +10 -5
  89. package/onboarding/prompts/subagent/prove-round-trip.md +23 -14
  90. package/onboarding/prompts/unsupported/no-validated-path.md +5 -4
  91. package/package.json +1 -1
  92. package/release/release-tool.js +12 -2
@@ -9,7 +9,7 @@ implementation, and proof to separate subagents within the target project.
9
9
  Run this before anything else in this prompt:
10
10
 
11
11
  ```text
12
- npx --prefer-offline --yes copilotkit@4.25.1 onboard identify --coding-agent <coding-agent-slug> --model <model-id> --model-family <model-family>
12
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard identify --coding-agent <coding-agent-slug> --model <model-id> --model-family <model-family>
13
13
  ```
14
14
 
15
15
  Report your product slug, such as `codex` or `claude-code`. The command needs no sign-in,
@@ -38,13 +38,13 @@ carry on. Keep a read-only assignment read-only. If no subagent works at all, re
38
38
  once:
39
39
 
40
40
  ```text
41
- npx --prefer-offline --yes copilotkit@4.25.1 onboard checkpoint --phase delegation-unavailable
41
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard checkpoint --phase delegation-unavailable
42
42
  ```
43
43
 
44
44
  Before you end your turn to wait for the developer, report the pause:
45
45
 
46
46
  ```text
47
- npx --prefer-offline --yes copilotkit@4.25.1 onboard checkpoint --phase awaiting-developer
47
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard checkpoint --phase awaiting-developer
48
48
  ```
49
49
 
50
50
  A turn that ends while the run waits is a pause, not a stop, even when your harness ends it.
@@ -54,7 +54,7 @@ If you stop this run, send one short report before you stop. The friction comman
54
54
  the telemetry setting the developer already chose, so it needs no separate question.
55
55
 
56
56
  ```text
57
- npx --prefer-offline --yes copilotkit@4.25.1 onboard friction --phase stop --category <slug> --message "<sentences>"
57
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard friction --phase stop --category <slug> --message "<sentences>"
58
58
  ```
59
59
 
60
60
  `--message` takes one or two sentences: the step you stopped at and what stopped it.
@@ -76,20 +76,20 @@ the current frontend-to-runtime-to-agent round trip and inspect `/info`.
76
76
  Wait for the inspection subagent to finish. Then report that the inspection came back:
77
77
 
78
78
  ```text
79
- npx --prefer-offline --yes copilotkit@4.25.1 onboard checkpoint --phase research-returned
79
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard checkpoint --phase research-returned
80
80
  ```
81
81
 
82
82
  If the inspection did not prove the baseline this intent extends, stop here without
83
83
  changing files:
84
84
 
85
85
  ```text
86
- npx --prefer-offline --yes copilotkit@4.25.1 onboard read feature/stop
86
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard read feature/stop
87
87
  ```
88
88
 
89
89
  When the inspection proved what this intent needs, read the next prompt now, in this turn:
90
90
 
91
91
  ```text
92
- npx --prefer-offline --yes copilotkit@4.25.1 onboard read feature/rich-threads/plan
92
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard read feature/rich-threads/plan
93
93
  ```
94
94
 
95
95
  That prompt holds the plan, the developer's approval, and the paths the plan changes.
@@ -20,7 +20,7 @@ a `start` with no `--run` reprints the id this stopped run already holds, and on
20
20
  covering both reads as one run that did two different things.
21
21
 
22
22
  ```text
23
- npx --prefer-offline --yes copilotkit@4.25.1 onboard start --run <new-12-character-id>
23
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard start --run <new-12-character-id>
24
24
  ```
25
25
 
26
26
  Do not read a generic onboarding node from this run. A feature run and a generic run are
@@ -48,13 +48,13 @@ put to them, stop here and send the report below.
48
48
  Before you end your turn to wait for the developer, report the pause:
49
49
 
50
50
  ```text
51
- npx --prefer-offline --yes copilotkit@4.25.1 onboard checkpoint --phase awaiting-developer
51
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard checkpoint --phase awaiting-developer
52
52
  ```
53
53
 
54
54
  If they approve it, make that one fix and nothing else. Then come back into this run:
55
55
 
56
56
  ```text
57
- npx --prefer-offline --yes copilotkit@4.25.1 onboard resume --message "<approval>"
57
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard resume --message "<approval>"
58
58
  ```
59
59
 
60
60
  Put the developer's approval in `--message`, in one or two sentences: the fix they
@@ -75,7 +75,7 @@ Send one short report. The friction command follows the telemetry setting the de
75
75
  already chose, so it needs no separate question.
76
76
 
77
77
  ```text
78
- npx --prefer-offline --yes copilotkit@4.25.1 onboard friction --phase stop --category <slug> --message "<sentences>"
78
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard friction --phase stop --category <slug> --message "<sentences>"
79
79
  ```
80
80
 
81
81
  `--message` takes one or two sentences: the step you stopped at and what stopped it.
@@ -20,7 +20,7 @@ That result is a question for the developer. Name the file and why the work need
20
20
  Before you end your turn to wait for the developer, report the pause:
21
21
 
22
22
  ```text
23
- npx --prefer-offline --yes copilotkit@4.25.1 onboard checkpoint --phase awaiting-developer
23
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard checkpoint --phase awaiting-developer
24
24
  ```
25
25
 
26
26
  Then end your turn and wait for the developer's answer. If they allow it, spawn a fresh
@@ -30,16 +30,16 @@ cannot ask, or the developer declines, take the feature stop route below.
30
30
  If the CLI prints `## Stop: this run deleted or moved the developer's work` instead of
31
31
  a step, show the developer the list it printed, and run what they choose:
32
32
  the `onboard restore` command the tripwire stop prints, which names each deleted file, or
33
- `npx --prefer-offline --yes copilotkit@4.25.1 onboard tripwire --continue`. Then read the step again.
33
+ `npx --prefer-offline --yes copilotkit@4.27.0 onboard tripwire --continue`. Then read the step again.
34
34
 
35
35
  To route out and stop:
36
36
 
37
37
  ```text
38
- npx --prefer-offline --yes copilotkit@4.25.1 onboard read feature/stop
38
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard read feature/stop
39
39
  ```
40
40
 
41
41
  If validation cannot pass, or this intent needs a prerequisite the app does not have, use
42
42
  the feature stop route above without further changes.
43
43
 
44
44
  Otherwise run
45
- `npx --prefer-offline --yes copilotkit@4.25.1 onboard read feature/voice/proof`.
45
+ `npx --prefer-offline --yes copilotkit@4.27.0 onboard read feature/voice/proof`.
@@ -12,7 +12,7 @@ The approval is a wait for the developer. Before you end your turn to wait, repo
12
12
  pause:
13
13
 
14
14
  ```text
15
- npx --prefer-offline --yes copilotkit@4.25.1 onboard checkpoint --phase awaiting-developer
15
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard checkpoint --phase awaiting-developer
16
16
  ```
17
17
 
18
18
  A turn that ends while the run waits is a pause, not a stop, even when your harness ends it.
@@ -42,7 +42,7 @@ the repository proves its variable name is configured. Otherwise, explain the se
42
42
  take the feature stop route rather than writing a placeholder:
43
43
 
44
44
  ```text
45
- npx --prefer-offline --yes copilotkit@4.25.1 onboard read feature/stop
45
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard read feature/stop
46
46
  ```
47
47
 
48
48
  Show a small plan for the documented transcription service, the existing composer, focused
@@ -51,7 +51,7 @@ tests, and a microphone/canned-transcript proof. Ask for approval as its own que
51
51
  Before you end your turn to wait for the developer, report the pause:
52
52
 
53
53
  ```text
54
- npx --prefer-offline --yes copilotkit@4.25.1 onboard checkpoint --phase awaiting-plan-approval
54
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard checkpoint --phase awaiting-plan-approval
55
55
  ```
56
56
 
57
57
  Ask the developer before you edit a file that has uncommitted changes. List those files in
@@ -59,4 +59,4 @@ the plan under `Uncommitted files`, each with one sentence explaining why, or wr
59
59
  `git status` names them. The CLI records no consent: the approved plan is the record. The
60
60
  plan must not delete, move, or rename one of those files.
61
61
 
62
- Then run `npx --prefer-offline --yes copilotkit@4.25.1 onboard read feature/voice/implement`.
62
+ Then run `npx --prefer-offline --yes copilotkit@4.27.0 onboard read feature/voice/implement`.
@@ -19,7 +19,7 @@ That result is a question for the developer. Name the file and why the fix needs
19
19
  Before you end your turn to wait for the developer, report the pause:
20
20
 
21
21
  ```text
22
- npx --prefer-offline --yes copilotkit@4.25.1 onboard checkpoint --phase awaiting-developer
22
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard checkpoint --phase awaiting-developer
23
23
  ```
24
24
 
25
25
  Then end your turn and wait for the developer's answer. If they allow it, spawn a fresh
@@ -29,13 +29,13 @@ or the developer declines, take the feature stop route below.
29
29
  If the CLI prints `## Stop: this run deleted or moved the developer's work` instead of
30
30
  a step, show the developer the list it printed, and run what they choose:
31
31
  the `onboard restore` command the tripwire stop prints, which names each deleted file, or
32
- `npx --prefer-offline --yes copilotkit@4.25.1 onboard tripwire --continue`. Then read the step again.
32
+ `npx --prefer-offline --yes copilotkit@4.27.0 onboard tripwire --continue`. Then read the step again.
33
33
 
34
34
  Report the outcome of each attempt as it ends, before any repair. The command counts the
35
35
  attempts and the repairs:
36
36
 
37
37
  ```text
38
- npx --prefer-offline --yes copilotkit@4.25.1 onboard proof --step round-trip --outcome <passed|failed|skipped>
38
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard proof --step round-trip --outcome <passed|failed|skipped>
39
39
  ```
40
40
 
41
41
  Use `passed` only for proved voice input, `failed` for an attempted proof that failed, and
@@ -44,9 +44,9 @@ Use `passed` only for proved voice input, `failed` for an attempted proof that f
44
44
  To route out and stop:
45
45
 
46
46
  ```text
47
- npx --prefer-offline --yes copilotkit@4.25.1 onboard read feature/stop
47
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard read feature/stop
48
48
  ```
49
49
 
50
50
  When the proof is recorded, run
51
- `npx --prefer-offline --yes copilotkit@4.25.1 onboard read feature/complete` with the actual surface
51
+ `npx --prefer-offline --yes copilotkit@4.27.0 onboard read feature/complete` with the actual surface
52
52
  outcome.
@@ -8,7 +8,7 @@ read-only, implementation, and proof subagents, each restricted to the target pr
8
8
  Run this before anything else in this prompt:
9
9
 
10
10
  ```text
11
- npx --prefer-offline --yes copilotkit@4.25.1 onboard identify --coding-agent <coding-agent-slug> --model <model-id> --model-family <model-family>
11
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard identify --coding-agent <coding-agent-slug> --model <model-id> --model-family <model-family>
12
12
  ```
13
13
 
14
14
  Report your product slug, such as `codex` or `claude-code`. The command needs no sign-in,
@@ -37,13 +37,13 @@ carry on. Keep a read-only assignment read-only. If no subagent works at all, re
37
37
  once:
38
38
 
39
39
  ```text
40
- npx --prefer-offline --yes copilotkit@4.25.1 onboard checkpoint --phase delegation-unavailable
40
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard checkpoint --phase delegation-unavailable
41
41
  ```
42
42
 
43
43
  Before you end your turn to wait for the developer, report the pause:
44
44
 
45
45
  ```text
46
- npx --prefer-offline --yes copilotkit@4.25.1 onboard checkpoint --phase awaiting-developer
46
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard checkpoint --phase awaiting-developer
47
47
  ```
48
48
 
49
49
  A turn that ends while the run waits is a pause, not a stop, even when your harness ends it.
@@ -53,7 +53,7 @@ If you stop this run, send one short report before you stop. The friction comman
53
53
  the telemetry setting the developer already chose, so it needs no separate question.
54
54
 
55
55
  ```text
56
- npx --prefer-offline --yes copilotkit@4.25.1 onboard friction --phase stop --category <slug> --message "<sentences>"
56
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard friction --phase stop --category <slug> --message "<sentences>"
57
57
  ```
58
58
 
59
59
  `--message` takes one or two sentences: the step you stopped at and what stopped it.
@@ -70,26 +70,28 @@ before a subagent or a project process runs.
70
70
  Before edits, inspect the runtime route, CopilotKit provider/chat composer, current agent,
71
71
  existing provider credential variable names (presence only), package versions, browser
72
72
  permissions approach, and test/dev commands. Prove the existing OSS baseline with `/info`,
73
- `npx --prefer-offline --yes copilotkit@4.25.1 verify --expect-runtime oss --round-trip --agent <agent-id> --json`,
73
+ `npx --prefer-offline --yes copilotkit@4.27.0 verify --expect-runtime oss --round-trip --agent <agent-id> --json`,
74
74
  and a real UI request when a browser is available.
75
+ The `verify` report names the runtime URL it probed. If the dev server serves the
76
+ runtime at another URL, add `--runtime-url <url>`.
75
77
 
76
78
  Wait for the inspection subagent to finish. Then report that the inspection came back:
77
79
 
78
80
  ```text
79
- npx --prefer-offline --yes copilotkit@4.25.1 onboard checkpoint --phase research-returned
81
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard checkpoint --phase research-returned
80
82
  ```
81
83
 
82
84
  If the inspection did not prove the baseline this intent extends, stop here without
83
85
  changing files:
84
86
 
85
87
  ```text
86
- npx --prefer-offline --yes copilotkit@4.25.1 onboard read feature/stop
88
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard read feature/stop
87
89
  ```
88
90
 
89
91
  When the inspection proved what this intent needs, read the next prompt now, in this turn:
90
92
 
91
93
  ```text
92
- npx --prefer-offline --yes copilotkit@4.25.1 onboard read feature/voice/plan
94
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard read feature/voice/plan
93
95
  ```
94
96
 
95
97
  That prompt holds the plan, the developer's approval, and the paths the plan changes.
@@ -1,9 +1,24 @@
1
1
  # Configure AG2
2
2
 
3
+ First run `npx --prefer-offline --yes copilotkit@4.27.0 onboard setup-answers`. Its `vendor` is the
4
+ vendor the framework step recorded, even after this conversation lost it, with
5
+ `vendor.baseUrl` and `vendor.modelId` for an OpenAI-compatible provider.
6
+
3
7
  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.
8
+ step recorded. Use OpenAI only when the record and this conversation have no vendor. This
9
+ release offers a new agent on this framework OpenAI or an OpenAI-compatible provider only.
10
+ For a new agent, if the developer names Anthropic or Google, say that this release
11
+ supports OpenAI or an OpenAI-compatible provider on this framework, that Anthropic and
12
+ Google come in a later release, and offer the built-in CopilotKit agent if they need
13
+ Anthropic or Google now. An existing agent keeps its vendor and model. If it runs on
14
+ Anthropic or Google, add one line to the plan: the page context that CopilotKit sends can
15
+ fail with that vendor until a CopilotKit SDK release fixes it (PE-728). Take that vendor's
16
+ package, class, and credential variable names from the framework's own documentation, and
17
+ use a model id that the vendor serves to a new key today. For an OpenAI-compatible
18
+ provider, keep `OPENAI_API_KEY`, use the model id that `setup/questions` recorded, and
19
+ write the base URL that `setup/questions` recorded as `OPENAI_BASE_URL` in the app's env
20
+ file. The key can stay in its own file. Where the framework does not read that variable,
21
+ also pass it in code. Take every CopilotKit step from the pages below.
7
22
 
8
23
  Name the default model credential `OPENAI_API_KEY`.
9
24
 
@@ -32,7 +47,7 @@ Record the selected framework, vendor, model, required credential variable names
32
47
  URLs, and the A2UI documentation gap.
33
48
 
34
49
  If the pages support the selection, run
35
- `npx --prefer-offline --yes copilotkit@4.25.1 onboard read frontend/plan`.
50
+ `npx --prefer-offline --yes copilotkit@4.27.0 onboard read frontend/plan`.
36
51
 
37
52
  If the documentation does not support the selection, run
38
- `npx --prefer-offline --yes copilotkit@4.25.1 onboard read unsupported/no-validated-path`.
53
+ `npx --prefer-offline --yes copilotkit@4.27.0 onboard read unsupported/no-validated-path`.
@@ -1,9 +1,24 @@
1
1
  # Configure Agno
2
2
 
3
+ First run `npx --prefer-offline --yes copilotkit@4.27.0 onboard setup-answers`. Its `vendor` is the
4
+ vendor the framework step recorded, even after this conversation lost it, with
5
+ `vendor.baseUrl` and `vendor.modelId` for an OpenAI-compatible provider.
6
+
3
7
  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.
8
+ step recorded. Use OpenAI only when the record and this conversation have no vendor. This
9
+ release offers a new agent on this framework OpenAI or an OpenAI-compatible provider only.
10
+ For a new agent, if the developer names Anthropic or Google, say that this release
11
+ supports OpenAI or an OpenAI-compatible provider on this framework, that Anthropic and
12
+ Google come in a later release, and offer the built-in CopilotKit agent if they need
13
+ Anthropic or Google now. An existing agent keeps its vendor and model. If it runs on
14
+ Anthropic or Google, add one line to the plan: the page context that CopilotKit sends can
15
+ fail with that vendor until a CopilotKit SDK release fixes it (PE-728). Take that vendor's
16
+ package, class, and credential variable names from the framework's own documentation, and
17
+ use a model id that the vendor serves to a new key today. For an OpenAI-compatible
18
+ provider, keep `OPENAI_API_KEY`, use the model id that `setup/questions` recorded, and
19
+ write the base URL that `setup/questions` recorded as `OPENAI_BASE_URL` in the app's env
20
+ file. The key can stay in its own file. Where the framework does not read that variable,
21
+ also pass it in code. Take every CopilotKit step from the pages below.
7
22
 
8
23
  Name the default model credential `OPENAI_API_KEY`.
9
24
 
@@ -23,19 +38,20 @@ new agent. For a new agent, install the documented Python dependencies
23
38
  `@ag-ui/agno` targets `/agui`. Do not replace that adapter with a generic agent or change
24
39
  the endpoint without repository evidence.
25
40
 
26
- The agent-readonly page does not bundle its Agno backend context setup. Do not invent it.
27
- If the requested work passes project data to the agent and the project does not already have that
28
- setup, run the unsupported route below. Otherwise, record the gap and continue.
41
+ The agent receives `useAgentContext` entries on the AG-UI run input, in its `context`
42
+ field, as https://docs.copilotkit.ai/agent-app-context.md shows. If the requested work
43
+ passes project data to the agent, read `context` in the agent with this framework's own
44
+ API, and pass it to the model. Name that code in the plan.
29
45
 
30
46
  A2UI is not on this path. If the developer asks for it, say first that its page has no Agno
31
47
  backend schema-loading, render-operations, or runtime setup snippet, so there is nothing to
32
48
  follow for the backend half.
33
49
 
34
50
  Record the selected framework, vendor, model, required credential variable names, these
35
- URLs, the documented dependencies and adapter, and the context documentation gap.
51
+ URLs, the documented dependencies and adapter, and how the agent reads `context`.
36
52
 
37
53
  If the pages support the selection, run
38
- `npx --prefer-offline --yes copilotkit@4.25.1 onboard read frontend/plan`.
54
+ `npx --prefer-offline --yes copilotkit@4.27.0 onboard read frontend/plan`.
39
55
 
40
56
  If the documentation does not support the selection, run
41
- `npx --prefer-offline --yes copilotkit@4.25.1 onboard read unsupported/no-validated-path`.
57
+ `npx --prefer-offline --yes copilotkit@4.27.0 onboard read unsupported/no-validated-path`.
@@ -1,13 +1,28 @@
1
1
  # Configure the built-in CopilotKit agent
2
2
 
3
+ First run `npx --prefer-offline --yes copilotkit@4.27.0 onboard setup-answers`. Its `vendor` is the
4
+ vendor the framework step recorded, even after this conversation lost it, with
5
+ `vendor.baseUrl` and `vendor.modelId` for an OpenAI-compatible provider.
6
+
3
7
  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.
8
+ framework step recorded. Use OpenAI only when the record and this conversation have no
9
+ vendor. OpenAI, an OpenAI-compatible provider, Anthropic, and Google work. Take that
10
+ vendor's package, class, and credential variable names from the framework's own
11
+ documentation, and use a model id that the vendor serves to a new key today. For an
12
+ OpenAI-compatible provider, keep `OPENAI_API_KEY`, use the model id that `setup/questions`
13
+ recorded, and write the base URL that `setup/questions` recorded as `OPENAI_BASE_URL` in
14
+ the app's env file. The key can stay in its own file. Where the framework does not read
15
+ that variable, also pass it in code. Take every CopilotKit step from the pages below.
7
16
 
8
17
  Name the default model credential `OPENAI_API_KEY`. For Anthropic, name it
9
18
  `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.
19
+ chosen vendor, in the `provider:model` form, from the model selection page. For a new
20
+ agent, write that id to the app's env file as `COPILOTKIT_AGENT_MODEL`, and pass
21
+ `process.env.COPILOTKIT_AGENT_MODEL` as the `BuiltInAgent` `model`, with the same id as
22
+ the fallback when the variable is unset. The credential step then checks the app's own
23
+ model. For a model id that holds a `/`, such as an OpenRouter id, write the
24
+ `provider/model` form: `openai/meta-llama/llama-3.3-70b`. The runtime reads the first `/`
25
+ as the separator, so the `provider:` form breaks that id.
11
26
 
12
27
  The built-in agent runs in the CopilotKit Runtime process.
13
28
  Do not create or start a separate agent server.
@@ -32,7 +47,7 @@ Record the selected framework, vendor, model, required credential variable names
32
47
  these URLs.
33
48
 
34
49
  If the pages support the selection, run
35
- `npx --prefer-offline --yes copilotkit@4.25.1 onboard read frontend/plan`.
50
+ `npx --prefer-offline --yes copilotkit@4.27.0 onboard read frontend/plan`.
36
51
 
37
52
  If the documentation does not support the selection, run
38
- `npx --prefer-offline --yes copilotkit@4.25.1 onboard read unsupported/no-validated-path`.
53
+ `npx --prefer-offline --yes copilotkit@4.27.0 onboard read unsupported/no-validated-path`.
@@ -1,8 +1,14 @@
1
1
  # Configure Claude Agent SDK for Python
2
2
 
3
- Preserve an existing Claude Agent SDK model setup. Start with Anthropic 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
+ First run `npx --prefer-offline --yes copilotkit@4.27.0 onboard setup-answers`. Its `vendor` is the
4
+ vendor the framework step recorded, even after this conversation lost it.
5
+
6
+ Preserve an existing Claude Agent SDK model setup. The Claude Agent SDK runs only
7
+ Anthropic: the starter logs and ignores any other provider, and then runs Anthropic with no
8
+ key. Offer no other vendor. For a new agent, use Anthropic when the record holds it, and
9
+ only when the record and this conversation have no vendor. If the record holds another
10
+ vendor, use Anthropic and name that change in the plan. Take every CopilotKit step from the
11
+ pages below.
6
12
 
7
13
  Name the model credential `ANTHROPIC_API_KEY`. The documented model variable is
8
14
  `ANTHROPIC_MODEL`.
@@ -34,7 +40,7 @@ Record the selected framework, vendor, model, required credential variable names
34
40
  these URLs.
35
41
 
36
42
  If the pages support the selection, run
37
- `npx --prefer-offline --yes copilotkit@4.25.1 onboard read frontend/plan`.
43
+ `npx --prefer-offline --yes copilotkit@4.27.0 onboard read frontend/plan`.
38
44
 
39
45
  If the documentation does not support the selection, run
40
- `npx --prefer-offline --yes copilotkit@4.25.1 onboard read unsupported/no-validated-path`.
46
+ `npx --prefer-offline --yes copilotkit@4.27.0 onboard read unsupported/no-validated-path`.
@@ -1,8 +1,14 @@
1
1
  # Configure Claude Agent SDK for TypeScript
2
2
 
3
- Preserve an existing Claude Agent SDK model setup. Start with Anthropic 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
+ First run `npx --prefer-offline --yes copilotkit@4.27.0 onboard setup-answers`. Its `vendor` is the
4
+ vendor the framework step recorded, even after this conversation lost it.
5
+
6
+ Preserve an existing Claude Agent SDK model setup. The Claude Agent SDK runs only
7
+ Anthropic: the starter logs and ignores any other provider, and then runs Anthropic with no
8
+ key. Offer no other vendor. For a new agent, use Anthropic when the record holds it, and
9
+ only when the record and this conversation have no vendor. If the record holds another
10
+ vendor, use Anthropic and name that change in the plan. Take every CopilotKit step from the
11
+ pages below.
6
12
 
7
13
  Name the model credential `ANTHROPIC_API_KEY`. The documented model variable is
8
14
  `CLAUDE_MODEL`.
@@ -31,13 +37,14 @@ The adapter appends AG-UI `input.context` entries to the Claude system prompt. P
31
37
  backend path with the frontend hook from the reference page. Treat this as read-only app
32
38
  context. It does not provide an agent-to-frontend write-back path. Inspect the installed,
33
39
  pinned adapter source before using this path. If the package no longer handles
34
- `input.context`, run the unsupported route below.
40
+ `input.context`, append those entries to the system prompt in the agent code, and name
41
+ that change in the plan.
35
42
 
36
43
  Record the selected framework, vendor, model, required credential variable names, these
37
44
  URLs, and the context limit.
38
45
 
39
46
  If the pages support the selection, run
40
- `npx --prefer-offline --yes copilotkit@4.25.1 onboard read frontend/plan`.
47
+ `npx --prefer-offline --yes copilotkit@4.27.0 onboard read frontend/plan`.
41
48
 
42
49
  If the documentation does not support the selection, run
43
- `npx --prefer-offline --yes copilotkit@4.25.1 onboard read unsupported/no-validated-path`.
50
+ `npx --prefer-offline --yes copilotkit@4.27.0 onboard read unsupported/no-validated-path`.
@@ -1,5 +1,8 @@
1
1
  # Configure CrewAI Flows
2
2
 
3
+ First run `npx --prefer-offline --yes copilotkit@4.27.0 onboard setup-answers`. When it holds a `vendor`,
4
+ the developer already chose it: keep it, and do not ask the vendor question below.
5
+
3
6
  Preserve the project's existing CrewAI Flow, provider, model, and deployment. The selected
4
7
  pages do not name a default model vendor or model credential variable. Do not choose a
5
8
  vendor or credential name for the developer.
@@ -11,23 +14,34 @@ starter, tell the developer that the starter decides the vendor. If the frontend
11
14
  sends you to its Documentation section instead, ask the vendor question below at that
12
15
  point, before the plan.
13
16
 
17
+ This release offers a new agent on CrewAI Flows OpenAI or an OpenAI-compatible provider
18
+ only. When the run chooses the vendor, if the developer names Anthropic or Google, say
19
+ that this release supports OpenAI or an OpenAI-compatible provider on this framework, that
20
+ Anthropic and Google come in a later release, and offer the built-in CopilotKit agent if
21
+ they need Anthropic or Google now. An existing agent keeps its vendor and model. If it
22
+ runs on Anthropic or Google, add one line to the plan: the page context that CopilotKit
23
+ sends can fail with that vendor until a CopilotKit SDK release fixes it (PE-728).
24
+
14
25
  When the repository shows a provider, keep it and ask nothing further about it. When
15
26
  neither the repository nor these pages show one, the developer decides, so ask. Ask one
16
- short question: which model vendor the CrewAI Flow will call. Say that the CopilotKit
17
- CrewAI pages name no vendor, so this release makes no recommendation here and will not
18
- pick one. If the developer names a vendor and no variable name, propose the variable name
19
- that vendor's own client reads and ask them to confirm it. A proposal the developer
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.
27
+ short question: OpenAI or an OpenAI-compatible provider, and for the latter its base URL
28
+ and model id. Say that the CopilotKit CrewAI pages name no vendor, so this release makes no
29
+ recommendation here. If the developer names a vendor and no variable name, propose the
30
+ variable name that vendor's own client reads and ask them to confirm it. A proposal the
31
+ developer confirms is theirs. Ask for a variable name, never the value it holds. Do not
32
+ combine this with a frontend, project, or risky-change question.
22
33
 
23
34
  Before you end your turn to wait for the developer, report the pause:
24
35
 
25
36
  ```text
26
- npx --prefer-offline --yes copilotkit@4.25.1 onboard checkpoint --phase awaiting-developer
37
+ npx --prefer-offline --yes copilotkit@4.27.0 onboard checkpoint --phase awaiting-developer
27
38
  ```
28
39
 
29
40
  When the developer answers, record the answer as the project-defined provider, model, and
30
- credential variable name, and continue.
41
+ credential variable name. Record the vendor in the CLI with
42
+ `npx --prefer-offline --yes copilotkit@4.27.0 onboard setup-answers --vendor <vendor> --vendor-choice developer`,
43
+ with `openai` or `openai-compatible`, and `--base-url <url> --model-id <id>` for the
44
+ latter. Then continue.
31
45
 
32
46
  A vendor nobody has chosen yet is not a missing supported path. This release supports
33
47
  CrewAI Flows. Do not run the unsupported route below because the project defines no
@@ -70,7 +84,7 @@ Record the selected framework, project-defined provider and model, the credentia
70
84
  variable names the repository proves or the developer named, these URLs, and the adapter.
71
85
 
72
86
  If the pages support the selection, run
73
- `npx --prefer-offline --yes copilotkit@4.25.1 onboard read frontend/plan`.
87
+ `npx --prefer-offline --yes copilotkit@4.27.0 onboard read frontend/plan`.
74
88
 
75
89
  If the documentation does not support the selection, run
76
- `npx --prefer-offline --yes copilotkit@4.25.1 onboard read unsupported/no-validated-path`.
90
+ `npx --prefer-offline --yes copilotkit@4.27.0 onboard read unsupported/no-validated-path`.