ContextQMD
Back to Copilotkit

Cli

showcase/shell-docs/src/content/snippets/shared/cli/cli.mdx

1.62.34.6 KB
Original Source

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, 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, or install CopilotKit agent skills for your coding agent.

<OpsPlatformCTA variant="inline" title="Start with a hosted Enterprise Intelligence project" body="Create a free account, then copy the create command below to scaffold a connected app." ctaLabel="Create a free account" surface="docs_cli_intro_signup" />

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

<Steps> <Step> ### Run create 
```bash title="Terminal"
npx copilotkit@latest create
```

The CLI prompts for the app name and framework, opens browser sign-in when needed, scaffolds the starter, and connects the app to a cloud-hosted Enterprise Intelligence project.
</Step> <Step> ### Sign in 
If you are not already signed in, the CLI opens a browser login flow. Complete login in the browser, then return to the terminal.

If the browser does not open, the CLI prints a login URL and supports a manual paste fallback.
</Step> <Step> ### Select a project 
Choose an existing cloud-hosted project or create a new one. A project is where your app's threads, messages, and platform metadata are stored.

The CLI writes the selected project to `.copilotkit/project.json`:

```json title=".copilotkit/project.json"
{
  "projectId": "proj_...",
  "projectSlug": "support-assistant",
  "clerkOrgId": "org_..."
}
```
</Step> <Step> ### Use the generated environment 
The CLI writes the hosted platform URLs and project-scoped runtime API key to `.env`.

```bash title=".env"
INTELLIGENCE_API_URL=https://...
INTELLIGENCE_GATEWAY_WS_URL=wss://...
INTELLIGENCE_API_KEY=cpk_...
```

Keep `INTELLIGENCE_API_KEY` on the server side. It is a runtime key for the selected project, not a frontend token.
</Step> <Step> ### Start development 
```bash title="Terminal"
npm run dev
```

The starter runs your local app and runtime while storing durable threads in the cloud-hosted project selected by the CLI.
</Step> </Steps>

Connect an existing app

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

bash
npx copilotkit@latest skills onboard

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

bash
npx copilotkit@latest project select

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

Auth commands

CommandWhat it does
npx copilotkit@latest loginOpens the browser sign-in flow and stores a local CLI session.
npx copilotkit@latest whoamiShows the signed-in user and active organization.
npx copilotkit@latest logoutClears the local CLI session.

Project commands

CommandWhat it does
npx copilotkit@latest project selectSelects or creates a cloud-hosted Enterprise Intelligence project for the current directory.
npx copilotkit@latest license createIssues a CopilotKit license token for flows that require one.
npx copilotkit@latest license listLists license metadata for the current user or organization.

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

CommandWhat it does
npx copilotkit@latest skills installInstalls CopilotKit agent skills for supported coding agents.
npx copilotkit@latest skills onboardInstalls skills, then starts agent-assisted onboarding for an existing app.

Next steps