copilotkit 4.28.0 → 4.29.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -3
- package/cli-build-info.json +5 -5
- package/index.js +555 -196
- package/onboarding/index.json +2 -2
- package/onboarding/prompts/authenticate/start.md +32 -20
- package/onboarding/prompts/conversion/plan.md +3 -3
- package/onboarding/prompts/credentials/finalize-plan.md +15 -15
- package/onboarding/prompts/credentials/plan.md +24 -24
- package/onboarding/prompts/credentials/settle-credentials.md +7 -7
- package/onboarding/prompts/credentials/write-plan.md +34 -26
- package/onboarding/prompts/deployment/choose-local.md +9 -9
- package/onboarding/prompts/deployment/local-evaluation.md +12 -12
- package/onboarding/prompts/fallback/best-effort.md +6 -6
- package/onboarding/prompts/feature/a2ui/implement.md +4 -4
- package/onboarding/prompts/feature/a2ui/plan.md +3 -3
- package/onboarding/prompts/feature/a2ui/proof.md +5 -5
- package/onboarding/prompts/feature/a2ui/start.md +17 -8
- package/onboarding/prompts/feature/channels/implement.md +7 -7
- package/onboarding/prompts/feature/channels/plan.md +5 -5
- package/onboarding/prompts/feature/channels/proof.md +5 -5
- package/onboarding/prompts/feature/channels/start.md +18 -9
- package/onboarding/prompts/feature/chat-suggestions/implement.md +4 -4
- package/onboarding/prompts/feature/chat-suggestions/plan.md +3 -3
- package/onboarding/prompts/feature/chat-suggestions/proof.md +5 -5
- package/onboarding/prompts/feature/chat-suggestions/start.md +17 -8
- package/onboarding/prompts/feature/complete.md +2 -2
- package/onboarding/prompts/feature/learning/implement.md +12 -12
- package/onboarding/prompts/feature/learning/plan.md +4 -4
- package/onboarding/prompts/feature/learning/proof.md +13 -13
- package/onboarding/prompts/feature/learning/start.md +17 -8
- package/onboarding/prompts/feature/open-generative-ui/implement.md +4 -4
- package/onboarding/prompts/feature/open-generative-ui/plan.md +3 -3
- package/onboarding/prompts/feature/open-generative-ui/proof.md +5 -5
- package/onboarding/prompts/feature/open-generative-ui/start.md +17 -8
- package/onboarding/prompts/feature/realtime-sync/implement.md +5 -5
- package/onboarding/prompts/feature/realtime-sync/plan.md +3 -3
- package/onboarding/prompts/feature/realtime-sync/proof.md +5 -5
- package/onboarding/prompts/feature/realtime-sync/start.md +16 -7
- package/onboarding/prompts/feature/rich-threads/implement.md +6 -6
- package/onboarding/prompts/feature/rich-threads/plan.md +3 -3
- package/onboarding/prompts/feature/rich-threads/proof.md +5 -5
- package/onboarding/prompts/feature/rich-threads/start.md +16 -7
- package/onboarding/prompts/feature/stop.md +4 -4
- package/onboarding/prompts/feature/voice/implement.md +4 -4
- package/onboarding/prompts/feature/voice/plan.md +4 -4
- package/onboarding/prompts/feature/voice/proof.md +5 -5
- package/onboarding/prompts/feature/voice/start.md +17 -8
- package/onboarding/prompts/framework/ag2.md +3 -3
- package/onboarding/prompts/framework/agno.md +3 -3
- package/onboarding/prompts/framework/built-in.md +3 -3
- package/onboarding/prompts/framework/claude-sdk-python.md +3 -3
- package/onboarding/prompts/framework/claude-sdk-typescript.md +3 -3
- package/onboarding/prompts/framework/crewai-flows.md +5 -5
- package/onboarding/prompts/framework/custom-ag-ui.md +4 -4
- package/onboarding/prompts/framework/deep-agents.md +3 -3
- package/onboarding/prompts/framework/google-adk.md +3 -3
- package/onboarding/prompts/framework/langgraph-fastapi.md +3 -3
- package/onboarding/prompts/framework/langgraph-python.md +3 -3
- package/onboarding/prompts/framework/langgraph-typescript.md +3 -3
- package/onboarding/prompts/framework/llamaindex.md +3 -3
- package/onboarding/prompts/framework/mastra.md +3 -3
- package/onboarding/prompts/framework/ms-agent-dotnet.md +5 -5
- package/onboarding/prompts/framework/ms-agent-harness-dotnet.md +5 -5
- package/onboarding/prompts/framework/ms-agent-python.md +3 -3
- package/onboarding/prompts/framework/pydantic-ai.md +3 -3
- package/onboarding/prompts/framework/strands-python.md +3 -3
- package/onboarding/prompts/framework/strands-typescript.md +3 -3
- package/onboarding/prompts/frontend/angular.md +4 -4
- package/onboarding/prompts/frontend/nextjs.md +4 -4
- package/onboarding/prompts/frontend/plan.md +10 -10
- package/onboarding/prompts/frontend/react-native.md +3 -3
- package/onboarding/prompts/frontend/react-spa.md +3 -3
- package/onboarding/prompts/frontend/vue.md +3 -3
- package/onboarding/prompts/implementation/build-and-validate.md +26 -10
- package/onboarding/prompts/proof/complete.md +3 -3
- package/onboarding/prompts/proof/oss-baseline.md +21 -5
- package/onboarding/prompts/proof/round-trip.md +33 -11
- package/onboarding/prompts/research/gather.md +58 -41
- package/onboarding/prompts/research/merge.md +3 -3
- package/onboarding/prompts/research/preflight.md +2 -2
- package/onboarding/prompts/research/route.md +5 -5
- package/onboarding/prompts/setup/questions.md +6 -6
- package/onboarding/prompts/starter/clone.md +28 -28
- package/onboarding/prompts/stopped/run-failed.md +3 -3
- package/onboarding/prompts/subagent/create-plan.md +27 -2
- package/onboarding/prompts/subagent/implement-and-validate.md +31 -3
- package/onboarding/prompts/subagent/inspect-repository.md +17 -4
- package/onboarding/prompts/subagent/prove-oss-baseline.md +24 -1
- package/onboarding/prompts/subagent/prove-round-trip.md +29 -6
- package/onboarding/prompts/unsupported/no-validated-path.md +3 -3
- package/package.json +1 -1
package/onboarding/index.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"graphTree": "
|
|
2
|
+
"graphTree": "097fa21703ca2deadf60b9e0f0ce9e895160c2ea",
|
|
3
3
|
"intentRoots": {
|
|
4
4
|
"add-a2ui": "feature/a2ui/start",
|
|
5
5
|
"add-chat-suggestions": "feature/chat-suggestions/start",
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
"add-rich-threads": "feature/rich-threads/start",
|
|
10
10
|
"add-voice": "feature/voice/start"
|
|
11
11
|
},
|
|
12
|
-
"packageSpec": "copilotkit@4.
|
|
12
|
+
"packageSpec": "copilotkit@4.29.0",
|
|
13
13
|
"root": "authenticate/start",
|
|
14
14
|
"prompts": [
|
|
15
15
|
{
|
|
@@ -6,15 +6,16 @@ This run executes the CopilotKit CLI through `npx`.
|
|
|
6
6
|
It spawns read-only inspection subagents inside the target project. It sends checkpoints
|
|
7
7
|
and optional friction reports to CopilotKit under the developer's telemetry setting. It
|
|
8
8
|
reads nothing outside the project
|
|
9
|
-
directory.
|
|
10
|
-
plan says needs the developer's approval.
|
|
9
|
+
directory. In an existing project, it changes files only after writing the plan, and asks
|
|
10
|
+
before any change the plan says needs the developer's approval. An empty folder gets a
|
|
11
|
+
new app. CopilotKit
|
|
11
12
|
Intelligence has a free Developer plan, and this run needs no paid subscription.
|
|
12
13
|
|
|
13
14
|
## Command approvals
|
|
14
15
|
|
|
15
16
|
Run each CLI call exactly as written, as its own command: no pipe, `tee`, `&&`, redirect,
|
|
16
17
|
or variable prefix. Every CLI call in this run matches the prefix rule
|
|
17
|
-
`["npx", "--prefer-offline", "--yes", "copilotkit@4.
|
|
18
|
+
`["npx", "--prefer-offline", "--yes", "copilotkit@4.29.0"]`.
|
|
18
19
|
|
|
19
20
|
<!-- sandboxed-harness -->
|
|
20
21
|
|
|
@@ -30,8 +31,18 @@ prefix covers every CLI call. Say then that the install, the dev servers, `curl`
|
|
|
30
31
|
Never add or edit a permission rule or a settings file yourself. That choice belongs to
|
|
31
32
|
the developer.
|
|
32
33
|
|
|
34
|
+
<!-- antigravity-harness -->
|
|
35
|
+
|
|
36
|
+
Antigravity's "always allow" saves only the one full command, so it does not cover the
|
|
37
|
+
next CLI call. Tell the developer that one entry covers every CLI call, and that the
|
|
38
|
+
choice is theirs. The entry goes in `/permissions`, or in `permissions.allow` in
|
|
39
|
+
`~/.gemini/antigravity-cli/settings.json`:
|
|
40
|
+
`command(npx --prefer-offline --yes copilotkit@4.29.0)`.
|
|
41
|
+
|
|
42
|
+
<!-- /antigravity-harness -->
|
|
43
|
+
|
|
33
44
|
If your harness refuses a CLI call without asking the developer, do not retry it or run it
|
|
34
|
-
another way. Report the pause: `npx --prefer-offline --yes copilotkit@4.
|
|
45
|
+
another way. Report the pause: `npx --prefer-offline --yes copilotkit@4.29.0 onboard checkpoint --phase awaiting-developer --about harness-permission`.
|
|
35
46
|
Name the refused command, ask the developer to approve it or to switch to a
|
|
36
47
|
mode that asks them, and end your turn. When they answer, run it once more.
|
|
37
48
|
That refusal is a pause, not a stop.
|
|
@@ -45,7 +56,7 @@ does not see your tool output, and the welcome comes later, with the setup messa
|
|
|
45
56
|
Then run this:
|
|
46
57
|
|
|
47
58
|
```text
|
|
48
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
59
|
+
npx --prefer-offline --yes copilotkit@4.29.0 onboard identify --coding-agent <coding-agent-slug> --model <model-id> --model-family <model-family>
|
|
49
60
|
```
|
|
50
61
|
|
|
51
62
|
Report your product slug, such as `codex` or `claude-code`.
|
|
@@ -79,11 +90,11 @@ tool output.
|
|
|
79
90
|
If you stop this run at any point, send one short report before you stop. This includes
|
|
80
91
|
unexpected stops and stops caused by your harness.
|
|
81
92
|
A turn that ends while the run waits is a pause, not a stop, even when your harness ends it.
|
|
82
|
-
Report the pause
|
|
93
|
+
Report the pause as the prompt that asks the question says.
|
|
83
94
|
A terminal that sends the report itself, or says to file none, overrides this.
|
|
84
95
|
|
|
85
96
|
```text
|
|
86
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
97
|
+
npx --prefer-offline --yes copilotkit@4.29.0 onboard friction --phase stop --category <slug> --message "<sentences>"
|
|
87
98
|
```
|
|
88
99
|
|
|
89
100
|
`--message` takes one or two sentences: the step you stopped at and what stopped it.
|
|
@@ -101,15 +112,15 @@ rule that stopped you says next: send the report, then stop.
|
|
|
101
112
|
Take the local route only when the developer already asked to run CopilotKit locally,
|
|
102
113
|
with Docker, or self-hosted: in their request, the copied prompt, or a later reply, or
|
|
103
114
|
when this run already recorded local. Then run
|
|
104
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
115
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard read deployment/choose-local` instead.
|
|
105
116
|
|
|
106
117
|
Otherwise keep managed. Do not ask the developer to choose. Run
|
|
107
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
118
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard deployment --choice managed`, then continue with
|
|
108
119
|
“Check sign-in”. If it refuses because of a local stack, take the local route.
|
|
109
120
|
|
|
110
121
|
## Check sign-in
|
|
111
122
|
|
|
112
|
-
Run `npx --prefer-offline --yes copilotkit@4.
|
|
123
|
+
Run `npx --prefer-offline --yes copilotkit@4.29.0 login --json --onboarding` before any project work. It checks the
|
|
113
124
|
session and starts sign-in only as needed. Treat this as a long-lived
|
|
114
125
|
streaming process. Do not wait for the command to exit before you read its standard output.
|
|
115
126
|
|
|
@@ -119,17 +130,18 @@ Read each JSON Lines record as it arrives:
|
|
|
119
130
|
existing session is valid.
|
|
120
131
|
2. If the process emits `authentication_url`, the developer must sign in. The process is
|
|
121
132
|
still running.
|
|
122
|
-
3.
|
|
123
|
-
why to sign in,
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
133
|
+
3. When it can, the CLI opens the sign-in page in the default browser. The first
|
|
134
|
+
`action_required` record carries a `message`: why to sign in, whether the page opened,
|
|
135
|
+
then the link and the code. Write that `message` in your own reply, word for word, and add
|
|
136
|
+
nothing else. The developer does not see your tool output. Do not open the page yourself.
|
|
137
|
+
Then report the pause with
|
|
138
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard checkpoint --phase awaiting-developer --about sign-in` and end your
|
|
127
139
|
turn. Until the developer says they signed in, send them nothing more. When the research or
|
|
128
140
|
another helper returns, record what it found and end your turn without a message. Your own
|
|
129
141
|
built-in browser does not carry the session the developer already signed in with,
|
|
130
142
|
so do not use it.
|
|
131
143
|
A later `authentication_url` record with `"renewed": true` means the earlier code expired.
|
|
132
|
-
Write its `message` the same way.
|
|
144
|
+
The CLI opens its page too, when it can. Write its `message` the same way.
|
|
133
145
|
4. Keep monitoring the same login process. Do not start a second login command.
|
|
134
146
|
5. Go past the research only after that same process emits `type: completed`.
|
|
135
147
|
6. On `type: failed` with `reason: expired` or `reason: renewal_failed`, ask once whether to
|
|
@@ -138,11 +150,11 @@ Read each JSON Lines record as it arrives:
|
|
|
138
150
|
7. If that process emits `type: failed`, report the error and stop onboarding. On
|
|
139
151
|
`reason: repeated_expiry`, rerun `login` with `--force` only if the developer asks.
|
|
140
152
|
|
|
141
|
-
On `type: completed`, run `npx --prefer-offline --yes copilotkit@4.
|
|
153
|
+
On `type: completed`, run `npx --prefer-offline --yes copilotkit@4.29.0 onboard checkpoint --phase sign-in-settled`
|
|
142
154
|
before you continue.
|
|
143
155
|
|
|
144
156
|
If your harness ends the login process or your turn before the process emits
|
|
145
|
-
`type: completed` or `type: failed`, that is a pause, not a failed sign-in. Report the pause: `npx --prefer-offline --yes copilotkit@4.
|
|
157
|
+
`type: completed` or `type: failed`, that is a pause, not a failed sign-in. Report the pause: `npx --prefer-offline --yes copilotkit@4.29.0 onboard checkpoint --phase awaiting-developer --about sign-in`.
|
|
146
158
|
If the process
|
|
147
159
|
still runs, end your turn and wait for the developer to say they signed in, then read the
|
|
148
160
|
same process. If the process ended without emitting `type: failed`, run
|
|
@@ -154,9 +166,9 @@ conversation.
|
|
|
154
166
|
|
|
155
167
|
Research reads only this project and needs no account. Start it as soon as the session is
|
|
156
168
|
valid or the developer has the sign-in page, and keep monitoring the login process while it
|
|
157
|
-
runs: `npx --prefer-offline --yes copilotkit@4.
|
|
169
|
+
runs: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read research/gather`. If this run already
|
|
158
170
|
started the research, do not start it again.
|
|
159
171
|
|
|
160
172
|
If sign-in stops onboarding, run
|
|
161
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
173
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard read stopped/run-failed`. It does not judge
|
|
162
174
|
this project's stack.
|
|
@@ -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.
|
|
103
|
+
fifth item is proved by `npx --prefer-offline --yes copilotkit@4.29.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.
|
|
119
|
+
Then run `npx --prefer-offline --yes copilotkit@4.29.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.
|
|
122
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard read unsupported/no-validated-path`.
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
# Select the Intelligence project
|
|
2
2
|
|
|
3
3
|
For a recorded local choice, run
|
|
4
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
4
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard read deployment/local-evaluation`.
|
|
5
5
|
That path connects the local project with the approval the setup message took.
|
|
6
6
|
Skip hosted selection.
|
|
7
7
|
Keep the implementation and feature-proof requirements.
|
|
8
8
|
|
|
9
9
|
Use the selected framework, frontend, model vendor, model, documentation URLs, and
|
|
10
10
|
repository findings. When the framework, frontend or vendor is not in your context, read it
|
|
11
|
-
from `npx --prefer-offline --yes copilotkit@4.
|
|
11
|
+
from `npx --prefer-offline --yes copilotkit@4.29.0 onboard setup-answers`, and do not ask again. On a conversion, use the values the conversion prompt recorded, and
|
|
12
12
|
ask no framework or frontend question. Do not change application code in this phase. Do
|
|
13
13
|
not read, show, store, or request a secret value.
|
|
14
14
|
|
|
@@ -20,7 +20,7 @@ reason only when it names something in the developer's own project. Do not ask a
|
|
|
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.
|
|
23
|
+
npx --prefer-offline --yes copilotkit@4.29.0 onboard checkpoint --phase awaiting-developer --about setup-answers
|
|
24
24
|
```
|
|
25
25
|
|
|
26
26
|
## Record the audit cell
|
|
@@ -38,7 +38,7 @@ Choose the starting state from the repository findings:
|
|
|
38
38
|
A run served `proof/oss-baseline` records one of the last two.
|
|
39
39
|
|
|
40
40
|
```text
|
|
41
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
41
|
+
npx --prefer-offline --yes copilotkit@4.29.0 onboard classify --starting-state <starting-state> --agent-framework <agent-framework> --frontend <frontend> --model-vendor <model-vendor> --model-vendor-choice <model-vendor-choice>
|
|
42
42
|
```
|
|
43
43
|
|
|
44
44
|
`<model-vendor>` is `openai`, `anthropic`, `google`, `openai-compatible`, or `other`.
|
|
@@ -55,7 +55,7 @@ runtime `.env` file, that directory is the target, not the repository root. Do n
|
|
|
55
55
|
the developer to another terminal.
|
|
56
56
|
|
|
57
57
|
```text
|
|
58
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
58
|
+
npx --prefer-offline --yes copilotkit@4.29.0 onboard credentials --json
|
|
59
59
|
```
|
|
60
60
|
|
|
61
61
|
Every credential this run writes goes to the environment path: the target's `.env`, or
|
|
@@ -80,7 +80,7 @@ the CLI kept: run `--create` with `question.recorded.create`, or `--project` wit
|
|
|
80
80
|
project answer `setup/questions` gave you. A new project with no recorded name takes
|
|
81
81
|
`suggestedName`. Ask the developer only when `question.taken` or `question.notFound` is
|
|
82
82
|
present, or when no answer was recorded. When they then give another project, record it
|
|
83
|
-
with `npx --prefer-offline --yes copilotkit@4.
|
|
83
|
+
with `npx --prefer-offline --yes copilotkit@4.29.0 onboard setup-answers --create <name>` or
|
|
84
84
|
`--project <slug>`.
|
|
85
85
|
|
|
86
86
|
`project-name` means that no project is bound here, so creating a project for this
|
|
@@ -93,7 +93,7 @@ unless the developer says that it is this app's.
|
|
|
93
93
|
Before you end your turn to wait for the developer, report the pause:
|
|
94
94
|
|
|
95
95
|
```text
|
|
96
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
96
|
+
npx --prefer-offline --yes copilotkit@4.29.0 onboard checkpoint --phase awaiting-developer --about project-name
|
|
97
97
|
```
|
|
98
98
|
|
|
99
99
|
If no developer answers, create with the derived name in `suggestedName`. Never select a
|
|
@@ -102,9 +102,9 @@ project from a listing without an answer that names it.
|
|
|
102
102
|
`--runtime-url` is the URL port research settled, mount path included:
|
|
103
103
|
|
|
104
104
|
```text
|
|
105
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
105
|
+
npx --prefer-offline --yes copilotkit@4.29.0 onboard credentials --create <name> \
|
|
106
106
|
--runtime-url http://localhost:<port>/api/copilotkit --json
|
|
107
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
107
|
+
npx --prefer-offline --yes copilotkit@4.29.0 onboard credentials --project <slug-or-id> \
|
|
108
108
|
--runtime-url http://localhost:<port>/api/copilotkit --json
|
|
109
109
|
```
|
|
110
110
|
|
|
@@ -116,12 +116,12 @@ show only what they asked for, and do not order it by creation time:
|
|
|
116
116
|
Before you end your turn to wait for the developer, report the pause:
|
|
117
117
|
|
|
118
118
|
```text
|
|
119
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
119
|
+
npx --prefer-offline --yes copilotkit@4.29.0 onboard checkpoint --phase awaiting-developer --about which-project
|
|
120
120
|
```
|
|
121
121
|
|
|
122
122
|
```text
|
|
123
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
124
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
123
|
+
npx --prefer-offline --yes copilotkit@4.29.0 project list --json
|
|
124
|
+
npx --prefer-offline --yes copilotkit@4.29.0 project list --search <query> --json
|
|
125
125
|
```
|
|
126
126
|
|
|
127
127
|
`app-directory` means that the key landed where no app reads it. Pick the directory in
|
|
@@ -130,7 +130,7 @@ the `--project` command from there with `project.slug`. Do not copy or link the
|
|
|
130
130
|
|
|
131
131
|
`env-file-exposed` means that git tracks the env file the key goes into, or does not
|
|
132
132
|
ignore it. So nothing was written. Read `envFile` from
|
|
133
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
133
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard setup-answers`, which keeps the developer's answer to
|
|
134
134
|
that line in the setup message: `approved` approves the change the line asks for,
|
|
135
135
|
`alternative` chose `question.alternative`, and `declined` declined both. Act on it without
|
|
136
136
|
asking again. An accepting reply to the setup message never approves a line with
|
|
@@ -144,7 +144,7 @@ run the same command again with `question.alternative.rerun` added. The CLI adds
|
|
|
144
144
|
If they approve the untrack, add
|
|
145
145
|
`question.ignoreLine` to `question.ignoreFile`. If `question.untrack` is present, run it
|
|
146
146
|
too. Or the developer does both. Report the pause with
|
|
147
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
147
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard checkpoint --phase awaiting-developer --about env-file-tracked`, end your
|
|
148
148
|
turn, and wait for the answer. Then run the same command again. Write the key only to
|
|
149
149
|
`question.file`, or to `question.alternative.file` by rerunning with
|
|
150
150
|
`question.alternative.rerun`.
|
|
@@ -160,4 +160,4 @@ turn, and wait for the answer. Then run the same command again. Write the key on
|
|
|
160
160
|
reused. The round-trip proof later runs the authenticated Intelligence checks, so record
|
|
161
161
|
the reused project credentials as unverified in the plan until those checks pass.
|
|
162
162
|
|
|
163
|
-
Then run `npx --prefer-offline --yes copilotkit@4.
|
|
163
|
+
Then run `npx --prefer-offline --yes copilotkit@4.29.0 onboard read credentials/settle-credentials`.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Select the agent framework
|
|
2
2
|
|
|
3
|
-
First run `npx --prefer-offline --yes copilotkit@4.
|
|
3
|
+
First run `npx --prefer-offline --yes copilotkit@4.29.0 onboard setup-answers`. It prints the answers that
|
|
4
4
|
`setup/questions` recorded, even after this conversation lost them. Use its `framework` and
|
|
5
5
|
its `vendor`, with `vendor.choice`, `vendor.baseUrl` and `vendor.modelId`. That node asked
|
|
6
6
|
the developer, so ask nothing here. A run that proved its existing agent, frontend, and
|
|
@@ -25,7 +25,7 @@ and Google come in a later release, and offer the Built-in CopilotKit agent if t
|
|
|
25
25
|
them now. Record the answers with
|
|
26
26
|
`onboard setup-answers --framework <name> --vendor <vendor> --vendor-choice <choice>`.
|
|
27
27
|
Report the pause with
|
|
28
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
28
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard checkpoint --phase awaiting-developer --about stack-choice`, then end your
|
|
29
29
|
turn and wait for the answer. A route that records no framework or vendor on purpose is not
|
|
30
30
|
this case: an empty project with Slack or Microsoft Teams, a "Project-defined" vendor, or
|
|
31
31
|
"The agent's own" vendor.
|
|
@@ -49,7 +49,7 @@ Microsoft Teams docs page, do not ask the framework question. So does an empty p
|
|
|
49
49
|
whose frontend `setup/questions` recorded as Slack or Microsoft Teams: it recorded no
|
|
50
50
|
framework. The Channel starter brings its own agent, so an answer here decides nothing. Tell the developer that the Channel
|
|
51
51
|
starter decides the agent, then run
|
|
52
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
52
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard read frontend/plan`.
|
|
53
53
|
|
|
54
54
|
## Route on the recorded framework
|
|
55
55
|
|
|
@@ -58,28 +58,28 @@ chosen: `developer`, `default`, or `existing`. The framework route uses this ven
|
|
|
58
58
|
|
|
59
59
|
Use exactly one matching internal route:
|
|
60
60
|
|
|
61
|
-
1. AG2: `npx --prefer-offline --yes copilotkit@4.
|
|
62
|
-
2. Agno: `npx --prefer-offline --yes copilotkit@4.
|
|
63
|
-
3. Built-in CopilotKit agent: `npx --prefer-offline --yes copilotkit@4.
|
|
64
|
-
4. Claude Agent SDK Python: `npx --prefer-offline --yes copilotkit@4.
|
|
65
|
-
5. Claude Agent SDK TypeScript: `npx --prefer-offline --yes copilotkit@4.
|
|
66
|
-
6. CrewAI Flows: `npx --prefer-offline --yes copilotkit@4.
|
|
67
|
-
7. Custom agent: `npx --prefer-offline --yes copilotkit@4.
|
|
68
|
-
8. Deep Agents: `npx --prefer-offline --yes copilotkit@4.
|
|
69
|
-
9. LangGraph Python: `npx --prefer-offline --yes copilotkit@4.
|
|
70
|
-
10. LangGraph FastAPI: `npx --prefer-offline --yes copilotkit@4.
|
|
71
|
-
11. LangGraph TypeScript: `npx --prefer-offline --yes copilotkit@4.
|
|
72
|
-
12. LlamaIndex: `npx --prefer-offline --yes copilotkit@4.
|
|
73
|
-
13. ADK: `npx --prefer-offline --yes copilotkit@4.
|
|
74
|
-
14. Microsoft Agent Framework Python: `npx --prefer-offline --yes copilotkit@4.
|
|
75
|
-
15. Microsoft Agent Framework .NET: `npx --prefer-offline --yes copilotkit@4.
|
|
76
|
-
16. Mastra: `npx --prefer-offline --yes copilotkit@4.
|
|
77
|
-
17. MS Agent Harness .NET: `npx --prefer-offline --yes copilotkit@4.
|
|
78
|
-
18. Pydantic AI: `npx --prefer-offline --yes copilotkit@4.
|
|
79
|
-
19. Strands Agents Python: `npx --prefer-offline --yes copilotkit@4.
|
|
80
|
-
20. Strands Agents TypeScript: `npx --prefer-offline --yes copilotkit@4.
|
|
61
|
+
1. AG2: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/ag2`
|
|
62
|
+
2. Agno: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/agno`
|
|
63
|
+
3. Built-in CopilotKit agent: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/built-in`
|
|
64
|
+
4. Claude Agent SDK Python: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/claude-sdk-python`
|
|
65
|
+
5. Claude Agent SDK TypeScript: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/claude-sdk-typescript`
|
|
66
|
+
6. CrewAI Flows: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/crewai-flows`
|
|
67
|
+
7. Custom agent: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/custom-ag-ui`
|
|
68
|
+
8. Deep Agents: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/deep-agents`
|
|
69
|
+
9. LangGraph Python: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/langgraph-python`
|
|
70
|
+
10. LangGraph FastAPI: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/langgraph-fastapi`
|
|
71
|
+
11. LangGraph TypeScript: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/langgraph-typescript`
|
|
72
|
+
12. LlamaIndex: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/llamaindex`
|
|
73
|
+
13. ADK: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/google-adk`
|
|
74
|
+
14. Microsoft Agent Framework Python: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/ms-agent-python`
|
|
75
|
+
15. Microsoft Agent Framework .NET: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/ms-agent-dotnet`
|
|
76
|
+
16. Mastra: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/mastra`
|
|
77
|
+
17. MS Agent Harness .NET: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/ms-agent-harness-dotnet`
|
|
78
|
+
18. Pydantic AI: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/pydantic-ai`
|
|
79
|
+
19. Strands Agents Python: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/strands-python`
|
|
80
|
+
20. Strands Agents TypeScript: `npx --prefer-offline --yes copilotkit@4.29.0 onboard read framework/strands-typescript`
|
|
81
81
|
|
|
82
82
|
An agent in any other framework takes route 7, whether or not it speaks AG-UI. So does a
|
|
83
83
|
new agent on a framework that is not listed. If the developer declines route 7 and every
|
|
84
84
|
listed framework, keep their current agent and run
|
|
85
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
85
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard read unsupported/no-validated-path`.
|
|
@@ -21,10 +21,10 @@ 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.
|
|
24
|
+
npx --prefer-offline --yes copilotkit@4.29.0 onboard credentials --model-key <variable> --json
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
Run `npx --prefer-offline --yes copilotkit@4.
|
|
27
|
+
Run `npx --prefer-offline --yes copilotkit@4.29.0 onboard setup-answers` for the key answer the setup
|
|
28
28
|
message recorded. If it holds `key.file`, add `--env-path <key.file>` to the first check.
|
|
29
29
|
When the framework node names another env file for the credential, add
|
|
30
30
|
`--env-path <file>`. When the agent runs as its own service, such as a remote AG-UI agent,
|
|
@@ -41,17 +41,17 @@ never prints a value. Read `status`:
|
|
|
41
41
|
`Files the run writes itself`.
|
|
42
42
|
The developer's answer to the key file line in the setup questions is their consent to
|
|
43
43
|
the copy. After the run shows the plan, copy the key with the command that `next` names. It has this form:
|
|
44
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
44
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard credentials --model-key <variable> --env-path <file> --copy-to <env file> --json`.
|
|
45
45
|
`<env file>` is `environmentPath`, never the tracked `.env` of a run that chose
|
|
46
46
|
`question.alternative.file`. It writes the key without printing it. Do not copy the key
|
|
47
47
|
yourself, and do not write a `sed`, `grep`, or `cat` command for it. If you cannot run
|
|
48
48
|
the command, for example because a sandbox refuses the path, ask the developer to run it.
|
|
49
49
|
Give them exactly this one line, with `<app directory>` as the directory that holds
|
|
50
50
|
`environmentPath`:
|
|
51
|
-
`! cd <app directory> && npx --prefer-offline --yes copilotkit@4.
|
|
51
|
+
`! cd <app directory> && npx --prefer-offline --yes copilotkit@4.29.0 onboard credentials --model-key <variable> --env-path <file> --copy-to <env file>`.
|
|
52
52
|
The command needs no input. Without `!`, they run the same command in a terminal.
|
|
53
53
|
Report the pause with
|
|
54
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
54
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard checkpoint --phase awaiting-model-credential`,
|
|
55
55
|
end your turn, and wait. When they reply, run the same command with `--json` and read `copiedKeys`.
|
|
56
56
|
If the developer declines the copy, the plan has the app read the key from an
|
|
57
57
|
environment variable that the developer sets. The plan then says how to set it. Never
|
|
@@ -69,7 +69,7 @@ never prints a value. Read `status`:
|
|
|
69
69
|
The `reason` `compatible-base-url-missing` or `key-not-openai` means that the key belongs
|
|
70
70
|
to an OpenAI-compatible provider, but no file names its base URL, so nothing was sent.
|
|
71
71
|
Ask the developer for the provider's base URL, record it with
|
|
72
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
72
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard setup-answers --vendor openai-compatible --base-url <url> --model-id <id>`,
|
|
73
73
|
and run this step again.
|
|
74
74
|
- `needs-developer` with `question.reason` `local-endpoint-no-key`: the base URL is a local
|
|
75
75
|
server that needs no key, such as Ollama or LM Studio. The OpenAI SDKs refuse an empty
|
|
@@ -113,4 +113,4 @@ Never read a file outside the project directory to find a credential: a key foun
|
|
|
113
113
|
bills another project. Asking for a path is not requesting a secret. A path the developer
|
|
114
114
|
names is theirs to give, including one outside the project. A path this run finds is not.
|
|
115
115
|
|
|
116
|
-
Then run `npx --prefer-offline --yes copilotkit@4.
|
|
116
|
+
Then run `npx --prefer-offline --yes copilotkit@4.29.0 onboard read credentials/write-plan`.
|
|
@@ -6,12 +6,10 @@ answer only when the plan makes a change that needs approval or still needs the
|
|
|
6
6
|
|
|
7
7
|
## If you stop in this phase
|
|
8
8
|
|
|
9
|
-
Name the exact file, value, or check that stopped you, then send one short report.
|
|
10
|
-
friction command follows the telemetry setting the developer already chose, so it needs no
|
|
11
|
-
separate question.
|
|
9
|
+
Name the exact file, value, or check that stopped you, then send one short report.
|
|
12
10
|
|
|
13
11
|
```text
|
|
14
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
12
|
+
npx --prefer-offline --yes copilotkit@4.29.0 onboard friction --phase stop --category <slug> --message "<sentences>"
|
|
15
13
|
```
|
|
16
14
|
|
|
17
15
|
`--message` takes one or two sentences: the step you stopped at and what stopped it.
|
|
@@ -38,11 +36,10 @@ so either mount works. Keep the mount the project already has, together with its
|
|
|
38
36
|
setting: `mode: "single-route"` with `useSingleEndpoint` true or unset, or the full route
|
|
39
37
|
subtree with `useSingleEndpoint={false}`. For a new mount, use the full route subtree below.
|
|
40
38
|
|
|
41
|
-
Below 1.73.1, mount the runtime on the full route subtree.
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
returns not found for every run and every thread reopen. The other fix is an upgrade of
|
|
39
|
+
Below 1.73.1, mount the runtime on the full route subtree. The Intelligence client of those
|
|
40
|
+
versions calls `/agent/<id>/run` and `/agent/<id>/connect` for every transport, so a
|
|
41
|
+
runtime mounted with `mode: "single-route"` returns not found for every run and every
|
|
42
|
+
thread reopen. The other fix is an upgrade of
|
|
46
43
|
the CopilotKit packages to 1.73.1 or later, which the plan can name as its dependency
|
|
47
44
|
upgrade. The round-trip check passes with either mount, so nothing later in this run
|
|
48
45
|
catches the mistake.
|
|
@@ -58,7 +55,7 @@ proof subagents:
|
|
|
58
55
|
- https://docs.copilotkit.ai/backend/runtime-endpoints.md
|
|
59
56
|
- https://docs.copilotkit.ai/intelligence/managed-intelligence-platform.md
|
|
60
57
|
|
|
61
|
-
Fetch them
|
|
58
|
+
Fetch them with the pages already selected, not on their own.
|
|
62
59
|
|
|
63
60
|
The planning subagent adds a threads drawer from the selected drawer page. If no drawer
|
|
64
61
|
page is selected yet, add the one for the frontend selected above to the same list:
|
|
@@ -73,25 +70,37 @@ When you start a subagent in the background, tell the developer in one sentence
|
|
|
73
70
|
does. Then send nothing more until it returns.
|
|
74
71
|
|
|
75
72
|
Spawn one planning subagent. Tell it to run
|
|
76
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
73
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard read subagent/create-plan` first and follow the
|
|
77
74
|
prompt it returns. Tell it to return at once, and say so, if that read is refused or fails,
|
|
78
|
-
and not to wait for an approval.
|
|
79
|
-
command yourself, then spawn a fresh subagent with the returned prompt and the same handoff.
|
|
75
|
+
and not to wait for an approval.
|
|
80
76
|
Give it the repository findings, selected framework, frontend, model, credential variable
|
|
81
77
|
names, selected documentation URLs, and documentation policy. Give it each finding that the
|
|
82
78
|
framework route told you to record, such as how the agent connects or a `clone()` finding.
|
|
83
|
-
|
|
79
|
+
On a
|
|
84
80
|
conversion, also give it the frozen criterion. Give the planning subagent the paths that
|
|
85
81
|
had uncommitted changes when the run started, from the repository findings, and the
|
|
86
82
|
`backup` result from `onboard credentials`. Also give it the JSON that
|
|
87
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
83
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard setup-answers` prints, so the plan does not ask again
|
|
88
84
|
for a change the setup message settled. Wait for the subagent to finish.
|
|
89
85
|
|
|
86
|
+
If only its closing `subagent-returned` checkpoint was refused, the subagent finished.
|
|
87
|
+
Record no `refused` return and spawn nothing: run that checkpoint yourself, with the result
|
|
88
|
+
the subagent returned.
|
|
89
|
+
|
|
90
|
+
If the subagent returns because its harness refused any other command, record that return:
|
|
91
|
+
|
|
92
|
+
```text
|
|
93
|
+
npx --prefer-offline --yes copilotkit@4.29.0 onboard checkpoint --phase subagent-returned --brief create-plan --result refused
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Then run that command yourself, from the directory the subagent named. Spawn at most one
|
|
97
|
+
fresh subagent for each refused command, with the same handoff and that command's result.
|
|
98
|
+
If the fresh subagent is refused a command too, spawn no other. Follow the brief yourself.
|
|
99
|
+
|
|
90
100
|
Continue only if the planning result starts with `Status: passed`. For `Status: failed`,
|
|
91
101
|
send the result back to the planning subagent for repair, up to three attempts. For
|
|
92
102
|
`Status: blocked`, or a third failed result, run
|
|
93
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
94
|
-
write is a run that broke, not a stack the documentation does not cover. The exception is
|
|
103
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard read stopped/run-failed`. The exception is
|
|
95
104
|
a blocked result that names `unsupported/no-validated-path`: the planning subagent found
|
|
96
105
|
that no page supports the plan, so take the no-supported-path route at the end of this
|
|
97
106
|
prompt instead. Do not show a
|
|
@@ -150,8 +159,7 @@ What I will change:
|
|
|
150
159
|
`onboard restore` puts back what the backup holds.
|
|
151
160
|
```
|
|
152
161
|
|
|
153
|
-
|
|
154
|
-
plan does not name.
|
|
162
|
+
Do not upgrade a dependency the plan does not name.
|
|
155
163
|
|
|
156
164
|
## Go on, or wait for one answer
|
|
157
165
|
|
|
@@ -170,7 +178,7 @@ approval or something blocks you. Before you end your turn to
|
|
|
170
178
|
wait for the answer, report the pause, each time you show the plan:
|
|
171
179
|
|
|
172
180
|
```text
|
|
173
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
181
|
+
npx --prefer-offline --yes copilotkit@4.29.0 onboard checkpoint --phase awaiting-plan-approval --reason <reasons>
|
|
174
182
|
```
|
|
175
183
|
|
|
176
184
|
`--reason` names why the plan stopped, one reason for each kind of line that needs approval, separated
|
|
@@ -196,18 +204,18 @@ If the plan carries a missing model key, the run cannot build without it, so wai
|
|
|
196
204
|
even when `Changes that need your approval` says `none`. Name the variable and its file in the plan message,
|
|
197
205
|
and ask the developer to add the key. Ask the approval question in the same message, if
|
|
198
206
|
there is one. When the plan has no change that needs approval, report the pause with
|
|
199
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
207
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard checkpoint --phase awaiting-model-credential`
|
|
200
208
|
instead. When the developer answers, run the same `onboard credentials --model-key` check
|
|
201
209
|
again. On `ready`, continue. If the key is still missing, ask the developer `question.ask`
|
|
202
210
|
in those words. Report the pause with
|
|
203
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
211
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard checkpoint --phase awaiting-model-credential`, end
|
|
204
212
|
your turn, and run the check again when they answer.
|
|
205
213
|
|
|
206
214
|
When the plan needs no answer, or after the developer answers, run
|
|
207
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
215
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard read implementation/build-and-validate`.
|
|
208
216
|
|
|
209
217
|
If no exact supported path or documentation URL exists, run
|
|
210
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
218
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard read unsupported/no-validated-path`.
|
|
211
219
|
|
|
212
220
|
## If the developer replies **stop**
|
|
213
221
|
|
|
@@ -217,10 +225,10 @@ run added stay, and that the restore also undoes any edit the developer made to
|
|
|
217
225
|
during the run. Before you end your turn to wait for the answer, report the pause:
|
|
218
226
|
|
|
219
227
|
```text
|
|
220
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
228
|
+
npx --prefer-offline --yes copilotkit@4.29.0 onboard checkpoint --phase awaiting-developer --about restore-files
|
|
221
229
|
```
|
|
222
230
|
|
|
223
|
-
If they say yes, run `npx --prefer-offline --yes copilotkit@4.
|
|
231
|
+
If they say yes, run `npx --prefer-offline --yes copilotkit@4.29.0 onboard restore --force`. The run has
|
|
224
232
|
not ended yet, so without `--force` the restore cannot tell the run's edits from the
|
|
225
233
|
developer's and skips every changed file. Show the developer what it restored and what it
|
|
226
234
|
skipped. If they say no, change nothing. Then send the stop report from the start of this
|
|
@@ -9,15 +9,15 @@ A local request can arrive after this run created a hosted project: `init --crea
|
|
|
9
9
|
Tell the developer that this run already created a hosted project, so it stays managed.
|
|
10
10
|
Return to the step you were on.
|
|
11
11
|
|
|
12
|
-
First run `npx --prefer-offline --yes copilotkit@4.
|
|
12
|
+
First run `npx --prefer-offline --yes copilotkit@4.29.0 local --help`. If it does not list `setup`
|
|
13
13
|
("Configure model access and install or resume the local stack"), this release has no
|
|
14
14
|
local evaluation. Tell the developer so, and keep managed. If this run has not recorded
|
|
15
|
-
managed yet, run `npx --prefer-offline --yes copilotkit@4.
|
|
15
|
+
managed yet, run `npx --prefer-offline --yes copilotkit@4.29.0 onboard deployment --choice managed`.
|
|
16
16
|
Then return to “Check sign-in” in the start prompt. If a login process from it still
|
|
17
17
|
runs, keep reading that process and start no second one. Otherwise record the choice:
|
|
18
18
|
|
|
19
19
|
```text
|
|
20
|
-
npx --prefer-offline --yes copilotkit@4.
|
|
20
|
+
npx --prefer-offline --yes copilotkit@4.29.0 onboard deployment --choice local
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
Explain these conditions before sign-in:
|
|
@@ -48,10 +48,10 @@ choices:
|
|
|
48
48
|
|
|
49
49
|
1. Configure later, the default. Install with `--defer-model`. In the closing report, write
|
|
50
50
|
"Learning configuration incomplete". Name the command that adds the model later:
|
|
51
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
51
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 local setup`, run in a terminal in the app directory.
|
|
52
52
|
2. Guided setup. If the developer named Learning as a goal, offer it first. Install
|
|
53
53
|
the stack with `--defer-model`. After the stack is ready, the developer runs
|
|
54
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
54
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 local setup` in their own terminal window, in the app
|
|
55
55
|
directory. Never give it as a `!` line: its guided prompt needs a terminal, and a coding
|
|
56
56
|
agent's shell has none. The prompt asks for the model and its key, and it saves them
|
|
57
57
|
privately. On a running stack, it restarts only Learning. Do not ask the developer to
|
|
@@ -71,7 +71,7 @@ If the managed sign-in message was already sent, send this once and no other sig
|
|
|
71
71
|
message: “You asked to run it locally, so this project gets no managed CopilotKit project.
|
|
72
72
|
Signing in only gets the renewable evaluation license.”
|
|
73
73
|
|
|
74
|
-
Otherwise run `npx --prefer-offline --yes copilotkit@4.
|
|
74
|
+
Otherwise run `npx --prefer-offline --yes copilotkit@4.29.0 login --json`. Follow the streaming sign-in
|
|
75
75
|
protocol from “Check sign-in” in the start prompt: open the first authentication URL
|
|
76
76
|
once, keep the same process running, and continue only after its completed record.
|
|
77
77
|
When the first authentication URL arrives, send this message in place of the managed
|
|
@@ -79,9 +79,9 @@ sign-in message: “Sign in to get the renewable evaluation license. Your local
|
|
|
79
79
|
will use CLI approval.”
|
|
80
80
|
On failed or declined sign-in, take the failure path below.
|
|
81
81
|
|
|
82
|
-
After sign-in completes, report it: `npx --prefer-offline --yes copilotkit@4.
|
|
82
|
+
After sign-in completes, report it: `npx --prefer-offline --yes copilotkit@4.29.0 onboard checkpoint --phase sign-in-settled`.
|
|
83
83
|
Then continue with
|
|
84
|
-
`npx --prefer-offline --yes copilotkit@4.
|
|
84
|
+
`npx --prefer-offline --yes copilotkit@4.29.0 onboard read research/gather`, unless research already started.
|
|
85
85
|
If it already started, return to the step you were on. `starter/clone` and
|
|
86
86
|
`credentials/finalize-plan` each have a branch for a recorded local choice.
|
|
87
87
|
Keep the local choice and collected paths in the run's plan and worker context.
|
|
@@ -89,4 +89,4 @@ Keep the local choice and collected paths in the run's plan and worker context.
|
|
|
89
89
|
## Failure path
|
|
90
90
|
|
|
91
91
|
If sign-in fails or is declined, stop before cluster creation.
|
|
92
|
-
Run `npx --prefer-offline --yes copilotkit@4.
|
|
92
|
+
Run `npx --prefer-offline --yes copilotkit@4.29.0 onboard read stopped/run-failed`.
|