wehub-resource-sync
69 lines
2.9 KiB
Markdown
69 lines
2.9 KiB
Markdown
# Cline SDK Examples
|
|
|
|
Learn how to build with the Cline SDK through working examples, ordered from simple to complex.
|
|
|
|
## SDK Skill
|
|
If you use a coding agent (Claude Code, Codex, Cline, etc.), install the [Cline SDK skill](https://github.com/cline/sdk-skill) to give your agent context on the SDK's APIs and best practices to help you build with the Cline SDK.
|
|
|
|
```bash
|
|
npx skills add cline/sdk-skill
|
|
```
|
|
|
|
Prompt it to scaffold agents, create custom tools, wire up plugins, configure providers, and more.
|
|
|
|
## Getting started
|
|
|
|
All examples live in this directory. Each is a standalone project with its own `package.json` and README. To run any example:
|
|
|
|
```bash
|
|
cd apps/examples/<example-name>
|
|
bun install
|
|
bun run build:sdk
|
|
export CLINE_API_KEY="cline_..."
|
|
bun dev
|
|
```
|
|
|
|
Requires Node.js 22+.
|
|
|
|
## Examples
|
|
|
|
### Beginner
|
|
|
|
| Example | Description | Concepts |
|
|
|---------|-------------|----------|
|
|
| [quickstart](./quickstart) | Send one prompt, stream the response. ~15 lines of code. | `Agent`, `subscribe`, `run()` |
|
|
| [cli-agent](./cli-agent) | Interactive terminal chat with a shell tool. | `createTool`, multi-turn `run()`/`continue()`, streaming |
|
|
| [cline-core-cli-agent](./cline-core-cli-agent) | Interactive terminal chat powered by ClineCore. | `ClineCore.create()`, `cline.start()`, `cline.send()`, built-in tools, streaming |
|
|
|
|
### Intermediate
|
|
|
|
| Example | Description | Concepts |
|
|
|---------|-------------|----------|
|
|
| [code-review-bot](./code-review-bot) | AI code reviewer that reads git diffs and produces structured comments. | Multiple tools, `completesRun` lifecycle, `systemPrompt`, zod schemas |
|
|
| [multi-agent](./multi-agent) | Web app that fans out to three specialist agents in parallel, streams results via SSE, then synthesizes a unified answer. | Concurrent agents, `Promise.all`, per-agent `subscribe()`, SSE streaming, agent composition |
|
|
|
|
### Advanced
|
|
|
|
| Example | Description | Concepts |
|
|
|---------|-------------|----------|
|
|
| [desktop-app](./desktop-app) | Full Tauri + Next.js desktop app for running and inspecting chat sessions. | Sidecar runtime, websocket transport, session persistence |
|
|
| [menubar](./menubar) | macOS menu bar app with Tauri. | Native app integration, compact UI |
|
|
| [vscode](./vscode) | VS Code extension with chat panel. | Extension API, webview, workspace context |
|
|
|
|
## SDK packages
|
|
|
|
When building your own app, install the public SDK package:
|
|
|
|
```bash
|
|
npm add @cline/sdk
|
|
```
|
|
|
|
`@cline/sdk` re-exports everything from `@cline/core`. You only need `@cline/agents` or `@cline/llms` if you want lower-level control over the agent runtime or model gateway directly.
|
|
|
|
## Learn more
|
|
|
|
- [SDK package docs](../../sdk/packages/README.md)
|
|
- [Architecture guide](../../ARCHITECTURE.md)
|
|
- [Plugin examples](../../examples/plugins) - extend the Cline SDK and CLI with custom tools and event hooks
|
|
- [Hook examples](../../examples/hooks) - lifecycle hooks for logging, blocking, and injection for Cline SDK and CLI
|