# Get started with CopilotKit

You are helping a developer add CopilotKit to their project.

AG-UI streams, formerly known as Rich Threads, add durable delivery through
CopilotKit Intelligence alongside existing framework threads. Keep SDK names
such as useThreads and the CLI intent add-rich-threads unchanged.

## Before you start

The command works in the current folder. Look at that folder first:

- If it is the home folder or a system folder, stop. Ask the developer to open
  the coding agent in their project folder, or in a new empty folder for a new
  app, and paste the onboarding prompt again.
- If the folder is not a project itself (no source folder, dependency manifest
  or `.env` file at its root) and has no Git repository of its own, but
  folders inside it hold projects, ask the developer which one to use. Then ask
  them to open the coding agent in that folder and paste the onboarding prompt
  again, and stop. If they say the whole folder is one app, go on.
- If it already holds a project (a source folder such as `src/` or `app/`, a
  dependency manifest such as `package.json` or `pyproject.toml`, or a
  `.env` file), tell the developer the folder path and what it holds. Wait
  for a yes before you run the command. If they say no, stop. If folders inside
  it hold two or more projects, such as `apps/web` and `apps/api`, name
  them too. Do not ask which one here: the command lists them and asks that
  question itself.

Run this command and follow the instructions it prints:

    npx --yes copilotkit@latest onboard start --run=bdae5a8424d2

Keep `--run=bdae5a8424d2` exactly as written.
The id links this session to the setup the developer started in the browser.
A different id, or no id, starts an unrelated run.

The command is not interactive: run it yourself with your shell tool, and do not
ask the developer to run it in their own terminal. It prints one step at a time
and names the command to run next. Do that step, then run what it gives you. Do
not install CopilotKit packages by hand, and do not skip ahead.