copilotkit 4.8.4 → 4.9.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 +22 -5
- package/cli-build-info.json +7 -7
- package/index.js +109 -33
- package/onboarding/index.json +140 -1
- package/onboarding/prompts/authenticate/start.md +21 -4
- package/onboarding/prompts/credentials/finalize-plan.md +39 -14
- package/onboarding/prompts/credentials/plan.md +48 -16
- package/onboarding/prompts/fallback/best-effort.md +29 -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 +16 -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 +18 -9
- package/onboarding/prompts/proof/oss-baseline.md +59 -0
- package/onboarding/prompts/proof/round-trip.md +26 -11
- package/onboarding/prompts/subagent/create-plan.md +14 -2
- package/onboarding/prompts/subagent/implement-and-validate.md +10 -0
- package/onboarding/prompts/subagent/prove-oss-baseline.md +35 -0
- package/onboarding/prompts/subagent/prove-round-trip.md +21 -8
- package/onboarding/prompts/unsupported/no-validated-path.md +22 -9
- package/package.json +1 -1
- package/release/release-tool.js +1 -1
|
@@ -21,8 +21,13 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
21
21
|
these URLs.
|
|
22
22
|
Do not use remembered CopilotKit instructions.
|
|
23
23
|
|
|
24
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
25
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
26
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
27
|
+
unavailable only after a second method also fails.
|
|
28
|
+
|
|
24
29
|
If the pages support the selection, run
|
|
25
|
-
`npx copilotkit@4.
|
|
30
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
26
31
|
|
|
27
|
-
If a page does not
|
|
28
|
-
`npx copilotkit@4.
|
|
32
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
33
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Configure LlamaIndex
|
|
2
|
+
|
|
3
|
+
Preserve an existing LlamaIndex model setup. Start with OpenAI for a new agent. Offer
|
|
4
|
+
another vendor only after an exact CopilotKit Markdown page names it. The page must name
|
|
5
|
+
its 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/llamaindex/quickstart.md
|
|
15
|
+
- https://docs.copilotkit.ai/llamaindex/inspector.md
|
|
16
|
+
- https://docs.copilotkit.ai/llamaindex/generative-ui/a2ui/fixed-schema.md
|
|
17
|
+
- https://docs.copilotkit.ai/llamaindex/shared-state/in-app-agent-read.md
|
|
18
|
+
|
|
19
|
+
Fetch all four pages in one step rather than one after another.
|
|
20
|
+
|
|
21
|
+
The documentation scope is `llamaindex`. Use only the Python agent examples from these
|
|
22
|
+
pages. When the repository already has a LlamaIndex agent, use the quickstart's
|
|
23
|
+
`Use an existing agent` path. Use `Start from scratch` only when the repository needs a
|
|
24
|
+
new agent. For a new agent, install the documented Python dependencies
|
|
25
|
+
`llama-index llama-index-llms-openai llama-index-protocols-ag-ui fastapi uvicorn`.
|
|
26
|
+
Preserve the existing `get_ag_ui_workflow_router` and its FastAPI router. In the
|
|
27
|
+
documented runtime, `LlamaIndexAgent` from `@ag-ui/llamaindex` targets `/run`. Do not
|
|
28
|
+
replace that adapter or change its route without repository evidence.
|
|
29
|
+
|
|
30
|
+
The fixed-schema page includes LlamaIndex backend code but does not bundle its runtime
|
|
31
|
+
setup. Use it only when the project already has the working quickstart runtime that the
|
|
32
|
+
page extends. Do not invent a replacement runtime setup.
|
|
33
|
+
|
|
34
|
+
The shared-state page is not an agent-app-context guide. Do not use it to invent a
|
|
35
|
+
`useAgentContext` backend setup. If the requested work needs app context rather than the
|
|
36
|
+
documented shared-state path, run the unsupported route below.
|
|
37
|
+
|
|
38
|
+
Record the selected framework, vendor, model, required credential variable names, these
|
|
39
|
+
URLs, the documented dependencies and adapter, and both documentation limits. Do not use
|
|
40
|
+
remembered CopilotKit instructions.
|
|
41
|
+
|
|
42
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
43
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
44
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
45
|
+
unavailable only after a second method also fails.
|
|
46
|
+
|
|
47
|
+
If the pages support the selection, run
|
|
48
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
49
|
+
|
|
50
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
51
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -51,8 +51,13 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
51
51
|
these URLs.
|
|
52
52
|
Do not use remembered CopilotKit instructions.
|
|
53
53
|
|
|
54
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
55
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
56
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
57
|
+
unavailable only after a second method also fails.
|
|
58
|
+
|
|
54
59
|
If the pages support the selection, run
|
|
55
|
-
`npx copilotkit@4.
|
|
60
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
56
61
|
|
|
57
|
-
If a page does not
|
|
58
|
-
`npx copilotkit@4.
|
|
62
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
63
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -59,8 +59,13 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
59
59
|
these URLs.
|
|
60
60
|
Do not use remembered CopilotKit instructions.
|
|
61
61
|
|
|
62
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
63
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
64
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
65
|
+
unavailable only after a second method also fails.
|
|
66
|
+
|
|
62
67
|
If the pages support the selection, run
|
|
63
|
-
`npx copilotkit@4.
|
|
68
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
64
69
|
|
|
65
|
-
If a page does not
|
|
66
|
-
`npx copilotkit@4.
|
|
70
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
71
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Configure MS Agent Harness for .NET
|
|
2
|
+
|
|
3
|
+
Preserve an existing MS Agent Harness model, vendor, credential name, and host setup. The
|
|
4
|
+
documented .NET starter uses GitHub Models. Use that vendor for a new matching setup.
|
|
5
|
+
|
|
6
|
+
For GitHub Models, name the user secret `GitHubToken`. Set it from the agent directory
|
|
7
|
+
with `dotnet user-secrets set GitHubToken`. The app must read the same name through .NET
|
|
8
|
+
configuration. Confirm `dotnet --version` works before changing the project.
|
|
9
|
+
|
|
10
|
+
For an existing OpenAI setup, keep `OPENAI_API_KEY` and the existing OpenAI client. Do not
|
|
11
|
+
convert it to GitHub Models.
|
|
12
|
+
|
|
13
|
+
Keep `INTELLIGENCE_API_KEY` separate from model-vendor credentials. Do not read, show,
|
|
14
|
+
store, or request a secret value.
|
|
15
|
+
|
|
16
|
+
## Documentation
|
|
17
|
+
|
|
18
|
+
- https://docs.copilotkit.ai/ms-agent-harness-dotnet/quickstart.md
|
|
19
|
+
- https://docs.copilotkit.ai/ms-agent-harness-dotnet/inspector.md
|
|
20
|
+
- https://docs.copilotkit.ai/ms-agent-harness-dotnet/generative-ui/a2ui/fixed-schema.md
|
|
21
|
+
- https://docs.copilotkit.ai/ms-agent-harness-dotnet/agent-app-context.md
|
|
22
|
+
|
|
23
|
+
Fetch all four pages in one step rather than one after another.
|
|
24
|
+
|
|
25
|
+
The documentation scope is `ms-agent-harness-dotnet`. Read only the `.NET` tab of the
|
|
26
|
+
quickstart. Do not use its Python tab. Use `Microsoft.Agents.AI.Harness --version 1.19.0`
|
|
27
|
+
for the stable agent package. The current AG-UI host package is
|
|
28
|
+
`Microsoft.Agents.AI.Hosting.AGUI.AspNetCore --version 1.19.0-preview.260822.1`.
|
|
29
|
+
Use `AddAGUIServer` service registration and a `MapAGUIServer` endpoint. The older
|
|
30
|
+
showcase uses `AddAGUI` and `MapAGUI`. Do not copy those stale names into the current
|
|
31
|
+
host. Register the remote endpoint in Copilot Runtime with `HttpAgent`.
|
|
32
|
+
|
|
33
|
+
The quickstart's generic .NET example uses `CreateAIAgent`. Do not replace an existing
|
|
34
|
+
Harness agent with that example. For a new Harness agent, use `AsHarnessAgent` with
|
|
35
|
+
`HarnessAgentOptions`. Disable built-in providers that add environment-dependent tools,
|
|
36
|
+
then pass the project-owned tools through `ChatOptions`.
|
|
37
|
+
|
|
38
|
+
For fixed-schema A2UI, keep the C# tool and its inline schema in the Harness agent. Set
|
|
39
|
+
`injectA2UITool` to `false` in the runtime. The page omits a bundled setup block, and its
|
|
40
|
+
action-handler note describes Python SDK behavior. Do not infer C# action-handler support
|
|
41
|
+
from the Python-only note. If the visible C# steps do not cover the requested setup, run
|
|
42
|
+
the unsupported route below.
|
|
43
|
+
|
|
44
|
+
A bare `HarnessAgent` does not consume AG-UI app context. The published example adds a
|
|
45
|
+
custom `DelegatingAIAgent` wrapper that reads context from `ChatOptions.AdditionalProperties`
|
|
46
|
+
and injects a system message. Keep app context unsupported until that wrapper passes
|
|
47
|
+
browser proof. Do not copy the page's generic `CreateAIAgent` constructor over an existing
|
|
48
|
+
Harness agent.
|
|
49
|
+
|
|
50
|
+
Record the selected framework, vendor, model, required credential variable names, these
|
|
51
|
+
URLs, and the quickstart and A2UI gaps. Do not use remembered CopilotKit instructions.
|
|
52
|
+
|
|
53
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
54
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
55
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
56
|
+
unavailable only after a second method also fails.
|
|
57
|
+
|
|
58
|
+
If the pages support the selection, run
|
|
59
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
60
|
+
|
|
61
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
62
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -34,8 +34,13 @@ Record the selected framework, vendor, model, required credential variable names
|
|
|
34
34
|
these URLs.
|
|
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. Treat a page as
|
|
40
|
+
unavailable only after a second method also fails.
|
|
41
|
+
|
|
37
42
|
If the pages support the selection, run
|
|
38
|
-
`npx copilotkit@4.
|
|
43
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
39
44
|
|
|
40
|
-
If a page does not
|
|
41
|
-
`npx copilotkit@4.
|
|
45
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
46
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Configure Pydantic AI
|
|
2
|
+
|
|
3
|
+
Preserve an existing Pydantic AI model setup. Start with OpenAI for a new agent. Offer
|
|
4
|
+
another vendor only after an exact CopilotKit Markdown page names it. The page must name
|
|
5
|
+
its 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/pydantic-ai/quickstart.md
|
|
15
|
+
- https://docs.copilotkit.ai/pydantic-ai/inspector.md
|
|
16
|
+
- https://docs.copilotkit.ai/pydantic-ai/generative-ui/a2ui/fixed-schema.md
|
|
17
|
+
- https://docs.copilotkit.ai/reference/v2/hooks/useAgentContext.md
|
|
18
|
+
|
|
19
|
+
Fetch all four pages in one step rather than one after another.
|
|
20
|
+
|
|
21
|
+
The documentation scope is `pydantic-ai`. For an existing agent, install the exact
|
|
22
|
+
documented backend set with
|
|
23
|
+
`uv add 'pydantic-ai-slim[ag-ui,openai]>=2,<3' 'starlette>=0.46.2' uvicorn`.
|
|
24
|
+
Keep the Starlette endpoint that calls `AGUIAdapter.dispatch_request`. Register it in
|
|
25
|
+
Copilot Runtime with `HttpAgent` and keep `InMemoryAgentRunner` for the documented local
|
|
26
|
+
OSS setup. Do not replace this transport with a different Pydantic AI adapter.
|
|
27
|
+
|
|
28
|
+
For fixed-schema A2UI, keep the tool in the agent. Set `injectA2UITool` to `false` in the
|
|
29
|
+
runtime. The documented Python setup does not support `action_handlers` on
|
|
30
|
+
`a2ui.render`. Do not add them or claim that the fixed-schema button callback works.
|
|
31
|
+
|
|
32
|
+
No Pydantic AI agent-app-context Markdown page is available. The reference page above
|
|
33
|
+
documents the frontend hook only. Do not invent the missing agent-side context setup. If
|
|
34
|
+
the requested work needs that setup, run the unsupported route below.
|
|
35
|
+
|
|
36
|
+
Record the selected framework, vendor, model, required credential variable names, these
|
|
37
|
+
URLs, and the context and A2UI limits. Do not use remembered CopilotKit instructions.
|
|
38
|
+
|
|
39
|
+
A fetch tool that refuses a URL, or fails to reach it, reports a limit of the tool and
|
|
40
|
+
not a fact about the page. Retrieve the same URL a second way before you judge it. Run
|
|
41
|
+
`curl -fsSL <url>`, or read the same page without the `.md` suffix. Treat a page as
|
|
42
|
+
unavailable only after a second method also fails.
|
|
43
|
+
|
|
44
|
+
If the pages support the selection, run
|
|
45
|
+
`npx --yes copilotkit@4.9.0 onboard read frontend/plan`.
|
|
46
|
+
|
|
47
|
+
If a second method also fails, or a page that loads does not support the selection, run
|
|
48
|
+
`npx --yes copilotkit@4.9.0 onboard read unsupported/no-validated-path`.
|
|
@@ -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.0 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.0 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.0 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.0 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.0 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.0 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.0 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.0 onboard read unsupported/no-validated-path`.
|
|
@@ -10,18 +10,24 @@ evidence, then ask the developer to choose.
|
|
|
10
10
|
The valid choices are React SPA, Next.js, Angular, Vue 3, and React Native. They are valid
|
|
11
11
|
in every starting state. Do not show the internal route.
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
13
|
+
Recommend the frontend the project already uses. Where there is no existing frontend,
|
|
14
|
+
recommend the one the developer names, and say what each choice implies for where the
|
|
15
|
+
CopilotKit runtime lives: Next.js hosts it in a route handler, Angular in its SSR
|
|
16
|
+
server, and Vue 3, React SPA and React Native reach a runtime that runs as its own
|
|
17
|
+
process.
|
|
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.
|
|
17
23
|
|
|
18
24
|
Use exactly one matching internal route:
|
|
19
25
|
|
|
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.
|
|
26
|
+
1. React SPA: `npx --yes copilotkit@4.9.0 onboard read frontend/react-spa`
|
|
27
|
+
2. Next.js: `npx --yes copilotkit@4.9.0 onboard read frontend/nextjs`
|
|
28
|
+
3. Angular: `npx --yes copilotkit@4.9.0 onboard read frontend/angular`
|
|
29
|
+
4. Vue 3: `npx --yes copilotkit@4.9.0 onboard read frontend/vue`
|
|
30
|
+
5. React Native: `npx --yes copilotkit@4.9.0 onboard read frontend/react-native`
|
|
25
31
|
|
|
26
32
|
If no listed frontend fits, run
|
|
27
|
-
`npx copilotkit@4.
|
|
33
|
+
`npx --yes copilotkit@4.9.0 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.0 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.0 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.0 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.0 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.0 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.0 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.0 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.0 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
|
|
@@ -25,11 +25,21 @@ about it: keep this version pin, wire this constructor, run this build. It never
|
|
|
25
25
|
as an account of hitting it. No count of what went wrong, no list of fixes made along the
|
|
26
26
|
way, no argument that a failed check is not a defect.
|
|
27
27
|
|
|
28
|
-
|
|
29
|
-
|
|
28
|
+
The handoff must include:
|
|
29
|
+
|
|
30
|
+
- The URL of the running app.
|
|
31
|
+
- The command that starts the app in the future.
|
|
32
|
+
- How to use the CopilotKit Inspector.
|
|
33
|
+
- How to use https://intelligence.copilotkit.ai to manage the Intelligence installation.
|
|
34
|
+
- The process IDs and stop commands for the running agent and frontend.
|
|
35
|
+
|
|
36
|
+
State that the servers remain running after proof.
|
|
37
|
+
|
|
38
|
+
If the developer permitted external feedback at the start, report each thing that slowed
|
|
39
|
+
this run down. Send at most four reports, worst first:
|
|
30
40
|
|
|
31
41
|
```text
|
|
32
|
-
npx copilotkit@4.
|
|
42
|
+
npx --yes copilotkit@4.9.0 onboard friction --category <slug> --cost-seconds <seconds>
|
|
33
43
|
```
|
|
34
44
|
|
|
35
45
|
Write one or two sentences on the command's standard input. Pick one category from
|
|
@@ -42,16 +52,15 @@ that carries any of those, prints the reason, and exits zero. A refused report i
|
|
|
42
52
|
a failed step and not a failed onboarding run. Reword it and send it again, or move
|
|
43
53
|
on. A run that proves a round trip is complete whether or not it reported friction.
|
|
44
54
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
blunt version.
|
|
55
|
+
Tell the developer when you send a friction report. Do not quote or summarize the report
|
|
56
|
+
unless the developer asks. If the developer did not permit feedback, do not run a friction
|
|
57
|
+
command.
|
|
49
58
|
|
|
50
|
-
When the evidence is complete, run `npx copilotkit@4.
|
|
59
|
+
When the evidence is complete, run `npx --yes copilotkit@4.9.0 onboard complete`, carrying
|
|
51
60
|
the visual-check outcome the proof subagent returned:
|
|
52
61
|
|
|
53
62
|
```text
|
|
54
|
-
npx copilotkit@4.
|
|
63
|
+
npx --yes copilotkit@4.9.0 onboard complete --visual-check <outcome>
|
|
55
64
|
```
|
|
56
65
|
|
|
57
66
|
The outcome is one of `performed`, `skipped-no-browser-tool`, or `failed`. The command
|
|
@@ -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.0 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.0 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.0 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.
|