copilotkit 4.10.0 → 4.11.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 +14 -4
- package/cli-build-info.json +8 -8
- package/index.js +150 -43
- package/onboarding/index.json +26 -1
- package/onboarding/prompts/authenticate/start.md +27 -13
- package/onboarding/prompts/conversion/plan.md +3 -3
- package/onboarding/prompts/credentials/finalize-plan.md +30 -21
- package/onboarding/prompts/credentials/plan.md +20 -20
- package/onboarding/prompts/credentials/settle-credentials.md +9 -9
- package/onboarding/prompts/credentials/write-plan.md +7 -7
- package/onboarding/prompts/fallback/best-effort.md +9 -8
- package/onboarding/prompts/feature/a2ui/implement.md +6 -6
- package/onboarding/prompts/feature/a2ui/proof.md +6 -6
- package/onboarding/prompts/feature/a2ui/start.md +7 -7
- package/onboarding/prompts/feature/channels/implement.md +70 -0
- package/onboarding/prompts/feature/channels/proof.md +60 -0
- package/onboarding/prompts/feature/channels/start.md +90 -0
- package/onboarding/prompts/feature/chat-suggestions/implement.md +6 -6
- package/onboarding/prompts/feature/chat-suggestions/proof.md +6 -6
- package/onboarding/prompts/feature/chat-suggestions/start.md +7 -7
- package/onboarding/prompts/feature/complete.md +1 -1
- package/onboarding/prompts/feature/learning/implement.md +12 -12
- package/onboarding/prompts/feature/learning/proof.md +7 -7
- package/onboarding/prompts/feature/learning/start.md +6 -6
- package/onboarding/prompts/feature/open-generative-ui/implement.md +6 -6
- package/onboarding/prompts/feature/open-generative-ui/proof.md +6 -6
- package/onboarding/prompts/feature/open-generative-ui/start.md +7 -7
- package/onboarding/prompts/feature/realtime-sync/implement.md +7 -7
- package/onboarding/prompts/feature/realtime-sync/proof.md +6 -6
- package/onboarding/prompts/feature/realtime-sync/start.md +6 -6
- package/onboarding/prompts/feature/rich-threads/implement.md +8 -8
- package/onboarding/prompts/feature/rich-threads/proof.md +6 -6
- package/onboarding/prompts/feature/rich-threads/start.md +6 -6
- package/onboarding/prompts/feature/stop.md +12 -6
- package/onboarding/prompts/feature/voice/implement.md +6 -6
- package/onboarding/prompts/feature/voice/proof.md +6 -6
- package/onboarding/prompts/feature/voice/start.md +7 -7
- package/onboarding/prompts/framework/ag2.md +2 -2
- package/onboarding/prompts/framework/agno.md +2 -2
- package/onboarding/prompts/framework/built-in.md +2 -2
- package/onboarding/prompts/framework/claude-sdk-python.md +2 -2
- package/onboarding/prompts/framework/claude-sdk-typescript.md +2 -2
- package/onboarding/prompts/framework/crewai-flows.md +2 -2
- package/onboarding/prompts/framework/deep-agents.md +2 -2
- package/onboarding/prompts/framework/google-adk.md +2 -2
- package/onboarding/prompts/framework/langgraph-fastapi.md +2 -2
- package/onboarding/prompts/framework/langgraph-python.md +2 -2
- package/onboarding/prompts/framework/langgraph-typescript.md +2 -2
- package/onboarding/prompts/framework/llamaindex.md +2 -2
- package/onboarding/prompts/framework/mastra.md +2 -2
- package/onboarding/prompts/framework/ms-agent-dotnet.md +2 -2
- package/onboarding/prompts/framework/ms-agent-harness-dotnet.md +2 -2
- package/onboarding/prompts/framework/ms-agent-python.md +2 -2
- package/onboarding/prompts/framework/pydantic-ai.md +2 -2
- package/onboarding/prompts/framework/strands-python.md +2 -2
- package/onboarding/prompts/framework/strands-typescript.md +2 -2
- package/onboarding/prompts/frontend/angular.md +3 -3
- package/onboarding/prompts/frontend/nextjs.md +3 -3
- package/onboarding/prompts/frontend/plan.md +17 -12
- package/onboarding/prompts/frontend/react-native.md +2 -2
- package/onboarding/prompts/frontend/react-spa.md +2 -2
- package/onboarding/prompts/frontend/vue.md +2 -2
- package/onboarding/prompts/implementation/build-and-validate.md +29 -17
- package/onboarding/prompts/proof/complete.md +22 -14
- package/onboarding/prompts/proof/oss-baseline.md +5 -5
- package/onboarding/prompts/proof/round-trip.md +16 -15
- package/onboarding/prompts/research/gather.md +18 -4
- package/onboarding/prompts/research/route.md +9 -10
- package/onboarding/prompts/starter/clone.md +6 -6
- package/onboarding/prompts/stopped/run-failed.md +3 -3
- package/onboarding/prompts/subagent/create-plan.md +1 -1
- package/onboarding/prompts/subagent/prove-oss-baseline.md +1 -1
- package/onboarding/prompts/subagent/prove-round-trip.md +32 -15
- package/onboarding/prompts/unsupported/no-validated-path.md +4 -4
- package/package.json +1 -1
- package/release/release-tool.js +1 -1
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Run this before anything else in this prompt, including the welcome message below:
|
|
6
6
|
|
|
7
7
|
```text
|
|
8
|
-
npx --yes copilotkit@4.
|
|
8
|
+
npx --yes copilotkit@4.11.0 onboard identify --coding-agent <coding-agent-slug>
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
Report your own product with one short slug, such as `codex` or `claude-code`.
|
|
@@ -37,7 +37,7 @@ Every later command must run from the directory this run started in. A command r
|
|
|
37
37
|
somewhere else, such as a sibling of that directory, is refused rather than answered,
|
|
38
38
|
because the run it belongs to cannot be found from there. That refusal is a step to take,
|
|
39
39
|
not a stop to report: run
|
|
40
|
-
`npx --yes copilotkit@4.
|
|
40
|
+
`npx --yes copilotkit@4.11.0 onboard start --run <onboarding_run_id>` in the directory
|
|
41
41
|
you are now in, which binds it to the same run, then run the refused command again. Do not
|
|
42
42
|
start a run without that id. A run started without it is a second run, and the work already
|
|
43
43
|
done stops counting toward the first.
|
|
@@ -48,12 +48,18 @@ question from the documentation this graph gives you. Another checkout on this m
|
|
|
48
48
|
not a source. The developer running this has none, so an answer taken from one is an
|
|
49
49
|
answer they cannot get, and it hides the documentation gap that blocks them.
|
|
50
50
|
|
|
51
|
+
Say `CopilotKit Intelligence` in full the first time you name the platform, and never the
|
|
52
|
+
bare word `Intelligence`: it names nothing a developer has met yet. In a question, leave
|
|
53
|
+
the product name out and say what they get. This governs what you say, not the flags you
|
|
54
|
+
pass.
|
|
55
|
+
|
|
51
56
|
Send this exact message once, as your first message in this onboarding run, before
|
|
52
57
|
anything else:
|
|
53
58
|
|
|
54
59
|
Welcome to CopilotKit. By the end of this run your own application talks to an AI agent,
|
|
55
60
|
and its chat history stays. A user can close the tab, come back, and reopen any past
|
|
56
|
-
conversation in full. The managed Intelligence platform is what keeps them. I
|
|
61
|
+
conversation in full. The managed CopilotKit Intelligence platform is what keeps them. I
|
|
62
|
+
prove that
|
|
57
63
|
round trip in the running app before I call it done. You finish with working software and
|
|
58
64
|
the evidence that it works.
|
|
59
65
|
|
|
@@ -74,15 +80,27 @@ first send, and a developer who reads it repeatedly learns to skim the region it
|
|
|
74
80
|
Do not ask for separate feedback consent. The feedback commands enforce the developer's
|
|
75
81
|
CLI telemetry setting when a later step tries to send a report.
|
|
76
82
|
|
|
83
|
+
## Where commands run
|
|
84
|
+
|
|
85
|
+
Run every command from the directory this run started in. That directory is the run root,
|
|
86
|
+
and every `--path` argument is read against it rather than against wherever you are
|
|
87
|
+
standing, so one path names one file from anywhere in the project.
|
|
88
|
+
|
|
89
|
+
One command is deliberately different. `project select` writes the credential into the
|
|
90
|
+
`.env` beside the directory it runs in, because that is the file the application process
|
|
91
|
+
loads. Run it from the directory whose application reads that file. It hoists the project
|
|
92
|
+
record to the repository root by itself and prints where it put it.
|
|
93
|
+
|
|
77
94
|
## Report a stop, wherever it happens
|
|
78
95
|
|
|
79
96
|
This run reports its own stops. If you stop this run at any point, send one short report
|
|
80
97
|
before you stop. That covers a stop this prompt names, a stop a later prompt names, and a
|
|
81
|
-
stop no prompt anticipated, including one your own harness causes. Run the friction
|
|
82
|
-
|
|
98
|
+
stop no prompt anticipated, including one your own harness causes. Run the friction
|
|
99
|
+
command without another developer question. Do not ask the developer about telemetry: the
|
|
100
|
+
command applies the setting they already have.
|
|
83
101
|
|
|
84
102
|
```text
|
|
85
|
-
npx --yes copilotkit@4.
|
|
103
|
+
npx --yes copilotkit@4.11.0 onboard friction --phase stop --category <slug>
|
|
86
104
|
```
|
|
87
105
|
|
|
88
106
|
Write one or two sentences to standard input: the step you stopped at and what stopped it.
|
|
@@ -97,13 +115,9 @@ Reporting a stop is not a route change. It does not resume the run, it is not a
|
|
|
97
115
|
for the developer, and it does not replace whatever the rule that stopped you says to do
|
|
98
116
|
next: send the report, then stop.
|
|
99
117
|
|
|
100
|
-
Until now the route out of an unsupported path was the only place that asked for a report,
|
|
101
|
-
so a stop anywhere else left no trace at all. A stop nobody hears about is a stop this
|
|
102
|
-
graph cannot fix.
|
|
103
|
-
|
|
104
118
|
## Check sign-in
|
|
105
119
|
|
|
106
|
-
Run `npx --yes copilotkit@4.
|
|
120
|
+
Run `npx --yes copilotkit@4.11.0 login --json` before any project work. This command
|
|
107
121
|
checks the current session. It starts sign-in only as needed. Treat this as a long-lived
|
|
108
122
|
streaming process. Do not wait for the command to exit before you read its standard output.
|
|
109
123
|
|
|
@@ -139,8 +153,8 @@ Do not use `whoami` for this check. It has no JSON output and some failures exit
|
|
|
139
153
|
zero. Do not put account tokens or credentials in the conversation.
|
|
140
154
|
|
|
141
155
|
When sign-in is settled, run
|
|
142
|
-
`npx --yes copilotkit@4.
|
|
156
|
+
`npx --yes copilotkit@4.11.0 onboard read research/gather`.
|
|
143
157
|
|
|
144
158
|
If sign-in stops onboarding, run
|
|
145
|
-
`npx --yes copilotkit@4.
|
|
159
|
+
`npx --yes copilotkit@4.11.0 onboard read stopped/run-failed`. It says nothing about
|
|
146
160
|
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 --yes copilotkit@4.
|
|
103
|
+
fifth item is proved by `npx --yes copilotkit@4.11.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 --yes copilotkit@4.
|
|
119
|
+
Then run `npx --yes copilotkit@4.11.0 onboard read credentials/finalize-plan`.
|
|
120
120
|
|
|
121
121
|
If a selected page does not load after the second method, run
|
|
122
|
-
`npx --yes copilotkit@4.
|
|
122
|
+
`npx --yes copilotkit@4.11.0 onboard read unsupported/no-validated-path`.
|
|
@@ -9,21 +9,21 @@ a secret value.
|
|
|
9
9
|
|
|
10
10
|
Use a gentle wizard. Ask one short question at a time. Do not combine separate choices in
|
|
11
11
|
one question. Put the recommendation first, give its evidence in one sentence, and keep
|
|
12
|
-
the alternatives short. When project selection is unknown, ask only which
|
|
13
|
-
|
|
12
|
+
the alternatives short. When project selection is unknown, ask only which project to
|
|
13
|
+
use. Keep final plan approval as its own later question.
|
|
14
14
|
|
|
15
15
|
## If you stop in this phase
|
|
16
16
|
|
|
17
17
|
Several rules below stop onboarding: a refused classification value, a project selection
|
|
18
18
|
that reports a false field, a failed credential check, a model credential nobody can
|
|
19
|
-
place. Each one ends a run that reached project selection and never got a plan
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
19
|
+
place. Each one ends a run that reached project selection and never got a plan. Name the
|
|
20
|
+
exact file, value, or check that stopped you: a report that names only the step cannot be
|
|
21
|
+
acted on. Send one short report before you stop. Run the friction command without another
|
|
22
|
+
developer question. Do not ask the developer about telemetry: the command applies the
|
|
23
|
+
setting they already have.
|
|
24
24
|
|
|
25
25
|
```text
|
|
26
|
-
npx --yes copilotkit@4.
|
|
26
|
+
npx --yes copilotkit@4.11.0 onboard friction --phase stop --category <slug>
|
|
27
27
|
```
|
|
28
28
|
|
|
29
29
|
Write one or two sentences to standard input: the step you stopped at and what stopped it.
|
|
@@ -58,7 +58,7 @@ the command refuses one of them from a run that was served that node.
|
|
|
58
58
|
Run this command with the exact selected slugs:
|
|
59
59
|
|
|
60
60
|
```text
|
|
61
|
-
npx --yes copilotkit@4.
|
|
61
|
+
npx --yes copilotkit@4.11.0 onboard classify --starting-state <starting-state> --agent-framework <agent-framework> --frontend <frontend>
|
|
62
62
|
```
|
|
63
63
|
|
|
64
64
|
Do not continue if a value is refused. Fix the value from the choices that the earlier
|
|
@@ -131,11 +131,14 @@ way to finish.
|
|
|
131
131
|
### Create a project for this directory
|
|
132
132
|
|
|
133
133
|
No project is bound to this directory, so creating a project for this directory is the
|
|
134
|
-
default. Take the name from the directory that holds the expected project-record path.
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
134
|
+
default. Take the name from the directory that holds the expected project-record path.
|
|
135
|
+
|
|
136
|
+
The CLI refuses a name that says nothing: a layer word from `project`, `app`, `apps`,
|
|
137
|
+
`src`, `web`, `frontend`, `backend`, `server`, `packages`, `repo`, a scratch name such as
|
|
138
|
+
`run-a`, `test-2`, or `tmp`, and anything under three characters. When the directory name
|
|
139
|
+
is one of those, use the nearest enclosing directory whose name is not. Ask when no
|
|
140
|
+
enclosing directory passes either: the parent of a scratch directory is usually another
|
|
141
|
+
one, and a second derived guess collides with the first.
|
|
139
142
|
|
|
140
143
|
Ask one question: confirm that name, give another, or ask to use a project they already
|
|
141
144
|
have. Name that third answer, so a developer who has one is not asked to guess
|
|
@@ -149,12 +152,16 @@ a project from a listing without an answer that names it. A project another run
|
|
|
149
152
|
minutes ago reads exactly like this directory's own, and every check after the selection
|
|
150
153
|
passes against the wrong one.
|
|
151
154
|
|
|
152
|
-
Create it, from the target directory:
|
|
155
|
+
Create it, from the target directory, passing the port research settled:
|
|
153
156
|
|
|
154
157
|
```text
|
|
155
|
-
npx --yes copilotkit@4.
|
|
158
|
+
npx --yes copilotkit@4.11.0 project select --create <name> \
|
|
159
|
+
--runtime-url http://localhost:<port>/api/copilotkit --json
|
|
156
160
|
```
|
|
157
161
|
|
|
162
|
+
`--runtime-url` is the only place the settled port is written down. Give the URL the
|
|
163
|
+
application serves on, mount path included.
|
|
164
|
+
|
|
158
165
|
If the command fails as a duplicate, the organization already holds that display name and
|
|
159
166
|
the refusal names the colliding slug. Do not select the colliding project. Ask whether that
|
|
160
167
|
project is this app's. If no developer answers, run the command again with the next free
|
|
@@ -166,13 +173,13 @@ Take this branch only when the developer asks for an existing project, or asks t
|
|
|
166
173
|
projects they have. Read the choices:
|
|
167
174
|
|
|
168
175
|
```text
|
|
169
|
-
npx --yes copilotkit@4.
|
|
176
|
+
npx --yes copilotkit@4.11.0 project list --json
|
|
170
177
|
```
|
|
171
178
|
|
|
172
179
|
Narrow them:
|
|
173
180
|
|
|
174
181
|
```text
|
|
175
|
-
npx --yes copilotkit@4.
|
|
182
|
+
npx --yes copilotkit@4.11.0 project list --search <query> --json
|
|
176
183
|
```
|
|
177
184
|
|
|
178
185
|
With `--json` the payload is the only thing on standard output, so it is safe to parse. Do
|
|
@@ -181,10 +188,12 @@ more. Do not order the projects by creation time: the newest project in the orga
|
|
|
181
188
|
the one another run created while this one was working, and it is the least likely to be
|
|
182
189
|
this directory's.
|
|
183
190
|
|
|
184
|
-
Then record the project they name, from the target directory
|
|
191
|
+
Then record the project they name, from the target directory, with the same
|
|
192
|
+
`--runtime-url`:
|
|
185
193
|
|
|
186
194
|
```text
|
|
187
|
-
npx --yes copilotkit@4.
|
|
195
|
+
npx --yes copilotkit@4.11.0 project select --project <slug-or-id> \
|
|
196
|
+
--runtime-url http://localhost:<port>/api/copilotkit --json
|
|
188
197
|
```
|
|
189
198
|
|
|
190
199
|
The two flags cannot be combined. A slug that does not exist fails and lists the real ones,
|
|
@@ -226,4 +235,4 @@ project-record path and environment path as the credential setup path list. Do n
|
|
|
226
235
|
to the baseline yet.
|
|
227
236
|
|
|
228
237
|
When project selection is settled, run
|
|
229
|
-
`npx --yes copilotkit@4.
|
|
238
|
+
`npx --yes copilotkit@4.11.0 onboard read credentials/settle-credentials`.
|
|
@@ -68,26 +68,26 @@ another framework. Do not show the internal route.
|
|
|
68
68
|
|
|
69
69
|
Use exactly one matching internal route:
|
|
70
70
|
|
|
71
|
-
1. AG2: `npx --yes copilotkit@4.
|
|
72
|
-
2. Agno: `npx --yes copilotkit@4.
|
|
73
|
-
3. Built-in CopilotKit agent: `npx --yes copilotkit@4.
|
|
74
|
-
4. Claude Agent SDK Python: `npx --yes copilotkit@4.
|
|
75
|
-
5. Claude Agent SDK TypeScript: `npx --yes copilotkit@4.
|
|
76
|
-
6. CrewAI Flows: `npx --yes copilotkit@4.
|
|
77
|
-
7. Deep Agents: `npx --yes copilotkit@4.
|
|
78
|
-
8. LangGraph Python: `npx --yes copilotkit@4.
|
|
79
|
-
9. LangGraph FastAPI: `npx --yes copilotkit@4.
|
|
80
|
-
10. LangGraph TypeScript: `npx --yes copilotkit@4.
|
|
81
|
-
11. LlamaIndex: `npx --yes copilotkit@4.
|
|
82
|
-
12. ADK: `npx --yes copilotkit@4.
|
|
83
|
-
13. Microsoft Agent Framework Python: `npx --yes copilotkit@4.
|
|
84
|
-
14. Microsoft Agent Framework .NET: `npx --yes copilotkit@4.
|
|
85
|
-
15. Mastra: `npx --yes copilotkit@4.
|
|
86
|
-
16. MS Agent Harness .NET: `npx --yes copilotkit@4.
|
|
87
|
-
17. Pydantic AI: `npx --yes copilotkit@4.
|
|
88
|
-
18. Strands Agents Python: `npx --yes copilotkit@4.
|
|
89
|
-
19. Strands Agents TypeScript: `npx --yes copilotkit@4.
|
|
71
|
+
1. AG2: `npx --yes copilotkit@4.11.0 onboard read framework/ag2`
|
|
72
|
+
2. Agno: `npx --yes copilotkit@4.11.0 onboard read framework/agno`
|
|
73
|
+
3. Built-in CopilotKit agent: `npx --yes copilotkit@4.11.0 onboard read framework/built-in`
|
|
74
|
+
4. Claude Agent SDK Python: `npx --yes copilotkit@4.11.0 onboard read framework/claude-sdk-python`
|
|
75
|
+
5. Claude Agent SDK TypeScript: `npx --yes copilotkit@4.11.0 onboard read framework/claude-sdk-typescript`
|
|
76
|
+
6. CrewAI Flows: `npx --yes copilotkit@4.11.0 onboard read framework/crewai-flows`
|
|
77
|
+
7. Deep Agents: `npx --yes copilotkit@4.11.0 onboard read framework/deep-agents`
|
|
78
|
+
8. LangGraph Python: `npx --yes copilotkit@4.11.0 onboard read framework/langgraph-python`
|
|
79
|
+
9. LangGraph FastAPI: `npx --yes copilotkit@4.11.0 onboard read framework/langgraph-fastapi`
|
|
80
|
+
10. LangGraph TypeScript: `npx --yes copilotkit@4.11.0 onboard read framework/langgraph-typescript`
|
|
81
|
+
11. LlamaIndex: `npx --yes copilotkit@4.11.0 onboard read framework/llamaindex`
|
|
82
|
+
12. ADK: `npx --yes copilotkit@4.11.0 onboard read framework/google-adk`
|
|
83
|
+
13. Microsoft Agent Framework Python: `npx --yes copilotkit@4.11.0 onboard read framework/ms-agent-python`
|
|
84
|
+
14. Microsoft Agent Framework .NET: `npx --yes copilotkit@4.11.0 onboard read framework/ms-agent-dotnet`
|
|
85
|
+
15. Mastra: `npx --yes copilotkit@4.11.0 onboard read framework/mastra`
|
|
86
|
+
16. MS Agent Harness .NET: `npx --yes copilotkit@4.11.0 onboard read framework/ms-agent-harness-dotnet`
|
|
87
|
+
17. Pydantic AI: `npx --yes copilotkit@4.11.0 onboard read framework/pydantic-ai`
|
|
88
|
+
18. Strands Agents Python: `npx --yes copilotkit@4.11.0 onboard read framework/strands-python`
|
|
89
|
+
19. Strands Agents TypeScript: `npx --yes copilotkit@4.11.0 onboard read framework/strands-typescript`
|
|
90
90
|
|
|
91
91
|
If the project has an agent in another framework, or no listed framework fits, keep the
|
|
92
92
|
developer's current agent and run
|
|
93
|
-
`npx --yes copilotkit@4.
|
|
93
|
+
`npx --yes copilotkit@4.11.0 onboard read unsupported/no-validated-path`.
|
|
@@ -7,11 +7,11 @@ not read, show, store, or request a secret value.
|
|
|
7
7
|
## If you stop in this phase
|
|
8
8
|
|
|
9
9
|
Name the exact file, value, or check that stopped you, then send one short report. Run the
|
|
10
|
-
friction command without another developer question.
|
|
11
|
-
the
|
|
10
|
+
friction command without another developer question. Do not ask the developer about
|
|
11
|
+
telemetry: the command applies the setting they already have.
|
|
12
12
|
|
|
13
13
|
```text
|
|
14
|
-
npx --yes copilotkit@4.
|
|
14
|
+
npx --yes copilotkit@4.11.0 onboard friction --phase stop --category <slug>
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
Write one or two sentences to standard input: the step you stopped at and what stopped it.
|
|
@@ -47,7 +47,7 @@ skip this step and name the skip, rather than inventing a name.
|
|
|
47
47
|
Then ask the platform about that id, from the target directory:
|
|
48
48
|
|
|
49
49
|
```text
|
|
50
|
-
npx --yes copilotkit@4.
|
|
50
|
+
npx --yes copilotkit@4.11.0 learning containers get <id> --json
|
|
51
51
|
```
|
|
52
52
|
|
|
53
53
|
The read carries the same availability gate as the create, so it answers the entitlement
|
|
@@ -72,7 +72,7 @@ Never invent an id, scrape a dashboard, or treat an arbitrary string as a contai
|
|
|
72
72
|
Report what the read found, before anything is planned:
|
|
73
73
|
|
|
74
74
|
```text
|
|
75
|
-
npx --yes copilotkit@4.
|
|
75
|
+
npx --yes copilotkit@4.11.0 onboard checkpoint --phase container-surveyed
|
|
76
76
|
```
|
|
77
77
|
|
|
78
78
|
Carry the derived id into the planning subagent's handoff, with whether the platform
|
|
@@ -102,7 +102,7 @@ protected path list. Also add each project file that the developer changed for m
|
|
|
102
102
|
credentials. Record them in the baseline from the target app directory:
|
|
103
103
|
|
|
104
104
|
```text
|
|
105
|
-
npx --yes copilotkit@4.
|
|
105
|
+
npx --yes copilotkit@4.11.0 onboard protect --path <path>
|
|
106
106
|
```
|
|
107
107
|
|
|
108
108
|
Pass one `--path` for each. The command captures a digest for each path and never re-reads
|
|
@@ -116,7 +116,7 @@ Then re-capture the files this graph wrote itself. For each path the first captu
|
|
|
116
116
|
as `deferred` that this run has now written, run:
|
|
117
117
|
|
|
118
118
|
```text
|
|
119
|
-
npx --yes copilotkit@4.
|
|
119
|
+
npx --yes copilotkit@4.11.0 onboard protect --rebaseline --path <path>
|
|
120
120
|
```
|
|
121
121
|
|
|
122
122
|
From that point they are protected like any other path, so a later step that rewrites
|
|
@@ -135,7 +135,7 @@ environment path. The command below is what to run at that point, from the targe
|
|
|
135
135
|
directory:
|
|
136
136
|
|
|
137
137
|
```text
|
|
138
|
-
npx --yes copilotkit@4.
|
|
138
|
+
npx --yes copilotkit@4.11.0 onboard protect --accept-credential --path <environment path>
|
|
139
139
|
```
|
|
140
140
|
|
|
141
141
|
The command compares the variable names the baseline recorded with the names the file holds
|
|
@@ -150,4 +150,4 @@ now. Read its result:
|
|
|
150
150
|
is not a failed step. It answers the question and the run carries on.
|
|
151
151
|
|
|
152
152
|
When the credential question is answered, run
|
|
153
|
-
`npx --yes copilotkit@4.
|
|
153
|
+
`npx --yes copilotkit@4.11.0 onboard read credentials/write-plan`.
|
|
@@ -7,11 +7,11 @@ the run needs from them.
|
|
|
7
7
|
## If you stop in this phase
|
|
8
8
|
|
|
9
9
|
Name the exact file, value, or check that stopped you, then send one short report. Run the
|
|
10
|
-
friction command without another developer question.
|
|
11
|
-
the
|
|
10
|
+
friction command without another developer question. Do not ask the developer about
|
|
11
|
+
telemetry: the command applies the setting they already have.
|
|
12
12
|
|
|
13
13
|
```text
|
|
14
|
-
npx --yes copilotkit@4.
|
|
14
|
+
npx --yes copilotkit@4.11.0 onboard friction --phase stop --category <slug>
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
Write one or two sentences to standard input: the step you stopped at and what stopped it.
|
|
@@ -52,7 +52,7 @@ proof subagents:
|
|
|
52
52
|
Fetch them together with the pages already selected rather than on their own.
|
|
53
53
|
|
|
54
54
|
Spawn one planning subagent. Tell it to run
|
|
55
|
-
`npx --yes copilotkit@4.
|
|
55
|
+
`npx --yes copilotkit@4.11.0 onboard read subagent/create-plan` first and follow the prompt
|
|
56
56
|
it returns. If that read fails because the subagent cannot use the shell, stop that subagent.
|
|
57
57
|
Run the same command yourself, then spawn a fresh subagent with the returned prompt and the
|
|
58
58
|
same handoff. Give it the repository findings, selected framework, frontend, model, credential
|
|
@@ -63,7 +63,7 @@ Wait for the subagent to finish.
|
|
|
63
63
|
Continue only if the planning result starts with `Status: passed`. For `Status: failed`,
|
|
64
64
|
send the result back to the planning subagent for repair, up to three attempts. For
|
|
65
65
|
`Status: blocked`, or a third failed result, run
|
|
66
|
-
`npx --yes copilotkit@4.
|
|
66
|
+
`npx --yes copilotkit@4.11.0 onboard read stopped/run-failed`. A plan this run cannot
|
|
67
67
|
write is a run that broke, not a stack the documentation does not cover. Do not show or
|
|
68
68
|
ask for approval of a non-pass plan.
|
|
69
69
|
|
|
@@ -87,7 +87,7 @@ that waits at the terminal through all of them for a question that never comes.
|
|
|
87
87
|
the same message as the plan, and do not turn it into a second question.
|
|
88
88
|
|
|
89
89
|
If the developer approves the plan, run
|
|
90
|
-
`npx --yes copilotkit@4.
|
|
90
|
+
`npx --yes copilotkit@4.11.0 onboard read implementation/build-and-validate`.
|
|
91
91
|
|
|
92
92
|
If no exact supported path or documentation URL exists, run
|
|
93
|
-
`npx --yes copilotkit@4.
|
|
93
|
+
`npx --yes copilotkit@4.11.0 onboard read unsupported/no-validated-path`.
|
|
@@ -9,11 +9,12 @@ This fallback contains unproved steps. Use the approved plan in step order.
|
|
|
9
9
|
|
|
10
10
|
Several rules below stop onboarding: a blocked or third failed implementation result, a
|
|
11
11
|
changed protected path, a blocked or third failed proof, a fix that needs changes to the
|
|
12
|
-
existing agent or frontend. Send one short report before you stop. Run the friction
|
|
13
|
-
|
|
12
|
+
existing agent or frontend. Send one short report before you stop. Run the friction
|
|
13
|
+
command without another developer question. Do not ask the developer about telemetry: the
|
|
14
|
+
command applies the setting they already have.
|
|
14
15
|
|
|
15
16
|
```text
|
|
16
|
-
npx --yes copilotkit@4.
|
|
17
|
+
npx --yes copilotkit@4.11.0 onboard friction --phase stop --category <slug>
|
|
17
18
|
```
|
|
18
19
|
|
|
19
20
|
Write one or two sentences to standard input: the step you stopped at and what stopped it.
|
|
@@ -59,13 +60,13 @@ stop.
|
|
|
59
60
|
|
|
60
61
|
Use these rules for every protected-path check in this fallback:
|
|
61
62
|
|
|
62
|
-
- Run `npx --yes copilotkit@4.
|
|
63
|
+
- Run `npx --yes copilotkit@4.11.0 onboard audit` from the target app directory.
|
|
63
64
|
- If a result starts with `Status: blocked`, stop onboarding and report the printed reason.
|
|
64
65
|
It proved nothing changed, so do not report a preservation failure.
|
|
65
66
|
- If a result reports a changed protected path this run wrote, stop onboarding.
|
|
66
67
|
- If a result reports a changed path that no Files changed section from this run names,
|
|
67
68
|
the change came from outside the run. Accept it by name with
|
|
68
|
-
`npx --yes copilotkit@4.
|
|
69
|
+
`npx --yes copilotkit@4.11.0 onboard protect --accept-external --path <path>`, run the
|
|
69
70
|
audit again, and name it in the closing report.
|
|
70
71
|
- If no Files changed section from this run covers the step that wrote it, stop
|
|
71
72
|
onboarding. The proof subagent here returns no such section, so a finding it raises is
|
|
@@ -118,13 +119,13 @@ application passes proof. Report each tool result separately from the proof resu
|
|
|
118
119
|
Report the documentation gap and each assumption with the proof evidence. Do not claim
|
|
119
120
|
that the selected documentation proved an inferred step.
|
|
120
121
|
|
|
121
|
-
When the proof is complete, run `npx --yes copilotkit@4.
|
|
122
|
+
When the proof is complete, run `npx --yes copilotkit@4.11.0 onboard complete`, carrying the
|
|
122
123
|
surface-check result the proof subagent returned. Pass exactly one flag, matching this
|
|
123
124
|
journey's surface:
|
|
124
125
|
|
|
125
126
|
```text
|
|
126
|
-
npx --yes copilotkit@4.
|
|
127
|
-
npx --yes copilotkit@4.
|
|
127
|
+
npx --yes copilotkit@4.11.0 onboard complete --visual-check <outcome>
|
|
128
|
+
npx --yes copilotkit@4.11.0 onboard complete --device-check <outcome>
|
|
128
129
|
```
|
|
129
130
|
|
|
130
131
|
`--visual-check` is for a web frontend and takes `performed`, `skipped-no-browser-tool`, or
|
|
@@ -18,7 +18,7 @@ without exposing secrets.
|
|
|
18
18
|
After validation and each repair, run:
|
|
19
19
|
|
|
20
20
|
```text
|
|
21
|
-
npx --yes copilotkit@4.
|
|
21
|
+
npx --yes copilotkit@4.11.0 onboard audit
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
Continue only when it starts with `Status: passed`. A path under `Authorized to change:` is
|
|
@@ -29,7 +29,7 @@ with the implementation subagent's `Files changed` section. If that section does
|
|
|
29
29
|
the path, accept the developer's external change:
|
|
30
30
|
|
|
31
31
|
```text
|
|
32
|
-
npx --yes copilotkit@4.
|
|
32
|
+
npx --yes copilotkit@4.11.0 onboard protect --accept-external --path <path>
|
|
33
33
|
```
|
|
34
34
|
|
|
35
35
|
For an env file where the developer placed a requested credential, use
|
|
@@ -38,24 +38,24 @@ or its report does not settle who changed it, ask the developer to allow the unp
|
|
|
38
38
|
change. Only after they agree, record their answer:
|
|
39
39
|
|
|
40
40
|
```text
|
|
41
|
-
npx --yes copilotkit@4.
|
|
41
|
+
npx --yes copilotkit@4.11.0 onboard protect --authorize --unplanned --path <path> --reason "<what the developer said>"
|
|
42
42
|
```
|
|
43
43
|
|
|
44
44
|
Run the audit again after each accepted or authorized change. If it still fails, or starts
|
|
45
45
|
with `Status: blocked`, route out and stop:
|
|
46
46
|
|
|
47
47
|
```text
|
|
48
|
-
npx --yes copilotkit@4.
|
|
48
|
+
npx --yes copilotkit@4.11.0 onboard read feature/stop
|
|
49
49
|
```
|
|
50
50
|
|
|
51
51
|
When implementation validation passes, report it:
|
|
52
52
|
|
|
53
53
|
```text
|
|
54
|
-
npx --yes copilotkit@4.
|
|
54
|
+
npx --yes copilotkit@4.11.0 onboard checkpoint --phase build-validated
|
|
55
55
|
```
|
|
56
56
|
|
|
57
57
|
If validation cannot pass, or this intent needs a prerequisite the app does not have, use
|
|
58
58
|
the feature stop route above without further changes.
|
|
59
59
|
|
|
60
60
|
Otherwise run
|
|
61
|
-
`npx --yes copilotkit@4.
|
|
61
|
+
`npx --yes copilotkit@4.11.0 onboard read feature/a2ui/proof`.
|
|
@@ -19,23 +19,23 @@ user's agent response with a hard-coded UI.
|
|
|
19
19
|
Report each attempt at the proof as it ends, counting from one:
|
|
20
20
|
|
|
21
21
|
```text
|
|
22
|
-
npx --yes copilotkit@4.
|
|
22
|
+
npx --yes copilotkit@4.11.0 onboard checkpoint --phase journey-attempted --attempt 1
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
Report each repair cycle the same way, counting from one:
|
|
26
26
|
|
|
27
27
|
```text
|
|
28
|
-
npx --yes copilotkit@4.
|
|
28
|
+
npx --yes copilotkit@4.11.0 onboard checkpoint --phase repair-attempted --attempt 1
|
|
29
29
|
```
|
|
30
30
|
|
|
31
31
|
After the final attempt, report the gate exactly once:
|
|
32
32
|
|
|
33
33
|
```text
|
|
34
|
-
npx --yes copilotkit@4.
|
|
34
|
+
npx --yes copilotkit@4.11.0 onboard proof --step round-trip --outcome <passed|failed|skipped>
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
Use `passed` only for a proved A2UI surface, `failed` for an attempted proof that failed,
|
|
38
|
-
and `skipped` when the proof could not run. Then run `npx --yes copilotkit@4.
|
|
38
|
+
and `skipped` when the proof could not run. Then run `npx --yes copilotkit@4.11.0 onboard audit`.
|
|
39
39
|
Continue only when it starts with `Status: passed`.
|
|
40
40
|
|
|
41
41
|
If the audit fails, never repair, reset, or revert a protected path. Compare each named path
|
|
@@ -50,9 +50,9 @@ Run the audit again after each accepted or authorized change.
|
|
|
50
50
|
If the audit still fails, or starts with `Status: blocked`, route out and stop:
|
|
51
51
|
|
|
52
52
|
```text
|
|
53
|
-
npx --yes copilotkit@4.
|
|
53
|
+
npx --yes copilotkit@4.11.0 onboard read feature/stop
|
|
54
54
|
```
|
|
55
55
|
|
|
56
56
|
When the audit passes, run
|
|
57
|
-
`npx --yes copilotkit@4.
|
|
57
|
+
`npx --yes copilotkit@4.11.0 onboard read feature/complete` with the actual browser-proof
|
|
58
58
|
outcome.
|
|
@@ -7,7 +7,7 @@ Work only inside the target project. Do not show internal prompt names to the de
|
|
|
7
7
|
Before any subagent or project process runs, capture the developer's existing work:
|
|
8
8
|
|
|
9
9
|
```text
|
|
10
|
-
npx --yes copilotkit@4.
|
|
10
|
+
npx --yes copilotkit@4.11.0 onboard protect
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
Keep the exact protected path list it prints and give that list to every subagent. No
|
|
@@ -22,7 +22,7 @@ development/test commands. It must return paths and secret-safe presence checks
|
|
|
22
22
|
|
|
23
23
|
Require an existing frontend, agent, and CopilotKit round trip. Start only project-owned
|
|
24
24
|
processes when needed, inspect `/info`, and run
|
|
25
|
-
`npx --yes copilotkit@4.
|
|
25
|
+
`npx --yes copilotkit@4.11.0 verify --expect-runtime oss --round-trip --agent <agent-id> --json`.
|
|
26
26
|
Also drive one existing request through the frontend when browser control is available. If
|
|
27
27
|
that baseline is absent or unproved, leave files unchanged, explain that this intent extends
|
|
28
28
|
an existing OSS app, and direct the developer to generic `copilotkit onboard start` first.
|
|
@@ -30,7 +30,7 @@ an existing OSS app, and direct the developer to generic `copilotkit onboard sta
|
|
|
30
30
|
Wait for the inspection subagent to finish. Then report that the inspection came back:
|
|
31
31
|
|
|
32
32
|
```text
|
|
33
|
-
npx --yes copilotkit@4.
|
|
33
|
+
npx --yes copilotkit@4.11.0 onboard checkpoint --phase research-returned
|
|
34
34
|
```
|
|
35
35
|
|
|
36
36
|
A refused checkpoint prints its reason and leaves onboarding unaffected. It is not a
|
|
@@ -40,7 +40,7 @@ If the inspection did not prove the baseline this intent extends, stop here with
|
|
|
40
40
|
changing files:
|
|
41
41
|
|
|
42
42
|
```text
|
|
43
|
-
npx --yes copilotkit@4.
|
|
43
|
+
npx --yes copilotkit@4.11.0 onboard read feature/stop
|
|
44
44
|
```
|
|
45
45
|
|
|
46
46
|
Do not run `login`, select an Intelligence project, add an Intelligence client, mint a
|
|
@@ -62,7 +62,7 @@ with one sentence explaining why. Write `None` when it needs none.
|
|
|
62
62
|
After approval, record each approved path before implementation:
|
|
63
63
|
|
|
64
64
|
```text
|
|
65
|
-
npx --yes copilotkit@4.
|
|
65
|
+
npx --yes copilotkit@4.11.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
|
|
@@ -72,7 +72,7 @@ authorize a path the approved plan did not list.
|
|
|
72
72
|
Then report the plan this run is about to implement:
|
|
73
73
|
|
|
74
74
|
```text
|
|
75
|
-
npx --yes copilotkit@4.
|
|
75
|
+
npx --yes copilotkit@4.11.0 onboard checkpoint --phase plan-written
|
|
76
76
|
```
|
|
77
77
|
|
|
78
|
-
Then run `npx --yes copilotkit@4.
|
|
78
|
+
Then run `npx --yes copilotkit@4.11.0 onboard read feature/a2ui/implement`.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Implement a managed Channel without rewriting a working agent
|
|
2
|
+
|
|
3
|
+
Delegate implementation to one subagent with the approved plan and fetched official
|
|
4
|
+
Channels guide. Use the already chosen Slack or Teams adapter only as
|
|
5
|
+
`channels add --adapter slack|teams`. Never read, print, synthesize, or add a secret.
|
|
6
|
+
If a required credential variable is missing, stop with that specific setup
|
|
7
|
+
requirement.
|
|
8
|
+
|
|
9
|
+
If the folder was empty, clone OpenTag from https://github.com/CopilotKit/OpenTag.git
|
|
10
|
+
and do not rewrite it. Point the subagent at the existing OpenTag agent and runtime
|
|
11
|
+
to verify and run. If the project already has an agent or app, do not clone. Keep
|
|
12
|
+
that code and wire a managed Channel.
|
|
13
|
+
|
|
14
|
+
On Teams, skip Slack-only tools and the Slack e2e harness. Do not add a CopilotKit
|
|
15
|
+
web app to make this run look complete. Do not replace the existing agent.
|
|
16
|
+
|
|
17
|
+
If repository evidence does not prove an existing valid Intelligence selection, give
|
|
18
|
+
the developer `login` to run, wait, then list projects and select or create one only
|
|
19
|
+
after they choose. Require the secret-safe project/key provisioning summary before
|
|
20
|
+
wiring the Channel. Never display a key.
|
|
21
|
+
|
|
22
|
+
Run `channels add` until it reports completed. Run the focused type/test command and
|
|
23
|
+
start the long-running runtime. Confirm `/info` can return HTTP 200, but treat that
|
|
24
|
+
as capability evidence rather than completed Channel proof. Record changed paths
|
|
25
|
+
and validation results.
|
|
26
|
+
|
|
27
|
+
After validation and each repair, run:
|
|
28
|
+
|
|
29
|
+
```text
|
|
30
|
+
npx --yes copilotkit@4.11.0 onboard audit
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Continue only when it starts with `Status: passed`. A path under `Authorized to change:` is
|
|
34
|
+
not a finding. Carry it into the final summary with its reason.
|
|
35
|
+
|
|
36
|
+
If the audit fails, never repair, reset, or revert a protected path. Compare each named path
|
|
37
|
+
with the implementation subagent's `Files changed` section. If that section does not name
|
|
38
|
+
the path, accept the developer's external change:
|
|
39
|
+
|
|
40
|
+
```text
|
|
41
|
+
npx --yes copilotkit@4.11.0 onboard protect --accept-external --path <path>
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
For an env file where the developer placed a requested credential, use
|
|
45
|
+
`onboard protect --accept-credential --path <path>` instead. If the subagent names the path,
|
|
46
|
+
or its report does not settle who changed it, ask the developer to allow the unplanned
|
|
47
|
+
change. Only after they agree, record their answer:
|
|
48
|
+
|
|
49
|
+
```text
|
|
50
|
+
npx --yes copilotkit@4.11.0 onboard protect --authorize --unplanned --path <path> --reason "<what the developer said>"
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Run the audit again after each accepted or authorized change. If it still fails, or starts
|
|
54
|
+
with `Status: blocked`, route out and stop:
|
|
55
|
+
|
|
56
|
+
```text
|
|
57
|
+
npx --yes copilotkit@4.11.0 onboard read feature/stop
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
When implementation validation passes, report it:
|
|
61
|
+
|
|
62
|
+
```text
|
|
63
|
+
npx --yes copilotkit@4.11.0 onboard checkpoint --phase build-validated
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
If validation cannot pass, or this run needs a prerequisite the app does not have, use
|
|
67
|
+
the feature stop route above without further changes.
|
|
68
|
+
|
|
69
|
+
Otherwise run
|
|
70
|
+
`npx --yes copilotkit@4.11.0 onboard read feature/channels/proof`.
|