CopilotKit CLI

What is this?#

The CopilotKit CLI helps you create CopilotKit apps and connect them to Cloud-Hosted Enterprise Intelligence. It handles browser sign-in, project selection, project-scoped runtime API keys, historical thread import, and local project configuration so your app can use durable threads and hosted conversation history.

Use the CLI when you want to start a new app, connect an existing app to a cloud-hosted project, import historical ADK or LangGraph conversations, or install CopilotKit agent skills for your coding agent.

Prerequisites#

• Node.js 20+
• A CopilotKit account for Cloud-Hosted Enterprise Intelligence
• An OpenAI API key or another model provider key for the starter app you choose

Start a new app#

npx copilotkit@latest create

{
  "projectId": "proj_...",
  "projectSlug": "support-assistant",
  "clerkOrgId": "org_..."
}

INTELLIGENCE_API_URL=https://...
INTELLIGENCE_GATEWAY_WS_URL=wss://...
INTELLIGENCE_API_KEY=cpk_...

npm run dev

Connect an existing app#

Use agent-assisted onboarding when you already have an application and want help finding the right CopilotKit integration points:

npx copilotkit@latest skills onboard

Then select or create the cloud-hosted project for the app:

npx copilotkit@latest project select

project select requires a CLI session. If you are signed out, run npx copilotkit@latest login first.

Import historical conversations#

Use import to bring historical Google ADK or LangGraph conversation threads into the Enterprise Intelligence project selected for your app.

npx copilotkit@latest import --source adk

npx copilotkit@latest import --source langgraph

The command runs interactively by default. It discovers source agent keys and conversation counts, previews the import, asks you to map source agents, and confirms before writing to Enterprise Intelligence.

For scripted runs, pass flags for the prompts:

npx copilotkit@latest import \
  --source langgraph \
  --api-url "$INTELLIGENCE_API_URL" \
  --api-key "$INTELLIGENCE_API_KEY" \
  --agent-map ./agent-map.json \
  --user-source configurable.user_id \
  --yes

For ADK imports, configure the source backend and scopes with flags or environment variables:

npx copilotkit@latest import \
  --source adk \
  --adk-source-backend database \
  --adk-import-scopes "support:user-123" \
  --agent-map ./agent-map.json

import reads source credentials from framework-native environment variables instead of raw CLI flags. ADK uses ADK_SOURCE_BACKEND, ADK_IMPORT_SCOPES, ADK_DATABASE_CONNECTION_STRING, or ADK_VERTEX_*. LangGraph uses LANGGRAPH_API_URL plus LANGGRAPH_API_KEY or LANGSMITH_API_KEY.

Run a side-effect-free preview with --dry-run. Use --replace when you need to refresh threads that were already imported.

Auth commands#

Project commands#

Re-running project select is safe when you need to move a local app to a different cloud-hosted project. The command updates .copilotkit/project.json and provisions a project-scoped API key for the selected project.

Skills commands#

Next steps#

• Cloud-hosted platform: Cloud-Hosted Enterprise Intelligence — login, projects, API keys, threads, and plans in the hosted web app
• Add threads: Threads — add persistent, resumable conversations to your app
• Self-hosting: Self-Hosting Enterprise Intelligence — run the Enterprise Intelligence Platform in your own Kubernetes cluster