copilotkit 4.8.4 → 4.9.1
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 +46 -5
- package/cli-build-info.json +7 -7
- package/index.js +647 -124
- package/onboarding/index.json +140 -1
- package/onboarding/prompts/authenticate/start.md +47 -10
- package/onboarding/prompts/credentials/finalize-plan.md +64 -14
- package/onboarding/prompts/credentials/plan.md +54 -16
- package/onboarding/prompts/fallback/best-effort.md +36 -0
- package/onboarding/prompts/framework/ag2.md +48 -0
- package/onboarding/prompts/framework/agno.md +48 -0
- package/onboarding/prompts/framework/built-in.md +43 -0
- package/onboarding/prompts/framework/claude-sdk-python.md +49 -0
- package/onboarding/prompts/framework/claude-sdk-typescript.md +53 -0
- package/onboarding/prompts/framework/crewai-flows.md +56 -0
- package/onboarding/prompts/framework/deep-agents.md +45 -0
- package/onboarding/prompts/framework/google-adk.md +8 -3
- package/onboarding/prompts/framework/langgraph-fastapi.md +42 -0
- package/onboarding/prompts/framework/langgraph-python.md +8 -3
- package/onboarding/prompts/framework/langgraph-typescript.md +8 -3
- package/onboarding/prompts/framework/llamaindex.md +51 -0
- package/onboarding/prompts/framework/mastra.md +8 -3
- package/onboarding/prompts/framework/ms-agent-dotnet.md +8 -3
- package/onboarding/prompts/framework/ms-agent-harness-dotnet.md +62 -0
- package/onboarding/prompts/framework/ms-agent-python.md +8 -3
- package/onboarding/prompts/framework/pydantic-ai.md +48 -0
- package/onboarding/prompts/framework/strands-python.md +42 -0
- package/onboarding/prompts/framework/strands-typescript.md +42 -0
- package/onboarding/prompts/frontend/angular.md +9 -3
- package/onboarding/prompts/frontend/nextjs.md +8 -3
- package/onboarding/prompts/frontend/plan.md +22 -10
- package/onboarding/prompts/frontend/react-native.md +9 -3
- package/onboarding/prompts/frontend/react-spa.md +20 -5
- package/onboarding/prompts/frontend/vue.md +9 -3
- package/onboarding/prompts/implementation/build-and-validate.md +12 -2
- package/onboarding/prompts/proof/complete.md +51 -16
- package/onboarding/prompts/proof/oss-baseline.md +59 -0
- package/onboarding/prompts/proof/round-trip.md +51 -24
- package/onboarding/prompts/subagent/create-plan.md +14 -2
- package/onboarding/prompts/subagent/implement-and-validate.md +10 -0
- package/onboarding/prompts/subagent/inspect-repository.md +6 -1
- package/onboarding/prompts/subagent/prove-oss-baseline.md +35 -0
- package/onboarding/prompts/subagent/prove-round-trip.md +46 -21
- package/onboarding/prompts/unsupported/no-validated-path.md +23 -9
- package/package.json +1 -1
- package/release/release-tool.js +1 -1
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Configure Strands Agents Python
|
|
2
|
+
|
|
3
|
+
Preserve an existing Strands model setup. Start with OpenAI for a new agent. Offer another
|
|
4
|
+
vendor only after an exact CopilotKit Markdown page names it. The page must name its
|
|
5
|
+
credential variables and setup steps.
|
|
6
|
+
|
|
7
|
+
Name the default model credential `OPENAI_API_KEY`.
|
|
8
|
+
|
|
9
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
10
|
+
store, or request a secret value.
|
|
11
|
+
|
|
12
|
+
## Documentation
|
|
13
|
+
|
|
14
|
+
- https://docs.copilotkit.ai/strands/quickstart.md
|
|
15
|
+
- https://docs.copilotkit.ai/strands/inspector.md
|
|
16
|
+
- https://docs.copilotkit.ai/strands/generative-ui/a2ui/fixed-schema.md
|
|
17
|
+
- https://docs.copilotkit.ai/strands/shared-state/agent-readonly.md
|
|
18
|
+
|
|
19
|
+
Fetch all four pages in one step rather than one after another.
|
|
20
|
+
|
|
21
|
+
The documentation scope is `strands`. Use the Python examples from these pages.
|
|
22
|
+
The fixed-schema A2UI tool makes its own OpenAI call. Set `injectA2UITool` to `false` when
|
|
23
|
+
the fixed-schema A2UI tool makes its own OpenAI call. This prevents a second injected A2UI
|
|
24
|
+
tool from changing the documented setup.
|
|
25
|
+
|
|
26
|
+
No Strands agent-app-context Markdown page is available. Do not invent an
|
|
27
|
+
agent-app-context setup. If the requested work needs that missing setup, run the
|
|
28
|
+
unsupported route below.
|
|
29
|
+
|
|
30
|
+
Record the selected framework, vendor, model, required credential variable names, these
|
|
31
|
+
URLs, and the context documentation gap. Do not use remembered CopilotKit instructions.
|
|
32
|
+
|
|
33
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
34
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
35
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
36
|
+
unavailable only after a second method also fails.
|
|
37
|
+
|
|
38
|
+
If the pages support the selection, run
|
|
39
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
40
|
+
|
|
41
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
42
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Configure Strands Agents TypeScript
|
|
2
|
+
|
|
3
|
+
Preserve an existing Strands model setup. Start with OpenAI for a new agent. Offer another
|
|
4
|
+
vendor only after an exact CopilotKit Markdown page names it. The page must name its
|
|
5
|
+
credential variables and setup steps.
|
|
6
|
+
|
|
7
|
+
Name the default model credential `OPENAI_API_KEY`.
|
|
8
|
+
|
|
9
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
10
|
+
store, or request a secret value.
|
|
11
|
+
|
|
12
|
+
## Documentation
|
|
13
|
+
|
|
14
|
+
- https://docs.copilotkit.ai/strands-typescript/quickstart.md
|
|
15
|
+
- https://docs.copilotkit.ai/strands-typescript/inspector.md
|
|
16
|
+
- https://docs.copilotkit.ai/strands-typescript/generative-ui/a2ui/fixed-schema.md
|
|
17
|
+
- https://docs.copilotkit.ai/strands-typescript/shared-state/agent-readonly.md
|
|
18
|
+
|
|
19
|
+
Fetch all four pages in one step rather than one after another.
|
|
20
|
+
|
|
21
|
+
The documentation scope is `strands-typescript`. Use only the TypeScript examples from
|
|
22
|
+
these pages. Install `@modelcontextprotocol/sdk` as a runtime dependency.
|
|
23
|
+
`@strands-agents/sdk` loads it even when the application does not use MCP.
|
|
24
|
+
|
|
25
|
+
The fixed-schema page has no Strands TypeScript backend example. No Strands TypeScript
|
|
26
|
+
agent-app-context Markdown page is available. Do not translate another language's backend
|
|
27
|
+
example or invent either missing setup. If the requested work needs either missing setup,
|
|
28
|
+
run the unsupported route below.
|
|
29
|
+
|
|
30
|
+
Record the selected framework, vendor, model, required credential variable names, these
|
|
31
|
+
URLs, and both documentation gaps. Do not use remembered CopilotKit instructions.
|
|
32
|
+
|
|
33
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
34
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
35
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
36
|
+
unavailable only after a second method also fails.
|
|
37
|
+
|
|
38
|
+
If the pages support the selection, run
|
|
39
|
+
`npx --yes copilotkit@4.9.1 onboard read frontend/plan`.
|
|
40
|
+
|
|
41
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
42
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -20,8 +20,14 @@ Angular CLI 22 requires Node `^22.22.3 || ^24.15.0 || >=26`. Check the Node vers
|
|
|
20
20
|
you create or build an Angular project. If the installed version is lower, select a
|
|
21
21
|
supported version first and use it for every later command in this project.
|
|
22
22
|
|
|
23
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
24
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
25
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
26
|
+
unavailable only after a second method also fails.
|
|
27
|
+
|
|
23
28
|
If the page supports the selection, run
|
|
24
|
-
`npx copilotkit@4.
|
|
29
|
+
`npx --yes copilotkit@4.9.1 onboard read credentials/finalize-plan`.
|
|
25
30
|
|
|
26
|
-
If the page does not
|
|
27
|
-
|
|
31
|
+
If a second method also fails, or the page that loads does not support the selection,
|
|
32
|
+
run
|
|
33
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -16,8 +16,13 @@ agent framework documentation instead. This page configures the CopilotKit built
|
|
|
16
16
|
agent as the default agent, which is correct only for a project that has no agent.
|
|
17
17
|
Do not replace the developer's existing agent with the built-in agent.
|
|
18
18
|
|
|
19
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
20
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
21
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
22
|
+
unavailable only after a second method also fails.
|
|
23
|
+
|
|
19
24
|
If the pages support the selection, run
|
|
20
|
-
`npx copilotkit@4.
|
|
25
|
+
`npx --yes copilotkit@4.9.1 onboard read credentials/finalize-plan`.
|
|
21
26
|
|
|
22
|
-
If a page does not
|
|
23
|
-
`npx copilotkit@4.
|
|
27
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
28
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -3,6 +3,12 @@
|
|
|
3
3
|
Use the repository findings to select the frontend. Ask the developer only for choices
|
|
4
4
|
that the repository does not show. Do not change application code in this phase.
|
|
5
5
|
|
|
6
|
+
Use a gentle wizard. Ask one short question at a time. Do not combine separate choices in
|
|
7
|
+
one question. Put the recommendation first, give its evidence in one sentence, and keep
|
|
8
|
+
the alternatives short. When the frontend is unknown, ask only whether to use the
|
|
9
|
+
recommended frontend. If the developer declines it, ask one follow-up question that lists
|
|
10
|
+
the valid frontend choices. Do not ask about the model or project in this step.
|
|
11
|
+
|
|
6
12
|
If the project has a frontend, preserve it and use the matching route below. If the project
|
|
7
13
|
needs a frontend, show the valid choices and one recommendation based on repository
|
|
8
14
|
evidence, then ask the developer to choose.
|
|
@@ -10,18 +16,24 @@ evidence, then ask the developer to choose.
|
|
|
10
16
|
The valid choices are React SPA, Next.js, Angular, Vue 3, and React Native. They are valid
|
|
11
17
|
in every starting state. Do not show the internal route.
|
|
12
18
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
19
|
+
Recommend the frontend the project already uses. Where there is no existing frontend,
|
|
20
|
+
recommend the one the developer names, and say what each choice implies for where the
|
|
21
|
+
CopilotKit runtime lives: Next.js hosts it in a route handler, Angular in its SSR
|
|
22
|
+
server, and Vue 3, React SPA and React Native reach a runtime that runs as its own
|
|
23
|
+
process.
|
|
24
|
+
|
|
25
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
26
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
27
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
28
|
+
unavailable only after a second method also fails.
|
|
17
29
|
|
|
18
30
|
Use exactly one matching internal route:
|
|
19
31
|
|
|
20
|
-
1. React SPA: `npx copilotkit@4.
|
|
21
|
-
2. Next.js: `npx copilotkit@4.
|
|
22
|
-
3. Angular: `npx copilotkit@4.
|
|
23
|
-
4. Vue 3: `npx copilotkit@4.
|
|
24
|
-
5. React Native: `npx copilotkit@4.
|
|
32
|
+
1. React SPA: `npx --yes copilotkit@4.9.1 onboard read frontend/react-spa`
|
|
33
|
+
2. Next.js: `npx --yes copilotkit@4.9.1 onboard read frontend/nextjs`
|
|
34
|
+
3. Angular: `npx --yes copilotkit@4.9.1 onboard read frontend/angular`
|
|
35
|
+
4. Vue 3: `npx --yes copilotkit@4.9.1 onboard read frontend/vue`
|
|
36
|
+
5. React Native: `npx --yes copilotkit@4.9.1 onboard read frontend/react-native`
|
|
25
37
|
|
|
26
38
|
If no listed frontend fits, run
|
|
27
|
-
`npx copilotkit@4.
|
|
39
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -11,8 +11,14 @@ Preserve an existing React Native frontend. Use the selected page for a new fron
|
|
|
11
11
|
Fetch the selected documentation page. Record React Native as the selected frontend and
|
|
12
12
|
keep this URL. Do not use remembered CopilotKit instructions.
|
|
13
13
|
|
|
14
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
15
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
16
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
17
|
+
unavailable only after a second method also fails.
|
|
18
|
+
|
|
14
19
|
If the page supports the selection, run
|
|
15
|
-
`npx copilotkit@4.
|
|
20
|
+
`npx --yes copilotkit@4.9.1 onboard read credentials/finalize-plan`.
|
|
16
21
|
|
|
17
|
-
If the page does not
|
|
18
|
-
|
|
22
|
+
If a second method also fails, or the page that loads does not support the selection,
|
|
23
|
+
run
|
|
24
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -1,12 +1,27 @@
|
|
|
1
1
|
# Configure React SPA
|
|
2
2
|
|
|
3
|
-
Preserve an existing React SPA.
|
|
4
|
-
|
|
3
|
+
Preserve an existing React SPA. Use the selected page for a new frontend.
|
|
4
|
+
|
|
5
|
+
A React SPA has no server of its own, so the CopilotKit runtime is a separate process
|
|
6
|
+
rather than a route inside the app. Do not add a runtime route to the SPA build, and do
|
|
7
|
+
not move the agent into it.
|
|
5
8
|
|
|
6
9
|
## Documentation
|
|
7
10
|
|
|
8
11
|
- Credentials and plan: `Not applicable`
|
|
9
|
-
- Implementation and validation:
|
|
10
|
-
- Proof:
|
|
12
|
+
- Implementation and validation: https://docs.copilotkit.ai/react-spa.md
|
|
13
|
+
- Proof: https://docs.copilotkit.ai/react-spa.md
|
|
14
|
+
|
|
15
|
+
Fetch the selected documentation page. Record React SPA as the selected frontend and
|
|
16
|
+
keep this URL. Do not use remembered CopilotKit instructions.
|
|
17
|
+
|
|
18
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
19
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
20
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
21
|
+
unavailable only after a second method also fails.
|
|
22
|
+
|
|
23
|
+
If the page supports the selection, run
|
|
24
|
+
`npx --yes copilotkit@4.9.1 onboard read credentials/finalize-plan`.
|
|
11
25
|
|
|
12
|
-
|
|
26
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
27
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -11,8 +11,14 @@ Preserve an existing Vue 3 frontend. Use the selected page for a new frontend.
|
|
|
11
11
|
Fetch the selected documentation page. Record Vue 3 as the selected frontend and keep
|
|
12
12
|
this URL. Do not use remembered CopilotKit instructions.
|
|
13
13
|
|
|
14
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
15
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
16
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
17
|
+
unavailable only after a second method also fails.
|
|
18
|
+
|
|
14
19
|
If the page supports the selection, run
|
|
15
|
-
`npx copilotkit@4.
|
|
20
|
+
`npx --yes copilotkit@4.9.1 onboard read credentials/finalize-plan`.
|
|
16
21
|
|
|
17
|
-
If the page does not
|
|
18
|
-
|
|
22
|
+
If a second method also fails, or the page that loads does not support the selection,
|
|
23
|
+
run
|
|
24
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
@@ -8,7 +8,7 @@ documentation URLs.
|
|
|
8
8
|
Wait for the subagent to finish.
|
|
9
9
|
|
|
10
10
|
If all implementation and validation steps pass, run
|
|
11
|
-
`npx copilotkit@4.
|
|
11
|
+
`npx --yes copilotkit@4.9.1 onboard read proof/round-trip`.
|
|
12
12
|
|
|
13
13
|
If a validation command fails, decide which kind of failure it is before you route.
|
|
14
14
|
|
|
@@ -20,7 +20,7 @@ Route out only when the failure is not yours to fix: the failure is in code this
|
|
|
20
20
|
not write, or the fix requires changing the developer's existing agent or frontend,
|
|
21
21
|
or the same command still fails after three repair attempts, or the documentation does not
|
|
22
22
|
support the plan. In those cases run
|
|
23
|
-
`npx copilotkit@4.
|
|
23
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
24
24
|
|
|
25
25
|
## Implementation subagent brief
|
|
26
26
|
|
|
@@ -34,6 +34,11 @@ Use only the approved plan and the selected documentation URLs. Fetch every URL
|
|
|
34
34
|
step, before you change the project, rather than one after another.
|
|
35
35
|
Do not use remembered CopilotKit instructions.
|
|
36
36
|
|
|
37
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
38
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
39
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Report a
|
|
40
|
+
documentation gap only after a second method also fails.
|
|
41
|
+
|
|
37
42
|
Add only the props, options, and imports that appear in the fetched documentation. A
|
|
38
43
|
remembered API from an earlier CopilotKit version will fail type checking against this
|
|
39
44
|
release, so do not decorate a documented example with anything it does not show.
|
|
@@ -50,6 +55,11 @@ file outside the project directory: not for a credential, and not for an API que
|
|
|
50
55
|
fetched documentation answers. A missing credential is the main coding agent's to ask
|
|
51
56
|
for.
|
|
52
57
|
|
|
58
|
+
For a recorded `both-oss` baseline, preserve the existing agent, frontend, CopilotKit
|
|
59
|
+
integration, user-visible request, and runtime behavior. Do not replace the existing
|
|
60
|
+
persistence. Change only the approved project selection and Intelligence runtime wiring.
|
|
61
|
+
Run the recorded baseline checks after the change and report any regression.
|
|
62
|
+
|
|
53
63
|
When the documentation creates the frontend with the framework's own scaffolder,
|
|
54
64
|
run that scaffolder rather than hand-authoring what it emits.
|
|
55
65
|
Do not re-declare a compiler option it set. Every real project of that framework
|
|
@@ -1,13 +1,20 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Close out onboarding
|
|
2
2
|
|
|
3
3
|
Report the selected framework, frontend, model, and complete round-trip evidence to the developer.
|
|
4
4
|
Report the exact interaction, visible result, validation commands, and evidence locations.
|
|
5
5
|
|
|
6
6
|
Do not complete onboarding without this evidence.
|
|
7
7
|
|
|
8
|
-
Report whether the real UI was driven
|
|
8
|
+
Report whether the real UI was driven on this journey's own surface -- in a browser for a
|
|
9
|
+
web frontend, on a device for React Native -- using the outcome the proof subagent
|
|
9
10
|
returned. Do not soften it and do not leave it out: a run that never drove the UI proved
|
|
10
|
-
the agent, not the
|
|
11
|
+
the agent, not the surface, and the developer needs to know which they have.
|
|
12
|
+
|
|
13
|
+
**Whether this run is complete is decided by the command at the end of this prompt, not
|
|
14
|
+
here.** Run it before you write the summary, and let its output decide which summary you
|
|
15
|
+
write. A run whose surface was never driven is blocked, not complete: say so in the first
|
|
16
|
+
line, name the evidence the command lists as missing, and do not describe the run as
|
|
17
|
+
finished, working, or ready. Everything else below applies to either outcome.
|
|
11
18
|
|
|
12
19
|
Report only the project this run worked in. The summary and every report below describe
|
|
13
20
|
that project and nothing else. Do not name or describe a file outside the project
|
|
@@ -25,11 +32,22 @@ about it: keep this version pin, wire this constructor, run this build. It never
|
|
|
25
32
|
as an account of hitting it. No count of what went wrong, no list of fixes made along the
|
|
26
33
|
way, no argument that a failed check is not a defect.
|
|
27
34
|
|
|
28
|
-
|
|
29
|
-
|
|
35
|
+
The handoff must include:
|
|
36
|
+
|
|
37
|
+
- The URL of the running app.
|
|
38
|
+
- The command that starts the app in the future.
|
|
39
|
+
- How to use the CopilotKit Inspector.
|
|
40
|
+
- How to use https://intelligence.copilotkit.ai to manage the Intelligence installation.
|
|
41
|
+
- The process IDs and stop commands for the running agent and frontend.
|
|
42
|
+
|
|
43
|
+
State that the servers remain running after proof.
|
|
44
|
+
|
|
45
|
+
Report each thing that slowed this run down. Send at most four reports, worst first. Run
|
|
46
|
+
the friction commands without another developer question. The CLI telemetry gate decides
|
|
47
|
+
whether the report is sent.
|
|
30
48
|
|
|
31
49
|
```text
|
|
32
|
-
npx copilotkit@4.
|
|
50
|
+
npx --yes copilotkit@4.9.1 onboard friction --category <slug> --cost-seconds <seconds>
|
|
33
51
|
```
|
|
34
52
|
|
|
35
53
|
Write one or two sentences on the command's standard input. Pick one category from
|
|
@@ -42,18 +60,35 @@ that carries any of those, prints the reason, and exits zero. A refused report i
|
|
|
42
60
|
a failed step and not a failed onboarding run. Reword it and send it again, or move
|
|
43
61
|
on. A run that proves a round trip is complete whether or not it reported friction.
|
|
44
62
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
63
|
+
Tell the developer when you send a friction report. Do not quote or summarize the report
|
|
64
|
+
unless the developer asks. If the CLI says that telemetry is disabled or unavailable,
|
|
65
|
+
state that the report was not sent and continue without another question.
|
|
66
|
+
|
|
67
|
+
When the evidence is gathered, run `npx --yes copilotkit@4.9.1 onboard complete`, carrying
|
|
68
|
+
the surface-check outcome the proof subagent returned. Pass exactly one flag, and pass the
|
|
69
|
+
one that matches this journey's surface.
|
|
70
|
+
|
|
71
|
+
For a web frontend -- React SPA, Next.js, Angular, Vue:
|
|
49
72
|
|
|
50
|
-
|
|
51
|
-
|
|
73
|
+
```text
|
|
74
|
+
npx --yes copilotkit@4.9.1 onboard complete --visual-check <outcome>
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
The outcome is one of `performed`, `skipped-no-browser-tool`, or `failed`.
|
|
78
|
+
|
|
79
|
+
For React Native:
|
|
52
80
|
|
|
53
81
|
```text
|
|
54
|
-
npx copilotkit@4.
|
|
82
|
+
npx --yes copilotkit@4.9.1 onboard complete --device-check <outcome>
|
|
55
83
|
```
|
|
56
84
|
|
|
57
|
-
The outcome is one of `performed`, `skipped-no-
|
|
58
|
-
|
|
59
|
-
|
|
85
|
+
The outcome is one of `performed`, `skipped-no-device`, or `failed`.
|
|
86
|
+
|
|
87
|
+
The two flags are not interchangeable and neither takes the other's outcomes. A browser
|
|
88
|
+
proves nothing about a React Native view tree, and a device capture proves nothing about
|
|
89
|
+
browser-origin CORS, so the flag you pass is how this run states which surface it proved.
|
|
90
|
+
|
|
91
|
+
Pass the outcome you were given rather than the one you wanted. Anything but `performed`
|
|
92
|
+
prints what the missing check leaves unverified and ends this run as blocked. That output
|
|
93
|
+
is the developer's finding, so carry it into the summary rather than restating it as a
|
|
94
|
+
smaller caveat.
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# Prove the existing OSS baseline
|
|
2
|
+
|
|
3
|
+
Do not prove the baseline yourself. Spawn one proof subagent.
|
|
4
|
+
|
|
5
|
+
Give the subagent the full text of the baseline brief at the end of this prompt, the
|
|
6
|
+
repository findings, and the exact CLI package spec. Wait for the subagent to finish.
|
|
7
|
+
|
|
8
|
+
Do not change project files before this proof ends. Starting existing development
|
|
9
|
+
processes and their ignored runtime files is allowed.
|
|
10
|
+
|
|
11
|
+
If the subagent proves the `both-oss` predicate, keep its evidence with the plan. If it
|
|
12
|
+
proves another supported starting state, record that state. In either case, run
|
|
13
|
+
`npx --yes copilotkit@4.9.1 onboard read credentials/plan`.
|
|
14
|
+
|
|
15
|
+
If it cannot identify the running process safely, exposes a secret, or finds a baseline
|
|
16
|
+
failure that cannot be classified, run
|
|
17
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
18
|
+
|
|
19
|
+
## Baseline proof subagent brief
|
|
20
|
+
|
|
21
|
+
Everything below the rule is the subagent's prompt. Give it verbatim.
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
# Prove the existing OSS CopilotKit baseline
|
|
26
|
+
|
|
27
|
+
Read and run only inside the project directory. Do not edit source, configuration,
|
|
28
|
+
dependencies, or tracked files. Do not read, show, store, or return secret values.
|
|
29
|
+
|
|
30
|
+
Find the expected agent id from the project. Start the existing agent and frontend only
|
|
31
|
+
when they are not already running. Before using a port, identify its process and working
|
|
32
|
+
directory. Do not stop a process outside this project.
|
|
33
|
+
|
|
34
|
+
Prove the live runtime in this order:
|
|
35
|
+
|
|
36
|
+
1. GET `/info` from the project's CopilotKit runtime and require a valid response.
|
|
37
|
+
2. Require `/info` to declare the expected agent id.
|
|
38
|
+
3. Confirm that `licenseStatus` is absent. Its presence means the live runtime uses
|
|
39
|
+
Intelligence and is not an OSS starting state.
|
|
40
|
+
4. Confirm from project files that the runtime constructor passes a `runner` option rather
|
|
41
|
+
than an `intelligence` option. A package, import, project file, or key is not use proof.
|
|
42
|
+
5. Run
|
|
43
|
+
`npx --yes copilotkit@4.9.1 verify --expect-runtime oss --round-trip --agent <expected-agent-id> --json`,
|
|
44
|
+
with the runtime URL or auth header options that this project needs. Require exit zero
|
|
45
|
+
and the JSON `ok` field to be `true`.
|
|
46
|
+
6. Drive one real request through the existing frontend, CopilotKit runtime, and expected
|
|
47
|
+
agent. Require the existing user-visible result. If no browser tool is available, the
|
|
48
|
+
round trip is not proved and the state is `unproved`.
|
|
49
|
+
|
|
50
|
+
Classify the state as `both-oss` only when all six predicates are true: agent present,
|
|
51
|
+
interface present, CopilotKit present, CopilotKit round trip proven, runtime connection
|
|
52
|
+
`oss`, and managed Intelligence not configured. Return each predicate and its secret-safe
|
|
53
|
+
evidence.
|
|
54
|
+
|
|
55
|
+
The default in-memory OSS runner is ephemeral. SQLite, custom, or framework persistence
|
|
56
|
+
can be durable. Report the persistence that project evidence proves, or `unproved`. Do not
|
|
57
|
+
replace it and do not describe all OSS runs as ephemeral.
|
|
58
|
+
|
|
59
|
+
Stop after returning the baseline result, process ids and ports used, and evidence paths.
|
|
@@ -10,8 +10,10 @@ Wait for the subagent to finish.
|
|
|
10
10
|
Give the subagent this guide for continued-development tools:
|
|
11
11
|
https://docs.copilotkit.ai/build-with-agents.md
|
|
12
12
|
|
|
13
|
-
If the subagent proves the complete round trip
|
|
14
|
-
`npx copilotkit@4.
|
|
13
|
+
If the subagent proves the complete round trip, run
|
|
14
|
+
`npx --yes copilotkit@4.9.1 onboard read proof/complete`. The round trip proves core success
|
|
15
|
+
even if a continued-development tool fails. Keep the Skills and MCP results separate from
|
|
16
|
+
the proof result.
|
|
15
17
|
|
|
16
18
|
If the round trip fails, decide which kind of failure it is before you route. A failure
|
|
17
19
|
caused by a file this run created or changed is a defect in the new work. Send it back to
|
|
@@ -19,7 +21,7 @@ the proof subagent to fix and prove again, at most three attempts.
|
|
|
19
21
|
|
|
20
22
|
Route out only when the failure is not yours to fix, when the same proof still fails after
|
|
21
23
|
three attempts, or when no evidence of the round trip can be produced. In those cases run
|
|
22
|
-
`npx copilotkit@4.
|
|
24
|
+
`npx --yes copilotkit@4.9.1 onboard read unsupported/no-validated-path`.
|
|
23
25
|
|
|
24
26
|
## Proof subagent brief
|
|
25
27
|
|
|
@@ -33,6 +35,11 @@ Use the proof steps and documentation URLs from the approved plan. Fetch every s
|
|
|
33
35
|
URL in one step before you start, rather than one after another.
|
|
34
36
|
Do not use remembered CopilotKit instructions.
|
|
35
37
|
|
|
38
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
39
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
40
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Report a
|
|
41
|
+
documentation gap only after a second method also fails.
|
|
42
|
+
|
|
36
43
|
Read the port the developer's agent already serves from this project's own
|
|
37
44
|
configuration. Do not assume a default, and do not start a second copy of an agent this
|
|
38
45
|
project is already running. Before you bind any new server, check that the port is free
|
|
@@ -40,8 +47,12 @@ and pick another one if it is not. Record every port you used.
|
|
|
40
47
|
|
|
41
48
|
Start the agent and the selected frontend.
|
|
42
49
|
|
|
50
|
+
Leave the agent and frontend servers running after proof. Record each process ID and a
|
|
51
|
+
safe command that stops that process. Record the frontend URL and the commands that start
|
|
52
|
+
both servers again.
|
|
53
|
+
|
|
43
54
|
With both running, check the wiring in one command before you open a browser:
|
|
44
|
-
`npx copilotkit@4.
|
|
55
|
+
`npx --yes copilotkit@4.9.1 verify --json`. Add `--runtime-url` when the runtime is not at
|
|
45
56
|
`http://localhost:3000/api/copilotkit`. Read the individual checks rather than the summary
|
|
46
57
|
alone: a check reported `undetermined` did not run, and that is not a pass. Fix anything
|
|
47
58
|
that is not a pass before the browser, because a browser failure stacked on broken wiring
|
|
@@ -60,7 +71,7 @@ because the runtime reports no thread-endpoint state, the runtime predates the f
|
|
|
60
71
|
Record that and move on — there is nothing to repair.
|
|
61
72
|
|
|
62
73
|
Then prove that the agent actually runs, which is the gate for this node:
|
|
63
|
-
`npx copilotkit@4.
|
|
74
|
+
`npx --yes copilotkit@4.9.1 verify --round-trip --json`. It sends one request through the
|
|
64
75
|
runtime and reads the answer back from the thread, so it separates an agent that is
|
|
65
76
|
configured from an agent that works. Use `--agent <id>` when the runtime declares more
|
|
66
77
|
than one. If it reports `user-not-identified`, this project's `identifyUser` reads a
|
|
@@ -72,6 +83,11 @@ it.
|
|
|
72
83
|
Then send one real request through the frontend. Make sure that the request passes through
|
|
73
84
|
CopilotKit and reaches the selected agent.
|
|
74
85
|
|
|
86
|
+
For a recorded `both-oss` starting state: Compare the final round trip with the recorded
|
|
87
|
+
OSS baseline. The same frontend request must still reach the same agent and produce the
|
|
88
|
+
same kind of user-visible result. The runtime must now report `licenseStatus`, and the
|
|
89
|
+
authenticated Intelligence checks must pass. Record both before and after evidence.
|
|
90
|
+
|
|
75
91
|
Before you trust the agent, confirm that the process answering is the one in this
|
|
76
92
|
repository. `verify` reports which agents the runtime declares and has nothing to compare
|
|
77
93
|
them against, and `--round-trip` proves an agent answers under the declared id without
|
|
@@ -93,20 +109,32 @@ by one.
|
|
|
93
109
|
Address a local agent by host name rather than by an IP literal. Some local agents bind
|
|
94
110
|
IPv6 only, so an IPv4 literal fails against the correct port.
|
|
95
111
|
|
|
96
|
-
Drive the real UI
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
and
|
|
112
|
+
Drive the real UI on this journey's own surface, and make sure that the frontend receives
|
|
113
|
+
working generative UI from the agent. This is the step that covers realtime delivery, the
|
|
114
|
+
frontend provider being wired to this runtime, and a generative UI component actually
|
|
115
|
+
rendering, and no command-line check reaches any of them. It is not optional polish: a run
|
|
116
|
+
that skips it has proven the agent and not the journey, and the graph ends such a run as
|
|
117
|
+
blocked rather than complete.
|
|
118
|
+
|
|
119
|
+
For a web frontend, that surface is a browser, and it also covers browser-origin CORS and
|
|
120
|
+
CSP, which a CLI request never exercises. Use a browser MCP server already configured for
|
|
121
|
+
the coding agent you are running as, the same way the CopilotKit documentation MCP server
|
|
122
|
+
below is configured. Do not add a browser driver to this project: a devDependency and a
|
|
123
|
+
browser download land in the diff and tax a repository that never asked for one. If nothing
|
|
124
|
+
in your environment can drive a browser, skip this step rather than installing one.
|
|
125
|
+
|
|
126
|
+
Report exactly one of `performed`, `skipped-no-browser-tool`, or `failed` for a web
|
|
127
|
+
frontend.
|
|
128
|
+
|
|
129
|
+
For React Native, that surface is a device or emulator, and a browser cannot stand in for
|
|
130
|
+
it. Run the app on a booted emulator, drive the same request, and capture the terminal
|
|
131
|
+
state with `adb exec-out screencap -p`. Read `adb logcat` as well: a redbox is a runtime
|
|
132
|
+
failure the terminal output never shows. If no device or emulator is available, skip this
|
|
133
|
+
step rather than substituting a browser.
|
|
101
134
|
|
|
102
|
-
|
|
103
|
-
same way the CopilotKit documentation MCP server below is configured. Do not add a browser
|
|
104
|
-
driver to this project: a devDependency and a browser download land in the diff and tax a
|
|
105
|
-
repository that never asked for one. If nothing in your environment can drive a
|
|
106
|
-
browser, skip this step rather than installing one, and never report a visual result you
|
|
107
|
-
did not see.
|
|
135
|
+
Report exactly one of `performed`, `skipped-no-device`, or `failed` for React Native.
|
|
108
136
|
|
|
109
|
-
|
|
137
|
+
Never report a result you did not see, on either surface.
|
|
110
138
|
|
|
111
139
|
Record the input, visible result, relevant process status, and evidence locations. Do not
|
|
112
140
|
return secret values.
|
|
@@ -125,19 +153,18 @@ project's data never reaches the agent, the agent receives it and its instructio
|
|
|
125
153
|
it, the page loads its data after the context was registered, or the run wired a different
|
|
126
154
|
source than the page renders. Fix that cause, then prove again.
|
|
127
155
|
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
no reason. Fetch the continued-development guide from the main coding agent at the same
|
|
131
|
-
time as the proof documentation.
|
|
156
|
+
Fetch the continued-development guide from the main coding agent with the proof
|
|
157
|
+
documentation. Try the continued-development tools after the application passes proof.
|
|
132
158
|
Use it to install the project-scoped CopilotKit Skills.
|
|
133
159
|
Use it to configure the CopilotKit documentation MCP server for the current coding agent.
|
|
134
160
|
|
|
135
|
-
|
|
136
|
-
|
|
161
|
+
Do not validate whether the Skills or MCP server installed correctly. Record the command
|
|
162
|
+
result for each attempt. Report each tool result separately. A tool error does not change
|
|
163
|
+
the proof result.
|
|
137
164
|
|
|
138
165
|
Gather what you need in as few commands as possible. Combine independent reads into one
|
|
139
166
|
command rather than running them one at a time. Split a command only when its result decides
|
|
140
167
|
what you run next.
|
|
141
168
|
|
|
142
169
|
Return the proof or the exact failed step to the main coding agent, together with the
|
|
143
|
-
|
|
170
|
+
surface-check outcome and which surface it speaks for. Stop after you return the result.
|
|
@@ -4,6 +4,11 @@ Use the selected framework, frontend, model, repository findings, and documentat
|
|
|
4
4
|
from the main coding agent. Fetch every selected URL in one step rather than one after
|
|
5
5
|
another. Do not use remembered CopilotKit instructions.
|
|
6
6
|
|
|
7
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
8
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
9
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Report a
|
|
10
|
+
documentation gap only after a second method also fails.
|
|
11
|
+
|
|
7
12
|
Name the application the project asks for, and plan that application. Each documentation
|
|
8
13
|
page teaches through one worked example, and that example carries a domain of its own.
|
|
9
14
|
The domain belongs to the page. The project's purpose from the repository findings
|
|
@@ -19,11 +24,18 @@ Preserve each agent or frontend that already exists.
|
|
|
19
24
|
|
|
20
25
|
Plan the runtime to consume the Intelligence credential. The runtime takes an
|
|
21
26
|
`intelligence` option holding a client built from the project key. A runtime given a
|
|
22
|
-
`runner` option instead is the
|
|
23
|
-
|
|
27
|
+
`runner` option instead is the OSS runtime. It never reads the Intelligence key, and the
|
|
28
|
+
Inspector reads the project as locked. The default in-memory OSS runner is ephemeral.
|
|
29
|
+
SQLite, custom, or framework persistence can be durable. The two options cannot be
|
|
24
30
|
combined. Take the constructor from the connect-your-runtime page. Where a framework
|
|
25
31
|
quickstart shows a `runner` option instead, the connect-your-runtime page wins.
|
|
26
32
|
|
|
33
|
+
When the starting state is `both-oss`, use its recorded live baseline evidence. Preserve
|
|
34
|
+
the working agent, frontend, CopilotKit integration, and OSS behavior. Plan only the
|
|
35
|
+
project selection, Intelligence runtime configuration, and authenticated proof needed for
|
|
36
|
+
the conversion. Preserve the existing persistence and user-visible request. Do not
|
|
37
|
+
rebuild a path that already works.
|
|
38
|
+
|
|
27
39
|
Where the SDK requires an application-level value that the repository cannot supply, such
|
|
28
40
|
as an end-user identity for threads, use one clearly marked local placeholder and name what
|
|
29
41
|
production requires instead. Do not stop onboarding to ask the developer for it.
|