copilotkit 4.18.0 → 4.20.0

package/onboarding/prompts/framework/ms-agent-dotnet.md

@@ -11,7 +11,12 @@ For a user secret, run `dotnet user-secrets set OPENAI_API_KEY` from the agent d
 The app must read the same name through .NET configuration. An exported environment
 variable with that name takes precedence over the user secret.
 
-Run `dotnet --version` before you change the project.
+Run `dotnet --version` before you change the project. If it fails, no .NET SDK is on this
+shell's PATH. Do not change the project, and do not install the SDK yourself. Tell the
+developer to install the .NET SDK from https://dotnet.microsoft.com/download. Say that the
+coding agent's shell cannot see a new install until the developer restarts the coding
+agent. Give them `npx --prefer-offline --yes copilotkit@4.20.0 onboard start --run <onboarding_run_id>`
+to resume the run after the restart. Then end your turn and wait for the developer.
 
 ## Documentation
 
@@ -36,7 +41,7 @@ Record the selected framework, provider, model, required credential variable nam
 these URLs.
 
 If the pages support the selection, run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read frontend/plan`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read frontend/plan`.
 
 If the documentation does not support the selection, run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read unsupported/no-validated-path`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read unsupported/no-validated-path`.

package/onboarding/prompts/framework/ms-agent-harness-dotnet.md

@@ -5,7 +5,12 @@ Use direct OpenAI for a new setup. Name its credential `OPENAI_API_KEY`.
 
 For a user secret, run `dotnet user-secrets set OPENAI_API_KEY` from the agent directory.
 The app must read the same name through .NET configuration. Run `dotnet --version` before
-you change the project.
+you change the project. If it fails, no .NET SDK is on this shell's PATH. Do not change
+the project, and do not install the SDK yourself. Tell the developer to install the .NET
+SDK from https://dotnet.microsoft.com/download. Say that the coding agent's shell cannot
+see a new install until the developer restarts the coding agent. Give them
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard start --run <onboarding_run_id>` to resume the run
+after the restart. Then end your turn and wait for the developer.
 
 ## Documentation
 
@@ -44,7 +49,7 @@ Record the selected framework, provider, model, required credential variable nam
 URLs, and the quickstart gap.
 
 If the pages support the selection, run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read frontend/plan`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read frontend/plan`.
 
 If the documentation does not support the selection, run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read unsupported/no-validated-path`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read unsupported/no-validated-path`.

package/onboarding/prompts/framework/ms-agent-python.md

@@ -30,7 +30,7 @@ Record the selected framework, vendor, model, required credential variable names
 these URLs.
 
 If the pages support the selection, run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read frontend/plan`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read frontend/plan`.
 
 If the documentation does not support the selection, run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read unsupported/no-validated-path`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read unsupported/no-validated-path`.

package/onboarding/prompts/framework/pydantic-ai.md

@@ -43,7 +43,7 @@ Record the selected framework, vendor, model, required credential variable names
 URLs, and the two-step context route.
 
 If the pages support the selection, run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read frontend/plan`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read frontend/plan`.
 
 If the documentation does not support the selection, run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read unsupported/no-validated-path`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read unsupported/no-validated-path`.

package/onboarding/prompts/framework/strands-python.md

@@ -29,7 +29,7 @@ Record the selected framework, vendor, model, required credential variable names
 URLs, and the context documentation gap.
 
 If the pages support the selection, run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read frontend/plan`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read frontend/plan`.
 
 If the documentation does not support the selection, run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read unsupported/no-validated-path`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read unsupported/no-validated-path`.

package/onboarding/prompts/framework/strands-typescript.md

@@ -30,7 +30,7 @@ Record the selected framework, vendor, model, required credential variable names
 URLs, and the context documentation gap.
 
 If the pages support the selection, run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read frontend/plan`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read frontend/plan`.
 
 If the documentation does not support the selection, run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read unsupported/no-validated-path`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read unsupported/no-validated-path`.

package/onboarding/prompts/frontend/angular.md

@@ -5,7 +5,7 @@ Preserve an existing Angular frontend. Use the selected page for a new frontend.
 Use the starter shortcut only if all these facts are true: the target directory holds no
 project, its name is a valid `init` project name, and the selected framework is ADK.
 If all three facts are true, record Angular as the selected frontend. Then run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read starter/clone` before you fetch documentation.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read starter/clone` before you fetch documentation.
 
 ## Documentation
 
@@ -63,7 +63,7 @@ you create or build an Angular project. If the installed version is lower, selec
 supported version first and use it for every later command in this project.
 
 If the pages support the selection, record Angular and these URLs. Then run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read credentials/finalize-plan`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read credentials/finalize-plan`.
 
 If the documentation does not support the selection, or the two version lines do not fit
-together, run `npx --prefer-offline --yes copilotkit@4.18.0 onboard read unsupported/no-validated-path`.
+together, run `npx --prefer-offline --yes copilotkit@4.20.0 onboard read unsupported/no-validated-path`.

package/onboarding/prompts/frontend/nextjs.md

@@ -15,7 +15,7 @@ These TypeScript options have starters: Claude Agent SDK TypeScript, LangGraph T
 Mastra, and Strands Agents TypeScript. The .NET option is Microsoft Agent Framework .NET.
 
 If all shortcut conditions are true, record Next.js as the selected frontend. Then run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read starter/clone` before you fetch documentation.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read starter/clone` before you fetch documentation.
 
 ## Documentation
 
@@ -40,7 +40,7 @@ developer's work.
 - Do not claim, revert, or delete these files. Name them in the report as Next.js output.
 
 If the page supports the selection, record Next.js and this URL. Then run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read credentials/finalize-plan`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read credentials/finalize-plan`.
 
 If the documentation does not support the selection, run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read unsupported/no-validated-path`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read unsupported/no-validated-path`.

package/onboarding/prompts/frontend/plan.md

@@ -37,15 +37,15 @@ CopilotKit web apps. Then recommend the one the developer names, and say what ea
 
 Use exactly one matching internal route:
 
-1. React SPA: `npx --prefer-offline --yes copilotkit@4.18.0 onboard read frontend/react-spa`
-2. Next.js: `npx --prefer-offline --yes copilotkit@4.18.0 onboard read frontend/nextjs`
-3. Angular: `npx --prefer-offline --yes copilotkit@4.18.0 onboard read frontend/angular`
-4. Vue 3: `npx --prefer-offline --yes copilotkit@4.18.0 onboard read frontend/vue`
-5. React Native: `npx --prefer-offline --yes copilotkit@4.18.0 onboard read frontend/react-native`
-6. Slack or Microsoft Teams: `npx --prefer-offline --yes copilotkit@4.18.0 onboard read feature/channels/start`
+1. React SPA: `npx --prefer-offline --yes copilotkit@4.20.0 onboard read frontend/react-spa`
+2. Next.js: `npx --prefer-offline --yes copilotkit@4.20.0 onboard read frontend/nextjs`
+3. Angular: `npx --prefer-offline --yes copilotkit@4.20.0 onboard read frontend/angular`
+4. Vue 3: `npx --prefer-offline --yes copilotkit@4.20.0 onboard read frontend/vue`
+5. React Native: `npx --prefer-offline --yes copilotkit@4.20.0 onboard read frontend/react-native`
+6. Slack or Microsoft Teams: `npx --prefer-offline --yes copilotkit@4.20.0 onboard read feature/channels/start`
 
 If they chose Slack or Microsoft Teams, tell that node which one they chose so it
 does not ask again.
 
 If no listed frontend fits, run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read unsupported/no-validated-path`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read unsupported/no-validated-path`.

package/onboarding/prompts/frontend/react-native.md

@@ -18,7 +18,7 @@ documents `useRenderTool`, which is React Native's own hook for drawing a tool t
 already has. That is a different job and needs a tool in the agent.
 
 If the pages support the selection, record React Native and these URLs. Then run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read credentials/finalize-plan`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read credentials/finalize-plan`.
 
 If the documentation does not support the selection, run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read unsupported/no-validated-path`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read unsupported/no-validated-path`.

package/onboarding/prompts/frontend/react-spa.md

@@ -14,7 +14,7 @@ not move the agent into it.
 - https://docs.copilotkit.ai/react-spa.md
 
 If the page supports the selection, record React SPA and this URL. Then run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read credentials/finalize-plan`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read credentials/finalize-plan`.
 
 If the documentation does not support the selection, run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read unsupported/no-validated-path`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read unsupported/no-validated-path`.

package/onboarding/prompts/frontend/vue.md

@@ -19,7 +19,7 @@ page above. Vue has its own `useComponent`, which is not the React package. Take
 that reference page rather than from a Vue generative-UI guide, which is not published.
 
 If the pages support the selection, record Vue 3 and these URLs. Then run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read credentials/finalize-plan`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read credentials/finalize-plan`.
 
 If the documentation does not support the selection, run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read unsupported/no-validated-path`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read unsupported/no-validated-path`.

package/onboarding/prompts/implementation/build-and-validate.md

@@ -12,7 +12,7 @@ acted on. Send one short report before you stop. The friction command follows th
 setting the developer already chose, so it needs no separate question.
 
 ```text
-npx --prefer-offline --yes copilotkit@4.18.0 onboard friction --phase stop --category <slug> --message "<sentences>"
+npx --prefer-offline --yes copilotkit@4.20.0 onboard friction --phase stop --category <slug> --message "<sentences>"
 ```
 
 `--message` takes one or two sentences: the step you stopped at and what stopped it.
@@ -67,13 +67,17 @@ Approving the plan is the developer agreeing to every path it listed under
 app directory:
 
 ```text
-npx --prefer-offline --yes copilotkit@4.18.0 onboard protect --authorize --path <path> --reason "<the plan's sentence>"
+npx --prefer-offline --yes copilotkit@4.20.0 onboard protect --authorize --path <path> --reason "<the plan's sentence>"
 ```
 
 Consent has to be on the record before the file moves, so a call made after the change is
 refused. Continue only if every result starts with `Status: passed`. If the plan listed
 nothing there, skip this section.
 
+Do not authorize a path the plan lists under `Files the run writes itself`. The CLI refuses
+`--authorize` for `.env` and `.copilotkit/project.json`, because this run writes them. A
+copied model key is recorded with `--accept-credential`, after the copy.
+
 The implementation subagent cannot change a protected path unless it has the authorized
 list. Take that list from the CLI rather than from the plan: run `onboard audit` after the
 last authorization, and copy the paths under `Authorized to modify:`. An audit that passes
@@ -95,7 +99,7 @@ No implementation step has run yet, so the change is theirs rather than this run
 consent over it by adding one flag:
 
 ```text
-npx --prefer-offline --yes copilotkit@4.18.0 onboard protect --authorize --path <path> --reason "<the plan's sentence>" --with-prior-change
+npx --prefer-offline --yes copilotkit@4.20.0 onboard protect --authorize --path <path> --reason "<the plan's sentence>" --with-prior-change
 ```
 
 The flag records their change as drift beside the consent, so the closing report names both
@@ -115,7 +119,7 @@ audit below describes, rather than use this section.
 Run the audit from the target app directory:
 
 ```text
-npx --prefer-offline --yes copilotkit@4.18.0 onboard audit
+npx --prefer-offline --yes copilotkit@4.20.0 onboard audit
 ```
 
 It compares every protected path with the digest the CLI captured for it. Its result starts
@@ -150,14 +154,14 @@ A path that no Files changed section names changed outside the run, and it is th
 developer's own file. Accept it by name:
 
 ```text
-npx --prefer-offline --yes copilotkit@4.18.0 onboard protect --accept-external --path <path>
+npx --prefer-offline --yes copilotkit@4.20.0 onboard protect --accept-external --path <path>
 ```
 
 A changed env file is its own case. This run asked the developer to place a credential
 there, so it takes the credential route rather than this one:
 
 ```text
-npx --prefer-offline --yes copilotkit@4.18.0 onboard protect --accept-credential --path <path>
+npx --prefer-offline --yes copilotkit@4.20.0 onboard protect --accept-credential --path <path>
 ```
 
 That route proves no recorded credential was lost, instead of taking the run's word that it
@@ -176,7 +180,7 @@ neither does a one-line fix. Never repair, reset, or revert it. Ask the develope
 the change, and record the answer they give:
 
 ```text
-npx --prefer-offline --yes copilotkit@4.18.0 onboard protect --authorize --unplanned --path <path> --reason "<what the developer said>"
+npx --prefer-offline --yes copilotkit@4.20.0 onboard protect --authorize --unplanned --path <path> --reason "<what the developer said>"
 ```
 
 Use it only for an answer a developer actually gave. It records the consent as taken
@@ -188,6 +192,14 @@ and spawn a fresh implementation subagent with the same handoff and that list. I
 audit starts with `Status: blocked`, use the route-out rules instead. A subagent
 that already returned cannot pick up consent recorded after it was spawned.
 
+A failed audit can also list project files that name a credential file outside the
+repository. Such a file is not a protected path, and no route accepts it. It ties the commit
+to a folder in the developer's home directory, so the app has no model key on any other
+machine. Spawn a fresh implementation subagent with the same handoff and this one change:
+remove the outside path, and load the key the way the approved plan says, from the app's
+env file or from an environment variable. Then run the audit again. If the file is a
+protected path, or the plan names no other way to load the key, use the route-out rules.
+
 `Status: blocked` means the audit has no baseline to read. A blocked audit compared
 nothing and proved nothing changed. It is not a preservation failure: do not report a
 protected path as changed. Report the printed reason and use the route-out rules.
@@ -198,12 +210,12 @@ an acceptance clears it, or route out. Do not send an audit result to a repair w
 
 ## Create the approved Learning Container
 
-Where the approved plan names a Learning Container id that the platform does not hold yet,
-create it now, from the target app directory. The developer approved the id before it was
-made, so this is the first point at which it can be created:
+Where the approved plan names a Learning Container id, create it now, from the target app
+directory. The developer approved the id before it was made, so this is the first point at
+which it can be created:
 
 ```text
-npx --prefer-offline --yes copilotkit@4.18.0 learning containers create --id <id> --name <name> --json
+npx --prefer-offline --yes copilotkit@4.20.0 learning containers create --id <id> --name <name> --json
 ```
 
 Pass the id the plan names. Take the name from the selected project's own display name, so
@@ -211,30 +223,16 @@ the container reads as this project's in the dashboard. Both flags are required
 `--json`: a create that leaves either one out is refused as `NON_INTERACTIVE` rather than
 prompted for, whatever terminal the run has.
 
-`LEARNING_CONTAINER_ALREADY_EXISTS` means another run already made it. That is a container
-to reuse, not a failure to repair and not a reason to pick a new id. Any other error code:
-report it and stop onboarding, so no run wires a selector to an id the platform does not
-hold.
-
-Then report that the container is settled, before any edit:
-
-```text
-npx --prefer-offline --yes copilotkit@4.18.0 onboard checkpoint --phase container-settled
-```
-
-Where the plan names a container the platform already held, report the same checkpoint and
-create nothing. Where the plan names no container, skip this section.
+`LEARNING_CONTAINER_ALREADY_EXISTS` means the platform already holds it, because the
+credentials step found it or another run made it. That is a container to reuse, not a
+failure to repair and not a reason to pick a new id. Any other error code: report it and
+stop onboarding, so no run wires a selector to an id the platform does not hold. Where the
+plan names no container, skip this section.
 
 ## Implement the plan
 
-Report the plan this run is about to implement:
-
-```text
-npx --prefer-offline --yes copilotkit@4.18.0 onboard checkpoint --phase plan-written
-```
-
 Spawn one implementation subagent. Tell it to run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read subagent/implement-and-validate` first and follow
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read subagent/implement-and-validate` first and follow
 the prompt it returns. If that read fails because the subagent cannot use the shell, stop that
 subagent. Run the same command yourself, then spawn a fresh subagent with the returned prompt
 and the same handoff. Give it the plan, selected framework, frontend, model, exact target app
@@ -260,14 +258,8 @@ Run the protected-path audit after the implementation subagent passes. Decide ea
 names the same way as above, against the Files changed section that subagent just
 returned. Continue to proof only when that audit passes.
 
-After the selected implementation path passes, report it:
-
-```text
-npx --prefer-offline --yes copilotkit@4.18.0 onboard checkpoint --phase build-validated
-```
-
 Then run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read proof/round-trip`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read proof/round-trip`.
 
 ## Repair rules
 
@@ -293,9 +285,9 @@ the same command still fails after three repair attempts, a result starts with
 declined a file the plan does not name, or the run cannot ask them about it. A defect in a
 package this run installed is not a stack CopilotKit does not serve, a command this run cannot get to pass is not one either, and a blocked audit
 proved nothing about the stack. In those cases run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read stopped/run-failed`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read stopped/run-failed`.
 
 A plan with no path to follow takes the unsupported ending: the fix requires changing the
 developer's existing agent or frontend, or the documentation does not support the plan. In
 those cases run
-`npx --prefer-offline --yes copilotkit@4.18.0 onboard read unsupported/no-validated-path`.
+`npx --prefer-offline --yes copilotkit@4.20.0 onboard read unsupported/no-validated-path`.