copilotkit 4.23.0 → 4.24.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 (94) hide show
  1. package/README.md +91 -5
  2. package/cli-build-info.json +8 -8
  3. package/exporters/langgraph/README.md +33 -0
  4. package/exporters/langgraph/export_checkpointer.py +16 -0
  5. package/index.js +4384 -3590
  6. package/onboarding/index.json +2 -1
  7. package/onboarding/prompts/authenticate/start.md +15 -12
  8. package/onboarding/prompts/conversion/plan.md +3 -3
  9. package/onboarding/prompts/credentials/finalize-plan.md +8 -8
  10. package/onboarding/prompts/credentials/plan.md +23 -23
  11. package/onboarding/prompts/credentials/settle-credentials.md +14 -5
  12. package/onboarding/prompts/credentials/write-plan.md +6 -6
  13. package/onboarding/prompts/deployment/choose-local.md +24 -13
  14. package/onboarding/prompts/deployment/local-evaluation.md +31 -7
  15. package/onboarding/prompts/fallback/best-effort.md +8 -8
  16. package/onboarding/prompts/feature/a2ui/implement.md +6 -6
  17. package/onboarding/prompts/feature/a2ui/plan.md +4 -4
  18. package/onboarding/prompts/feature/a2ui/proof.md +5 -5
  19. package/onboarding/prompts/feature/a2ui/start.md +25 -8
  20. package/onboarding/prompts/feature/channels/implement.md +7 -7
  21. package/onboarding/prompts/feature/channels/plan.md +4 -4
  22. package/onboarding/prompts/feature/channels/proof.md +5 -5
  23. package/onboarding/prompts/feature/channels/start.md +23 -19
  24. package/onboarding/prompts/feature/chat-suggestions/implement.md +6 -6
  25. package/onboarding/prompts/feature/chat-suggestions/plan.md +4 -4
  26. package/onboarding/prompts/feature/chat-suggestions/proof.md +5 -5
  27. package/onboarding/prompts/feature/chat-suggestions/start.md +25 -8
  28. package/onboarding/prompts/feature/complete.md +2 -2
  29. package/onboarding/prompts/feature/learning/implement.md +13 -13
  30. package/onboarding/prompts/feature/learning/plan.md +4 -4
  31. package/onboarding/prompts/feature/learning/proof.md +49 -6
  32. package/onboarding/prompts/feature/learning/start.md +25 -8
  33. package/onboarding/prompts/feature/open-generative-ui/implement.md +6 -6
  34. package/onboarding/prompts/feature/open-generative-ui/plan.md +4 -4
  35. package/onboarding/prompts/feature/open-generative-ui/proof.md +5 -5
  36. package/onboarding/prompts/feature/open-generative-ui/start.md +25 -8
  37. package/onboarding/prompts/feature/realtime-sync/implement.md +7 -7
  38. package/onboarding/prompts/feature/realtime-sync/plan.md +4 -4
  39. package/onboarding/prompts/feature/realtime-sync/proof.md +5 -5
  40. package/onboarding/prompts/feature/realtime-sync/start.md +24 -7
  41. package/onboarding/prompts/feature/rich-threads/implement.md +8 -8
  42. package/onboarding/prompts/feature/rich-threads/plan.md +4 -4
  43. package/onboarding/prompts/feature/rich-threads/proof.md +5 -5
  44. package/onboarding/prompts/feature/rich-threads/start.md +24 -7
  45. package/onboarding/prompts/feature/stop.md +3 -3
  46. package/onboarding/prompts/feature/voice/implement.md +6 -6
  47. package/onboarding/prompts/feature/voice/plan.md +5 -5
  48. package/onboarding/prompts/feature/voice/proof.md +5 -5
  49. package/onboarding/prompts/feature/voice/start.md +25 -8
  50. package/onboarding/prompts/framework/ag2.md +2 -2
  51. package/onboarding/prompts/framework/agno.md +2 -2
  52. package/onboarding/prompts/framework/built-in.md +2 -2
  53. package/onboarding/prompts/framework/claude-sdk-python.md +2 -2
  54. package/onboarding/prompts/framework/claude-sdk-typescript.md +2 -2
  55. package/onboarding/prompts/framework/crewai-flows.md +2 -2
  56. package/onboarding/prompts/framework/custom-ag-ui.md +2 -2
  57. package/onboarding/prompts/framework/deep-agents.md +2 -2
  58. package/onboarding/prompts/framework/google-adk.md +2 -2
  59. package/onboarding/prompts/framework/langgraph-fastapi.md +2 -2
  60. package/onboarding/prompts/framework/langgraph-python.md +2 -2
  61. package/onboarding/prompts/framework/langgraph-typescript.md +2 -2
  62. package/onboarding/prompts/framework/llamaindex.md +2 -2
  63. package/onboarding/prompts/framework/mastra.md +2 -2
  64. package/onboarding/prompts/framework/ms-agent-dotnet.md +3 -3
  65. package/onboarding/prompts/framework/ms-agent-harness-dotnet.md +3 -3
  66. package/onboarding/prompts/framework/ms-agent-python.md +2 -2
  67. package/onboarding/prompts/framework/pydantic-ai.md +2 -2
  68. package/onboarding/prompts/framework/strands-python.md +2 -2
  69. package/onboarding/prompts/framework/strands-typescript.md +2 -2
  70. package/onboarding/prompts/frontend/angular.md +3 -3
  71. package/onboarding/prompts/frontend/nextjs.md +3 -3
  72. package/onboarding/prompts/frontend/plan.md +7 -7
  73. package/onboarding/prompts/frontend/react-native.md +2 -2
  74. package/onboarding/prompts/frontend/react-spa.md +2 -2
  75. package/onboarding/prompts/frontend/vue.md +2 -2
  76. package/onboarding/prompts/implementation/build-and-validate.md +16 -14
  77. package/onboarding/prompts/proof/complete.md +3 -3
  78. package/onboarding/prompts/proof/oss-baseline.md +5 -5
  79. package/onboarding/prompts/proof/round-trip.md +8 -8
  80. package/onboarding/prompts/research/gather.md +5 -5
  81. package/onboarding/prompts/research/merge.md +2 -2
  82. package/onboarding/prompts/research/preflight.md +2 -2
  83. package/onboarding/prompts/research/route.md +5 -5
  84. package/onboarding/prompts/starter/clone.md +92 -7
  85. package/onboarding/prompts/stopped/run-failed.md +2 -2
  86. package/onboarding/prompts/subagent/create-plan.md +2 -2
  87. package/onboarding/prompts/subagent/implement-and-validate.md +2 -2
  88. package/onboarding/prompts/subagent/inspect-repository.md +1 -1
  89. package/onboarding/prompts/subagent/prove-oss-baseline.md +1 -1
  90. package/onboarding/prompts/subagent/prove-round-trip.md +8 -6
  91. package/onboarding/prompts/unsupported/no-validated-path.md +2 -2
  92. package/package.json +1 -1
  93. package/release/release-tool.js +12 -1
  94. package/services/local-auth-worker.js +175 -159
@@ -1,5 +1,5 @@
1
1
  {
2
- "graphTree": "a92d5d4a1d73d583df5be10af020eeee9dc84ca9",
2
+ "graphTree": "29dcb290ab507cc1cc9d3f7263f9c39eafe4607b",
3
3
  "intentRoots": {
4
4
  "add-a2ui": "feature/a2ui/start",
5
5
  "add-chat-suggestions": "feature/chat-suggestions/start",
@@ -9,6 +9,7 @@
9
9
  "add-rich-threads": "feature/rich-threads/start",
10
10
  "add-voice": "feature/voice/start"
11
11
  },
12
+ "packageSpec": "copilotkit@4.24.0",
12
13
  "root": "authenticate/start",
13
14
  "prompts": [
14
15
  {
@@ -14,7 +14,7 @@ does is hidden from the developer.
14
14
 
15
15
  Run each CLI call exactly as written, as its own command: no pipe, `tee`, `&&`, redirect,
16
16
  or variable prefix. Every CLI call in this run matches the prefix rule
17
- `["npx", "--prefer-offline", "--yes", "copilotkit@4.23.0"]`. If a command can request
17
+ `["npx", "--prefer-offline", "--yes", "copilotkit@4.24.0"]`. If a command can request
18
18
  escalation with a prefix rule, request this one on the `onboard identify` call. If your
19
19
  harness asks the developer to approve commands, tell them one approval of that prefix covers
20
20
  every CLI call. Say then that the install, the dev servers, `curl` to the local app, and
@@ -33,7 +33,7 @@ That refusal is a pause, not a stop.
33
33
  Run this before anything else in this prompt, including the welcome message below:
34
34
 
35
35
  ```text
36
- npx --prefer-offline --yes copilotkit@4.23.0 onboard identify --coding-agent <coding-agent-slug> --model <model-id> --model-family <model-family>
36
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard identify --coding-agent <coding-agent-slug> --model <model-id> --model-family <model-family>
37
37
  ```
38
38
 
39
39
  Report your product slug, such as `codex` or `claude-code`.
@@ -60,10 +60,10 @@ the whole run. Every later command reports against it.
60
60
 
61
61
  Every later command must run from the directory this run started in. Elsewhere, the
62
62
  command cannot find its run and refuses. Do not report that refusal as a stop. Run
63
- `npx --prefer-offline --yes copilotkit@4.23.0 onboard start --run <onboarding_run_id>` where you are
63
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard start --run <onboarding_run_id>` where you are
64
64
  standing, then run the refused command again.
65
65
 
66
- If you no longer hold the id, run `npx --prefer-offline --yes copilotkit@4.23.0 onboard start` in the
66
+ If you no longer hold the id, run `npx --prefer-offline --yes copilotkit@4.24.0 onboard start` in the
67
67
  directory this run started in, with no `--run` and no `--intent`. It reprints the id of the
68
68
  run under way and starts nothing. An id this project does not already hold starts a second
69
69
  run, and the work already done stops counting toward the first.
@@ -120,7 +120,7 @@ A turn that ends while the run waits is a pause, not a stop, even when your harn
120
120
  A terminal that sends the report itself, or says to file none, overrides this.
121
121
 
122
122
  ```text
123
- npx --prefer-offline --yes copilotkit@4.23.0 onboard friction --phase stop --category <slug> --message "<sentences>"
123
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard friction --phase stop --category <slug> --message "<sentences>"
124
124
  ```
125
125
 
126
126
  `--message` takes one or two sentences: the step you stopped at and what stopped it.
@@ -135,18 +135,21 @@ rule that stopped you says next: send the report, then stop.
135
135
 
136
136
  ## Choose where the app stores data
137
137
 
138
- Before sign-in, run `npx --prefer-offline --yes copilotkit@4.23.0 local --help`.
139
- If it lists candidate setup and no choice exists, offer managed service or local Docker
140
- evaluation. If it does not, keep the managed path. Existing local recovery still works.
138
+ Before sign-in, run `npx --prefer-offline --yes copilotkit@4.24.0 local --help`.
139
+ If it lists `setup` ("Configure model access and install or resume the local stack") and no
140
+ choice exists, offer managed or local Docker evaluation. Otherwise keep managed. Existing
141
+ local recovery still works.
142
+ Record the path with
143
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard deployment --choice <managed|local>`.
141
144
 
142
145
  For a local choice, run
143
- `npx --prefer-offline --yes copilotkit@4.23.0 onboard read deployment/choose-local`.
146
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard read deployment/choose-local`.
144
147
  It records the choice for new and existing apps, completes sign-in, and starts research.
145
148
  For managed service, continue with “Check sign-in”.
146
149
 
147
150
  ## Check sign-in
148
151
 
149
- Run `npx --prefer-offline --yes copilotkit@4.23.0 login --json` before any project work. This command
152
+ Run `npx --prefer-offline --yes copilotkit@4.24.0 login --json` before any project work. This command
150
153
  checks the current session. It starts sign-in only as needed. Treat this as a long-lived
151
154
  streaming process. Do not wait for the command to exit before you read its standard output.
152
155
 
@@ -191,9 +194,9 @@ conversation.
191
194
 
192
195
  Research reads only this project and needs no account. Start it as soon as the session is
193
196
  valid or the developer has the sign-in page, and keep monitoring the login process while it
194
- runs: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read research/gather`. If this run already
197
+ runs: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read research/gather`. If this run already
195
198
  started the research, do not start it again.
196
199
 
197
200
  If sign-in stops onboarding, run
198
- `npx --prefer-offline --yes copilotkit@4.23.0 onboard read stopped/run-failed`. It says nothing about
201
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard read stopped/run-failed`. It says nothing about
199
202
  whether this project's stack is supported, which is not yet known at this point.
@@ -100,7 +100,7 @@ of this journey, and a drawer that lists nothing is not a reason to mint one. Li
100
100
  tokens stay a self-hosted concern.
101
101
 
102
102
  Where this journey's frontend framework ships no threads drawer -- React Native --, the
103
- fifth item is proved by `npx --prefer-offline --yes copilotkit@4.23.0 verify --round-trip`, which sends a
103
+ fifth item is proved by `npx --prefer-offline --yes copilotkit@4.24.0 verify --round-trip`, which sends a
104
104
  real request and reads the answer back off the thread it landed on. The run says which of
105
105
  the two it proved. Do not send a run to the managed Intelligence dashboard to prove this.
106
106
  An authenticated browser session at a hosted dashboard is the one thing an agent-driven run
@@ -116,7 +116,7 @@ and passed -- so a run scored on either one was scored on the same fact. Every r
116
116
  resolves that condition from, while `licenseStatus` is a compatibility projection of it
117
117
  for older thread surfaces and outlives them only until those surfaces go.
118
118
 
119
- Then run `npx --prefer-offline --yes copilotkit@4.23.0 onboard read credentials/finalize-plan`.
119
+ Then run `npx --prefer-offline --yes copilotkit@4.24.0 onboard read credentials/finalize-plan`.
120
120
 
121
121
  If a selected page does not load after the second method, run
122
- `npx --prefer-offline --yes copilotkit@4.23.0 onboard read unsupported/no-validated-path`.
122
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
@@ -1,7 +1,7 @@
1
1
  # Select the Intelligence project
2
2
 
3
3
  For a recorded local choice, run
4
- `npx --prefer-offline --yes copilotkit@4.23.0 onboard read deployment/local-evaluation`.
4
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard read deployment/local-evaluation`.
5
5
  That path obtains approval and connects the local project. Skip hosted selection.
6
6
  Keep the implementation and feature-proof requirements.
7
7
 
@@ -29,7 +29,7 @@ Choose the starting state from the repository findings:
29
29
  A run served `proof/oss-baseline` records one of the last two.
30
30
 
31
31
  ```text
32
- npx --prefer-offline --yes copilotkit@4.23.0 onboard classify --starting-state <starting-state> --agent-framework <agent-framework> --frontend <frontend>
32
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard classify --starting-state <starting-state> --agent-framework <agent-framework> --frontend <frontend>
33
33
  ```
34
34
 
35
35
  If a value is refused, fix it from the choices the earlier prompts gave, and run the
@@ -42,7 +42,7 @@ runtime `.env` file, that directory is the target, not the repository root. Do n
42
42
  the developer to another terminal.
43
43
 
44
44
  ```text
45
- npx --prefer-offline --yes copilotkit@4.23.0 onboard credentials --json
45
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard credentials --json
46
46
  ```
47
47
 
48
48
  Every credential this run writes goes to the target's `.env`, the environment path. The
@@ -72,9 +72,9 @@ project from a listing without an answer that names it.
72
72
  `--runtime-url` is the URL port research settled, mount path included:
73
73
 
74
74
  ```text
75
- npx --prefer-offline --yes copilotkit@4.23.0 onboard credentials --create <name> \
75
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard credentials --create <name> \
76
76
  --runtime-url http://localhost:<port>/api/copilotkit --json
77
- npx --prefer-offline --yes copilotkit@4.23.0 onboard credentials --project <slug-or-id> \
77
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard credentials --project <slug-or-id> \
78
78
  --runtime-url http://localhost:<port>/api/copilotkit --json
79
79
  ```
80
80
 
@@ -84,8 +84,8 @@ command unless the developer asks to see their projects, or `notFound` is presen
84
84
  show only what they asked for, and do not order it by creation time:
85
85
 
86
86
  ```text
87
- npx --prefer-offline --yes copilotkit@4.23.0 project list --json
88
- npx --prefer-offline --yes copilotkit@4.23.0 project list --search <query> --json
87
+ npx --prefer-offline --yes copilotkit@4.24.0 project list --json
88
+ npx --prefer-offline --yes copilotkit@4.24.0 project list --search <query> --json
89
89
  ```
90
90
 
91
91
  `app-directory` means that the key landed where no app reads it. Pick the directory in
@@ -100,4 +100,4 @@ the `--project` command from there with `project.slug`. Do not copy or link the
100
100
  reused. The round-trip proof later runs the authenticated Intelligence checks, so record
101
101
  the reused project credentials as unverified in the plan until those checks pass.
102
102
 
103
- Then run `npx --prefer-offline --yes copilotkit@4.23.0 onboard read credentials/settle-credentials`.
103
+ Then run `npx --prefer-offline --yes copilotkit@4.24.0 onboard read credentials/settle-credentials`.
@@ -20,7 +20,7 @@ If the target directory holds no project and the copied prompt came from the Sla
20
20
  Microsoft Teams docs page, do not ask the framework question. The Channel starter brings
21
21
  its own agent, so an answer here decides nothing. Tell the developer that the Channel
22
22
  starter decides the agent, then run
23
- `npx --prefer-offline --yes copilotkit@4.23.0 onboard read frontend/plan`.
23
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard read frontend/plan`.
24
24
 
25
25
  ## Frameworks this machine cannot run yet
26
26
 
@@ -42,7 +42,7 @@ things in one message:
42
42
  2. That the coding agent's shell reads PATH when it starts, so it cannot see the new
43
43
  toolchain until the developer restarts the coding agent.
44
44
  3. That the run resumes after the restart with
45
- `npx --prefer-offline --yes copilotkit@4.23.0 onboard start --run <onboarding_run_id>`.
45
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard start --run <onboarding_run_id>`.
46
46
 
47
47
  Then end your turn and wait for the developer. That restart is a step here, not an error.
48
48
 
@@ -111,27 +111,27 @@ developer's words instead.
111
111
 
112
112
  Use exactly one matching internal route:
113
113
 
114
- 1. AG2: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/ag2`
115
- 2. Agno: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/agno`
116
- 3. Built-in CopilotKit agent: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/built-in`
117
- 4. Claude Agent SDK Python: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/claude-sdk-python`
118
- 5. Claude Agent SDK TypeScript: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/claude-sdk-typescript`
119
- 6. CrewAI Flows: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/crewai-flows`
120
- 7. Existing AG-UI agent: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/custom-ag-ui`
121
- 8. Deep Agents: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/deep-agents`
122
- 9. LangGraph Python: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/langgraph-python`
123
- 10. LangGraph FastAPI: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/langgraph-fastapi`
124
- 11. LangGraph TypeScript: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/langgraph-typescript`
125
- 12. LlamaIndex: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/llamaindex`
126
- 13. ADK: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/google-adk`
127
- 14. Microsoft Agent Framework Python: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/ms-agent-python`
128
- 15. Microsoft Agent Framework .NET: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/ms-agent-dotnet`
129
- 16. Mastra: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/mastra`
130
- 17. MS Agent Harness .NET: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/ms-agent-harness-dotnet`
131
- 18. Pydantic AI: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/pydantic-ai`
132
- 19. Strands Agents Python: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/strands-python`
133
- 20. Strands Agents TypeScript: `npx --prefer-offline --yes copilotkit@4.23.0 onboard read framework/strands-typescript`
114
+ 1. AG2: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/ag2`
115
+ 2. Agno: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/agno`
116
+ 3. Built-in CopilotKit agent: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/built-in`
117
+ 4. Claude Agent SDK Python: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/claude-sdk-python`
118
+ 5. Claude Agent SDK TypeScript: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/claude-sdk-typescript`
119
+ 6. CrewAI Flows: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/crewai-flows`
120
+ 7. Existing AG-UI agent: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/custom-ag-ui`
121
+ 8. Deep Agents: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/deep-agents`
122
+ 9. LangGraph Python: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/langgraph-python`
123
+ 10. LangGraph FastAPI: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/langgraph-fastapi`
124
+ 11. LangGraph TypeScript: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/langgraph-typescript`
125
+ 12. LlamaIndex: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/llamaindex`
126
+ 13. ADK: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/google-adk`
127
+ 14. Microsoft Agent Framework Python: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/ms-agent-python`
128
+ 15. Microsoft Agent Framework .NET: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/ms-agent-dotnet`
129
+ 16. Mastra: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/mastra`
130
+ 17. MS Agent Harness .NET: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/ms-agent-harness-dotnet`
131
+ 18. Pydantic AI: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/pydantic-ai`
132
+ 19. Strands Agents Python: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/strands-python`
133
+ 20. Strands Agents TypeScript: `npx --prefer-offline --yes copilotkit@4.24.0 onboard read framework/strands-typescript`
134
134
 
135
135
  If the project has an agent in another framework that does not speak AG-UI, or no
136
136
  listed framework fits, keep the developer's current agent and run
137
- `npx --prefer-offline --yes copilotkit@4.23.0 onboard read unsupported/no-validated-path`.
137
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
@@ -21,7 +21,7 @@ The plan names the model credential variables. Run this from the directory that
21
21
  `environmentPath` in the project step's result, with one `--model-key` for each variable:
22
22
 
23
23
  ```text
24
- npx --prefer-offline --yes copilotkit@4.23.0 onboard credentials --model-key <variable> --json
24
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard credentials --model-key <variable> --json
25
25
  ```
26
26
 
27
27
  When the framework node names another env file for the credential, add
@@ -38,9 +38,18 @@ never prints a value. When every key settles, it protects the credential paths.
38
38
  itself. By default, plan to copy the key into the app's env file, which git ignores.
39
39
  This command protects that env file, and the copy is a file the run writes itself, so
40
40
  list the copy under `Files the run writes itself`, not under `Authorization requested`.
41
- The developer's approval of the plan is their consent to the copy. Copy the key without
42
- printing it. Then record the copy with
43
- `npx --prefer-offline --yes copilotkit@4.23.0 onboard protect --accept-credential --path <env file>`. If the developer declines the copy, the plan has the app read the key from an
41
+ The developer's approval of the plan is their consent to the copy. After the approval,
42
+ copy the key with the command that `next` names. It has this form:
43
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard credentials --model-key <variable> --env-path <file> --copy-to <env file> --json`.
44
+ It writes the key without printing it and protects the env file. Do not copy the key
45
+ yourself, and do not write a `sed`, `grep`, or `cat` command for it. If you cannot run
46
+ the command, for example because a sandbox refuses the path, ask the developer to run it.
47
+ Give them exactly this one line, with `<app directory>` as the directory that holds
48
+ `environmentPath`:
49
+ `! cd <app directory> && npx --prefer-offline --yes copilotkit@4.24.0 onboard credentials --model-key <variable> --env-path <file> --copy-to <env file>`.
50
+ The command needs no input. Without `!`, they run the same command in a terminal.
51
+ When they reply, run the same command with `--json` and read `copiedKeys`.
52
+ If the developer declines the copy, the plan has the app read the key from an
44
53
  environment variable that the developer sets. The plan then says how to set it. Never
45
54
  write the outside path into a project file, not even in a config file such as
46
55
  `langgraph.json`. A committed file that names a folder in the developer's home directory
@@ -69,4 +78,4 @@ Never read a file outside the project directory to find a credential: a key foun
69
78
  bills another project. Asking for a path is not requesting a secret. A path the developer
70
79
  names is theirs to give, including one outside the project. A path this run finds is not.
71
80
 
72
- Then run `npx --prefer-offline --yes copilotkit@4.23.0 onboard read credentials/write-plan`.
81
+ Then run `npx --prefer-offline --yes copilotkit@4.24.0 onboard read credentials/write-plan`.
@@ -11,7 +11,7 @@ friction command follows the telemetry setting the developer already chose, so i
11
11
  separate question.
12
12
 
13
13
  ```text
14
- npx --prefer-offline --yes copilotkit@4.23.0 onboard friction --phase stop --category <slug> --message "<sentences>"
14
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard friction --phase stop --category <slug> --message "<sentences>"
15
15
  ```
16
16
 
17
17
  `--message` takes one or two sentences: the step you stopped at and what stopped it.
@@ -72,7 +72,7 @@ page is selected yet, add the one for the frontend selected above to the same li
72
72
  Native, so the planner proves the thread with `verify --round-trip` instead.
73
73
 
74
74
  Spawn one planning subagent. Tell it to run
75
- `npx --prefer-offline --yes copilotkit@4.23.0 onboard read subagent/create-plan` first and follow the prompt
75
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard read subagent/create-plan` first and follow the prompt
76
76
  it returns. If that read fails because the subagent cannot use the shell, stop that subagent.
77
77
  Run the same command yourself, then spawn a fresh subagent with the returned prompt and the
78
78
  same handoff. Give it the repository findings, selected framework, frontend, model, credential
@@ -86,7 +86,7 @@ Wait for the subagent to finish.
86
86
  Continue only if the planning result starts with `Status: passed`. For `Status: failed`,
87
87
  send the result back to the planning subagent for repair, up to three attempts. For
88
88
  `Status: blocked`, or a third failed result, run
89
- `npx --prefer-offline --yes copilotkit@4.23.0 onboard read stopped/run-failed`. A plan this run cannot
89
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard read stopped/run-failed`. A plan this run cannot
90
90
  write is a run that broke, not a stack the documentation does not cover. The exception is
91
91
  a blocked result that names `unsupported/no-validated-path`: the planning subagent found
92
92
  that no page supports the plan, so take the no-supported-path route at the end of this
@@ -132,11 +132,11 @@ Before you end your turn to wait for the answer, report the pause, each time you
132
132
  plan:
133
133
 
134
134
  ```text
135
- npx --prefer-offline --yes copilotkit@4.23.0 onboard checkpoint --phase awaiting-plan-approval
135
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard checkpoint --phase awaiting-plan-approval
136
136
  ```
137
137
 
138
138
  If the developer approves the plan, run
139
- `npx --prefer-offline --yes copilotkit@4.23.0 onboard read implementation/build-and-validate`.
139
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard read implementation/build-and-validate`.
140
140
 
141
141
  If no exact supported path or documentation URL exists, run
142
- `npx --prefer-offline --yes copilotkit@4.23.0 onboard read unsupported/no-validated-path`.
142
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard read unsupported/no-validated-path`.
@@ -16,31 +16,42 @@ Explain these conditions before sign-in:
16
16
  separate settings, or remain configuration incomplete until settings are supplied.
17
17
  - Slack and Teams need internet access and a developer-provided public HTTPS endpoint.
18
18
 
19
- Collect a path to the published candidate manifest. There is no selected default.
20
- Do not substitute an arbitrary chart tag or a checkout build. If no manifest exists,
21
- report that candidate publication is needed and take the failure path below.
19
+ The CLI selects the latest stable release by itself. Do not ask for a release or a
20
+ candidate manifest. If the developer gives a candidate manifest path for release
21
+ testing, record it for setup. Do not substitute a chart tag or a checkout build.
22
22
  Never ask the developer to paste credentials into the conversation.
23
23
 
24
- Collect the model choice. For reuse, have the developer place their compatible app
25
- model settings in a private JSON file with `model`, `provider`, and any needed
26
- `baseUrl` and `apiKey` fields. Use that file with `--model-config`. Separate settings
27
- use the same private file format. Deferral uses `--defer-model`.
28
-
29
- Record the candidate path and model choice in the plan, but no secret values.
24
+ Collect the model choice for Learning. The first proof does not need a Learning model,
25
+ and Learning starts its first run only after 15 conversations. Offer these choices:
26
+
27
+ 1. Configure later, the default. Install with `--defer-model`. In the closing report, write
28
+ "Learning configuration incomplete". Name the command that adds the model later:
29
+ `npx --prefer-offline --yes copilotkit@4.24.0 local setup`, run in a terminal in the app directory.
30
+ 2. Guided setup. If the developer named Learning as a goal, offer it first. Install
31
+ the stack with `--defer-model`. After the stack is ready, the developer runs
32
+ `npx --prefer-offline --yes copilotkit@4.24.0 local setup` in their own terminal window, in the app
33
+ directory. Never give it as a `!` line: its guided prompt needs a terminal, and a coding
34
+ agent's shell has none. The prompt asks for the model and its key, and it saves them
35
+ privately. On a running stack, it restarts only Learning. Do not ask the developer to
36
+ write a file.
37
+ 3. A private model file that the developer has already. Pass its path with
38
+ `--model-config <file>`. Do not read or print the file.
39
+
40
+ Record the model choice, and any candidate path, in the plan, but no secret values.
30
41
  Create no cluster and change no app files at this step. The developer can still decline sign-in.
31
42
  If declined, take the failure path below.
32
43
 
33
- Run `npx --prefer-offline --yes copilotkit@4.23.0 login --json`. Follow the streaming sign-in
44
+ Run `npx --prefer-offline --yes copilotkit@4.24.0 login --json`. Follow the streaming sign-in
34
45
  protocol from “Check sign-in” in the start prompt: open the first authentication URL
35
46
  once, keep the same process running, and continue only after its completed record.
36
47
  Explain that this sign-in obtains the evaluation license, not the local dashboard login.
37
48
  On failed or declined sign-in, take the failure path below.
38
49
 
39
50
  After sign-in completes, continue with
40
- `npx --prefer-offline --yes copilotkit@4.23.0 onboard read research/gather`.
51
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard read research/gather`.
41
52
  Keep the local choice and collected paths in the run's plan and worker context.
42
53
 
43
54
  ## Failure path
44
55
 
45
- If the candidate is missing or sign-in fails or is declined, stop before cluster creation.
46
- Run `npx --prefer-offline --yes copilotkit@4.23.0 onboard read stopped/run-failed`.
56
+ If sign-in fails or is declined, stop before cluster creation.
57
+ Run `npx --prefer-offline --yes copilotkit@4.24.0 onboard read stopped/run-failed`.
@@ -24,24 +24,28 @@ does not authorize replacing an existing app's connection.
24
24
 
25
25
  ## Run the shared installer
26
26
 
27
- From the exact app directory, use the collected candidate and model choice:
27
+ From the exact app directory, use the collected model choice:
28
28
 
29
29
  ```text
30
- npx --prefer-offline --yes copilotkit@4.23.0 local setup --candidate <manifest.json> --defer-model --json
30
+ npx --prefer-offline --yes copilotkit@4.24.0 local setup --defer-model --json
31
31
  ```
32
32
 
33
33
  For supplied model access, replace `--defer-model` with `--model-config <private-file>`.
34
+ The CLI selects the latest stable release. Add `--candidate <manifest.json>` only when the
35
+ developer gave a candidate manifest for release testing.
34
36
  Do not print or read the model file into the conversation. Do not install or manage Docker.
35
37
  The CLI supplies its pinned Helm and k3d tools and checks the available Docker budget.
36
38
 
37
- On a retry, run `local setup --json` with no new candidate. It uses saved inputs.
39
+ On a retry, run the same command with the same model flag, `--defer-model` or
40
+ `--model-config <private-file>`, and no new candidate. Setup resumes from its saved inputs.
41
+ A Docker failure stops setup before it saves any input, so the model flag is required.
38
42
  Read blockers and the recorded failed step. Do not delete or recreate a failed stack.
39
43
  A copied app needs explicit `--share-stack`. Do not infer sharing from a copied reference.
40
44
 
41
45
  After setup reports the stack ready, run the approved connection step from that directory:
42
46
 
43
47
  ```text
44
- npx --prefer-offline --yes copilotkit@4.23.0 local connect --approve-connection --json
48
+ npx --prefer-offline --yes copilotkit@4.24.0 local connect --approve-connection --json
45
49
  ```
46
50
 
47
51
  Read the local `.copilotkit/project.json` for its project ID and slug. Do not run hosted
@@ -55,8 +59,28 @@ Use the existing Threads round-trip proof against this local project. Verify a r
55
59
  message, reply, and saved conversation. Installation readiness alone is not that proof.
56
60
 
57
61
  Learning needs valid model settings for this installation. A previous local installation
58
- proves nothing about these settings. If deferred, report “Learning configuration
59
- incomplete.” No Learning run is required to finish onboarding configuration.
62
+ proves nothing about these settings. If the developer chose guided setup, wait until the
63
+ stack is ready. Then:
64
+
65
+ Ask the developer to run this command in their own terminal window, in the app directory:
66
+
67
+ ```text
68
+ npx --prefer-offline --yes copilotkit@4.24.0 local setup
69
+ ```
70
+
71
+ Do not give it as a `!` line, and do not run it yourself. Its guided model prompt needs a
72
+ terminal, and a coding agent's shell has none. Without a terminal, the command stops and
73
+ changes nothing. The prompt asks for the model and its key, and it saves them privately.
74
+ On a running stack, it restarts only Learning. Do not ask for a model file.
75
+
76
+ Say that the run continues when they reply or resume this session. Report the pause with
77
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard checkpoint --phase awaiting-model-credential`, end your
78
+ turn, and wait. When the developer replies, run
79
+ `npx --prefer-offline --yes copilotkit@4.24.0 local status --json` and read `learning.configuration`.
80
+
81
+ If the model is still missing or was deferred, report “Learning configuration incomplete”
82
+ and name the same command, run in a terminal window. No Learning run is required to finish
83
+ onboarding configuration.
60
84
 
61
85
  Channels remain incomplete until the existing proof observes a useful reply to a real mention.
62
86
  Use the existing approved HTTPS tunnel instructions when inbound traffic needs a public URL.
@@ -66,6 +90,6 @@ must not block Threads, the dashboard, or later Learning configuration.
66
90
  If the developer cancels the connection, run `local cancel --json` from the app directory.
67
91
  Report conflict names only. Keep the stack unless deletion is separately confirmed.
68
92
 
69
- Continue with `npx --prefer-offline --yes copilotkit@4.23.0 onboard read credentials/settle-credentials`.
93
+ Continue with `npx --prefer-offline --yes copilotkit@4.24.0 onboard read credentials/settle-credentials`.
70
94
  For this local route, skip the hosted selection-result checks and use the local project
71
95
  record. Continue the existing implementation and proof paths against local endpoints.
@@ -16,7 +16,7 @@ you stop. The friction command follows the telemetry setting the developer alrea
16
16
  so it needs no separate question.
17
17
 
18
18
  ```text
19
- npx --prefer-offline --yes copilotkit@4.23.0 onboard friction --phase stop --category <slug> --message "<sentences>"
19
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard friction --phase stop --category <slug> --message "<sentences>"
20
20
  ```
21
21
 
22
22
  `--message` takes one or two sentences: the step you stopped at and what stopped it.
@@ -62,19 +62,19 @@ or frontend, stop onboarding.
62
62
 
63
63
  Use these rules for every protected-path check in this fallback:
64
64
 
65
- - Run `npx --prefer-offline --yes copilotkit@4.23.0 onboard audit` from the target app directory.
65
+ - Run `npx --prefer-offline --yes copilotkit@4.24.0 onboard audit` from the target app directory.
66
66
  - If a result starts with `Status: blocked`, stop onboarding and report the printed reason.
67
67
  It proved nothing changed, so do not report a preservation failure.
68
68
  - If a result reports a changed protected path this run wrote, stop onboarding.
69
69
  - If a result reports a changed env file, this rule replaces the one above, even when this
70
70
  run wrote the file. This run asked the developer to place a
71
71
  credential there, so take the credential route rather than the external one. Accept it
72
- with `npx --prefer-offline --yes copilotkit@4.23.0 onboard protect --accept-credential --path <path>`,
72
+ with `npx --prefer-offline --yes copilotkit@4.24.0 onboard protect --accept-credential --path <path>`,
73
73
  run the audit again, and name it in the closing report. If the command refuses because
74
74
  it names a lost variable, stop onboarding.
75
75
  - Before any proof subagent runs, a changed path that no Files changed section from this
76
76
  run names came from outside the run. Accept it by name with
77
- `npx --prefer-offline --yes copilotkit@4.23.0 onboard protect --accept-external --path <path>`, run the
77
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard protect --accept-external --path <path>`, run the
78
78
  audit again, and name it in the closing report.
79
79
  - After a proof subagent runs, a changed path that no Files changed section from this run
80
80
  names is unsettled rather than outside the run, because the proof subagent here returns
@@ -133,16 +133,16 @@ that the selected documentation proved an inferred step.
133
133
  Record what the proof returned before you complete:
134
134
 
135
135
  ```text
136
- npx --prefer-offline --yes copilotkit@4.23.0 onboard proof --step round-trip --outcome <passed|failed|skipped>
136
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard proof --step round-trip --outcome <passed|failed|skipped>
137
137
  ```
138
138
 
139
- When the proof is complete, run `npx --prefer-offline --yes copilotkit@4.23.0 onboard complete`, carrying the
139
+ When the proof is complete, run `npx --prefer-offline --yes copilotkit@4.24.0 onboard complete`, carrying the
140
140
  surface-check result the proof subagent returned. Pass exactly one of `--visual-check` or
141
141
  `--device-check`, matching this journey's surface:
142
142
 
143
143
  ```text
144
- npx --prefer-offline --yes copilotkit@4.23.0 onboard complete --visual-check <outcome>
145
- npx --prefer-offline --yes copilotkit@4.23.0 onboard complete --device-check <outcome>
144
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard complete --visual-check <outcome>
145
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard complete --device-check <outcome>
146
146
  ```
147
147
 
148
148
  `--visual-check` is for a web frontend and takes `performed`, `skipped-no-browser-tool`, or
@@ -18,7 +18,7 @@ without exposing secrets.
18
18
  Before you spawn the implementation subagent, take the authorized list from the CLI:
19
19
 
20
20
  ```text
21
- npx --prefer-offline --yes copilotkit@4.23.0 onboard audit
21
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard audit
22
22
  ```
23
23
 
24
24
  From its result, copy the paths under `Authorized to modify:`. A passed or failed audit with
@@ -37,7 +37,7 @@ still go on the record. Name the file and why the work needs it, then end your t
37
37
  for the developer's answer. If they allow it, record their answer before any edit:
38
38
 
39
39
  ```text
40
- npx --prefer-offline --yes copilotkit@4.23.0 onboard protect --authorize --unplanned --path <path> --reason "<what the developer said>"
40
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard protect --authorize --unplanned --path <path> --reason "<what the developer said>"
41
41
  ```
42
42
 
43
43
  Continue only when the result starts with `Status: passed`. Run the audit again, take the
@@ -49,7 +49,7 @@ feature stop route below.
49
49
  After validation and each repair, run:
50
50
 
51
51
  ```text
52
- npx --prefer-offline --yes copilotkit@4.23.0 onboard audit
52
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard audit
53
53
  ```
54
54
 
55
55
  Continue only when it starts with `Status: passed`. A path under `Authorized to modify:` is
@@ -60,7 +60,7 @@ with the implementation subagent's `Files changed` section. If that section does
60
60
  the path, accept the developer's external change:
61
61
 
62
62
  ```text
63
- npx --prefer-offline --yes copilotkit@4.23.0 onboard protect --accept-external --path <path>
63
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard protect --accept-external --path <path>
64
64
  ```
65
65
 
66
66
  For an env file where the developer placed a requested credential, use
@@ -73,11 +73,11 @@ Run the audit again after each accepted change. If it still fails, or starts
73
73
  with `Status: blocked`, route out and stop:
74
74
 
75
75
  ```text
76
- npx --prefer-offline --yes copilotkit@4.23.0 onboard read feature/stop
76
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard read feature/stop
77
77
  ```
78
78
 
79
79
  If validation cannot pass, or this intent needs a prerequisite the app does not have, use
80
80
  the feature stop route above without further changes.
81
81
 
82
82
  Otherwise run
83
- `npx --prefer-offline --yes copilotkit@4.23.0 onboard read feature/a2ui/proof`.
83
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard read feature/a2ui/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.23.0 onboard checkpoint --phase awaiting-developer
15
+ npx --prefer-offline --yes copilotkit@4.24.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.
@@ -33,7 +33,7 @@ you plan. Run `onboard protect` again from the target app directory: on the same
33
33
  prints the baseline the run already holds.
34
34
 
35
35
  ```text
36
- npx --prefer-offline --yes copilotkit@4.23.0 onboard protect
36
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard protect
37
37
  ```
38
38
 
39
39
  Then have one read-only subagent repeat the inspection for the findings above, and wait
@@ -62,11 +62,11 @@ one.
62
62
  After approval, record each approved path before implementation:
63
63
 
64
64
  ```text
65
- npx --prefer-offline --yes copilotkit@4.23.0 onboard protect --authorize --path <path> --reason "<the plan's sentence>"
65
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard protect --authorize --path <path> --reason "<the plan's sentence>"
66
66
  ```
67
67
 
68
68
  If an approved path changed after capture and no implementation step has run, add
69
69
  `--with-prior-change`. Continue only when every result starts with `Status: passed`. Do not
70
70
  authorize a path the approved plan did not list.
71
71
 
72
- Then run `npx --prefer-offline --yes copilotkit@4.23.0 onboard read feature/a2ui/implement`.
72
+ Then run `npx --prefer-offline --yes copilotkit@4.24.0 onboard read feature/a2ui/implement`.
@@ -27,7 +27,7 @@ still go on the record. Name the file and why the fix needs it, then end your tu
27
27
  for the developer's answer. If they allow it, record their answer before any edit:
28
28
 
29
29
  ```text
30
- npx --prefer-offline --yes copilotkit@4.23.0 onboard protect --authorize --unplanned --path <path> --reason "<what the developer said>"
30
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard protect --authorize --unplanned --path <path> --reason "<what the developer said>"
31
31
  ```
32
32
 
33
33
  Continue only when the result starts with `Status: passed`. Run the audit again, take the
@@ -40,11 +40,11 @@ Report the outcome of each attempt as it ends, before any repair. The command co
40
40
  attempts and the repairs:
41
41
 
42
42
  ```text
43
- npx --prefer-offline --yes copilotkit@4.23.0 onboard proof --step round-trip --outcome <passed|failed|skipped>
43
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard proof --step round-trip --outcome <passed|failed|skipped>
44
44
  ```
45
45
 
46
46
  Use `passed` only for a proved A2UI surface, `failed` for an attempted proof that failed,
47
- and `skipped` when the proof could not run. Then run `npx --prefer-offline --yes copilotkit@4.23.0 onboard audit`.
47
+ and `skipped` when the proof could not run. Then run `npx --prefer-offline --yes copilotkit@4.24.0 onboard audit`.
48
48
  Continue only when it starts with `Status: passed`.
49
49
 
50
50
  If the audit fails, never repair, reset, or revert a protected path. Compare each named path
@@ -59,9 +59,9 @@ the path and the change the audit reports. Run the audit again after each accept
59
59
  If the audit still fails, or starts with `Status: blocked`, route out and stop:
60
60
 
61
61
  ```text
62
- npx --prefer-offline --yes copilotkit@4.23.0 onboard read feature/stop
62
+ npx --prefer-offline --yes copilotkit@4.24.0 onboard read feature/stop
63
63
  ```
64
64
 
65
65
  When the audit passes, run
66
- `npx --prefer-offline --yes copilotkit@4.23.0 onboard read feature/complete` with the actual browser-proof
66
+ `npx --prefer-offline --yes copilotkit@4.24.0 onboard read feature/complete` with the actual browser-proof
67
67
  outcome.