copilotkit 3.0.3 → 4.0.0

package/README.md

@@ -54,7 +54,7 @@ persistence, insights), and `init` provisions a free license automatically —
 you sign in with your browser during scaffolding. The `-i`/`--intelligence`
 flag is retained as a deprecated no-op for backward compatibility.
 
-Supported framework values include `langgraph-py`, `langgraph-js`, `mastra`, `pydantic-ai`, `aws-strands-py`, `adk`, `a2a`, `microsoft-agent-framework-dotnet`, `microsoft-agent-framework-py`, `flows`, `llamaindex`, and `agno`.
+Supported framework values include `langgraph-py`, `langgraph-js`, `mastra`, `pydantic-ai`, `aws-strands-py`, `adk`, `a2a`, `microsoft-agent-framework-dotnet`, `microsoft-agent-framework-py`, `flows`, `llamaindex`, `agno`, `ag2`, `mcp-apps`, `agentcore-langgraph`, `agentcore-strands`, `a2ui`, and `opengenui`.
 
 `init` and `create` collect your starter choices, then connect project creation
 to your CopilotKit workspace through Ops/Clerk before scaffolding. If you
@@ -69,13 +69,34 @@ when you already have an app and want your coding agent to add CopilotKit for yo
 
 ```bash
 copilotkit skills install
+copilotkit skills install -y
+copilotkit skills install --skill react-core,runtime --agent claude-code
+copilotkit skills install --list
 copilotkit skills onboard
 copilotkit skills onboard --no-clipboard
 ```
 
-`copilotkit skills install` installs all CopilotKit agent skills for your coding
+`copilotkit skills install` installs CopilotKit agent skills for your coding
 agent (Claude Code, Codex, Cursor, Gemini, and others) by running the standalone
-`skills` installer under the hood. It runs without a TTY, so it is safe in CI.
+`skills` installer under the hood.
+
+By default it installs every skill and prompts you to choose which coding agents
+to install them to. Narrow or automate the install with these flags (they work
+on both `install` and `onboard`):
+
+- `-s, --skill <names>` — comma-separated skills to install (default: all),
+  e.g. `--skill react-core,runtime`.
+- `-a, --agent <names>` — comma-separated coding agents to install to
+  (default: choose interactively), e.g. `--agent claude-code,cursor`.
+- `-y, --yes` — install everything (all skills to all agents) non-interactively.
+- `--global` — install at the user level instead of the current project.
+- `--list` — list the available skills and exit without installing (`install`
+  only).
+
+Choosing which coding agents to install to is interactive, so a non-interactive
+environment (CI, scripts) must make the choice deterministic: pass `-y` to
+install everything, or `--agent <name>` to target specific agents. Otherwise the
+command exits with guidance instead of hanging.
 
 `copilotkit skills onboard` is a superset of `install`. It also:
 
@@ -89,7 +110,8 @@ agent (Claude Code, Codex, Cursor, Gemini, and others) by running the standalone
 Pass `--no-clipboard` to always print the prompt instead of copying it. This is
 useful in headless or remote shells where clipboard access is unavailable.
 `onboard` requires an interactive terminal because it opens a browser to sign
-in; use `skills install` for non-interactive environments.
+in; use `skills install -y` (or `--agent <name>`) for non-interactive
+environments.
 
 When to use which:
 
@@ -126,7 +148,19 @@ After creation, add any provider secrets required by the template. Most template
 OPENAI_API_KEY=your-key-here
 ```
 
-The ADK template uses `GOOGLE_API_KEY`. The A2A template uses both `GOOGLE_API_KEY` and `OPENAI_API_KEY`.
+(Replace `your-key-here` with your real key — placeholder-shaped values are
+rejected by the dev preflight described below.)
+
+The ADK template uses `GOOGLE_API_KEY`. The A2A template uses both `OPENAI_API_KEY` and `GOOGLE_API_KEY`.
+
+For threads-enabled scaffolds, `npm run dev` verifies the required key(s)
+before starting anything: if a key is unset, empty, or still an obvious
+placeholder (wrapped in `<...>`, starting with `your-`/`your_`, or ending in
+`...` like the printed examples), the run exits with instructions naming the
+key, the vendor console URL to create one, and the exact `.env` line to add.
+A real key exported in your shell environment satisfies the check too. An
+exported empty or whitespace value falls back to the `.env` value, while an
+exported placeholder-shaped value fails the gate outright.
 
 The Microsoft Agent Framework .NET template uses GitHub Models. Set its C# agent token with `dotnet user-secrets set GitHubToken "<your-token>"` from the generated `agent/` directory.
 
@@ -134,11 +168,28 @@ Do not commit generated `.env` files or personal secrets.
 
 ## Run A Generated Project
 
-After scaffolding:
+After scaffolding, the CLI prompts you to install dependencies:
+
+```
+Install dependencies now? (npm install) [Y/n]
+```
+
+Press Enter (or `y`) to let the CLI run the install command for you. Press `n` to skip and run it yourself later. Either way, the CLI then prints the exact next steps.
+
+When a required LLM vendor API key is missing from `.env` — unset, empty, or still a placeholder — the next-step block names the key, links to the vendor console, and shows the exact `.env` line to add before you run the dev server:
+
+```
+Set OPENAI_API_KEY before running: Required by the agent runtime.
+  Get a key:  https://platform.openai.com/api-keys
+  Add to .env:  OPENAI_API_KEY=sk-...
+```
+
+This is the same key the `npm run dev` preflight gate enforces (see [Environment Files](#environment-files)), so the two are always in agreement.
+
+The CLI also prints `cd <project>` because it cannot change your shell's working directory. `npm run dev` is always left for you to run:
 
 ```bash
 cd my-agent
-npm install
 npm run dev
 ```
 
@@ -151,7 +202,7 @@ python3 -m venv agents/.venv
 agents/.venv/bin/pip install -r agents/requirements.txt
 ```
 
-For the Intelligence threads template, keep Docker Desktop running before `npm run dev`. The root dev script starts the required Docker Compose services automatically, so a separate `docker compose up` step is only needed when you intentionally want to manage infrastructure by hand.
+For the Intelligence threads template, keep Docker Desktop running before `npm run dev`. The root dev script starts the required Docker Compose services automatically when a license token is present in `.env` (without one it prints a "threads locked" hint and skips Docker), so a separate `docker compose up` step is only needed when you intentionally want to manage infrastructure by hand.
 
 ## Diagnostics