mirror of
https://github.com/cline/cline.git
synced 2026-09-19 10:13:34 +08:00
* docs: add comprehensive SDK documentation as top-level tab Adds 27 new documentation pages for the Cline SDK (@clinebot/core, @clinebot/agents, @clinebot/llms, @clinebot/shared) organized into a dedicated "SDK" tab in the Mintlify docs navigation. Structure: - Getting Started: overview, quickstart, examples - Core Concepts: agents, sessions, tools, streaming/events, extensions, hooks, providers/models - Guides: building an agent, custom tools, writing extensions, permission handling, scheduled agents, multi-agent teams, connectors, production - Architecture: layered stack overview, hub-spoke RPC, package reference - API Reference: ClineCore, Agent, Gateway, Tools API, Events, Types - CLI: commands, configuration, connector setup Removes the old single-page SDK overview (cline-sdk/overview.md) that documented the previous ACP-based ClineAgent API, and removes its reference from the Cline CLI navigation group. * docs: fix SDK docs review feedback - Change "desktop app" to "JetBrains plugin" in overview (not released yet) - Rename "Providers & Models" to "Model Providers" - Rename "Streaming & Events" to "Streaming Events" - Remove duplicate cli/connectors.mdx (guides/connectors.mdx covers everything) * docs: add wizard commands, Discord connector, and platform credential details * feat(docs): create CLI tab with new feature pages and updated reference - Add CLI as its own top-level tab in docs navigation - Remove CLI group from Docs tab and SDK tab - Delete SDK CLI pages (content moved to CLI tab) - Add new feature pages: connectors, scheduling, MCP servers, agent teams - Rewrite cli-reference.mdx with all new commands (connect, mcp, schedule, rpc, checkpoint, doctor) and new flags (reasoning-effort, thinking, sandbox, teams, spawn, tool-enable/disable, autoapprove) - Update configuration.mdx with new directory structure, env vars (CLINE_DATA_DIR, CLINE_RPC_ADDRESS, CLINE_SESSION_BACKEND_MODE, CLINE_SANDBOX), and MCP wizard reference * docs: rename Docs tab to Extension and reorder tabs Tab order: Extension, CLI, SDK, Kanban, Enterprise, API, Learn * docs: simplify SDK install to single @clinebot/core package @clinebot/core re-exports from agents, llms, and shared, so users only need one install and one import source. Updated all getting-started, quickstart, examples, and guide pages to import from @clinebot/core. Concept and reference pages keep individual package imports since they document those specific packages. * docs: use @clinebot/sdk as the primary install and import path @clinebot/sdk is an alias for @clinebot/core that re-exports from all packages. All user-facing pages (overview, quickstart, examples, guides) now show npm install @clinebot/sdk and import from @clinebot/sdk. Architecture and reference pages keep individual package names since they document the internal package structure. * docs: rename Extension tab to Cline * docs: fix packages page and merge duplicate imports * fix: use getting-started page in CLI tab nav and remove conflicting redirect * docs: rename CLI Getting Started page title to Overview * docs: rename cline-cli/ to cli/ and cline-sdk/ to sdk/ Shorter, cleaner URL paths. Updated all internal links across every doc page and added 44 redirects for old paths so existing URLs don't break. * docs: update hub-spoke architecture from gRPC/RPC to WebSockets - Rewrite hub-spoke.mdx: WebSocket protocol, capability brokerage, spoke workers, session participants, hub daemon discovery - Replace all RPC/gRPC/sidecar references with hub/WebSocket across all SDK and CLI docs - Backend modes: local/hub/remote/auto (was local/rpc/auto) - Hub command replaces rpc command (cline hub start/stop/status/ensure) - Default port 25463 (was 4317), log file hub-daemon.log - Remove @clinebot/rpc and @clinebot/scheduler from architecture docs (functionality absorbed into @clinebot/core) - Update ClineCore reference to remove rpc options - Add capability brokerage and session participant concepts * docs: add Ecosystem page to SDK tab * docs: move Ecosystem page after Guides and fix opening sentence * docs: rename extensions to plugins across all SDK and CLI docs - Rename AgentExtension to AgentPlugin in all code examples - Rename ExtensionAPI to PluginAPI - Rename extensions.mdx to plugins.mdx, writing-extensions.mdx to writing-plugins.mdx - Rename all variable names (databaseExtension -> databasePlugin, etc.) - Rename config field from extensions to plugins - Update all prose, section headers, and cross-links - Add redirects for old paths * clean up attempt 1 * remove deprecated features * part 1 of large provider changes * a large pass on workflows * cli ref updates * config rewrite * more concise instsallation and model selection * provider reorg cont * update providers * one step further cleaning up * kanban finishing clean up * wip... * another big cleanup - remove the CLI tabgroup * sdk tighten up pt1 * more sdk doc tightening * making more progress * doc update based on bee latest branch * nit update on codepaths * remove learn section * docs: add plugin install command documentation Document the new clite plugin install command across CLI reference, customization plugins page, SDK plugins concept page, and the writing plugins guide. Cover all three source types (npm, git, local), the package.json manifest format with cline.plugins field, host-provided dependency handling, auto-detection logic, and the install directory structure. Reference cline/typescript-lsp-plugin as a concrete install example. * docs: deduplicate plugin install docs Trim redundant plugin install content from CLI reference, SDK plugins concept page, and writing-plugins guide. Each now links to the customization/plugins page as the single source of truth for manifest format, install commands, and directory layout. * further simplify the doc * further clean up * mark warnings * docs: rename @clinebot to @cline and clite to cline SDK packages moved to the @cline npm org. Update all docs references to use @cline/sdk, @cline/agents, @cline/core, @cline/shared, @cline/llms and the cline CLI binary name. * docs: streamline SDK docs with example references (#10617) * docs: streamline SDK docs with example references and @cline/sdk imports Replace large standalone code blobs in SDK docs with references to working examples in the SDK repository. Users can now clone and run real code instead of copy-pasting from docs. - Update all imports from @cline/agents, @cline/core, @cline/shared to @cline/sdk (the public-facing package) - Fix model IDs from claude-sonnet-4-6 to claude-sonnet-4-20250514 - Quickstart: trim duplicate code patterns, add cards linking to cli-agent, code-review-bot, multi-agent, desktop-app examples - Overview: add examples table with difficulty progression, update install instructions to use @cline/sdk - Building an Agent: rewrite as a walkthrough of the code-review-bot example rather than inline code blobs across 4 separate files - Creating Custom Tools: rewrite to use createTool with zod, add completion tools section, reference working examples - Tools: show createTool with zod as primary pattern - Events: reference multi-agent example for streaming UI pattern - Architecture: update install to @cline/sdk * fix: use claude-sonnet-4-6 model ID across all SDK docs * remove connector page from sdk * small reordering * clean up sdk app and plugin examples --------- Co-authored-by: Renee Huang <renee@cline.bot> * remove features/connectors * doc revisions * fix references after folder change * docs: fix SDK review feedback after rebase * docs: address Greptile SDK review feedback * docs: move TUI page under CLI nav * docs: restore TUI page placement --------- Co-authored-by: Renee Huang <renee@cline.bot> Co-authored-by: John Simone <john@cline.bot> Co-authored-by: Arafatkatze <arafat.da.khan@gmail.com>
341 lines
9.9 KiB
Plaintext
341 lines
9.9 KiB
Plaintext
---
|
|
title: "GitHub Issue RCA Sample"
|
|
description: "Automated GitHub issue analysis using Cline CLI to identify root causes."
|
|
---
|
|
|
|
Automated GitHub issue analysis using Cline CLI. This script uses Cline's autonomous AI capabilities to fetch, analyze, and identify root causes of GitHub issues, outputting clean, parseable results that can be easily integrated into your development workflows.
|
|
|
|
<Note>
|
|
**New to Cline CLI?** This sample assumes you have already completed the [Installation Guide](https://docs.cline.bot/getting-started/installing-cline) and authenticated with `cline auth`. If you haven't set up Cline CLI yet, please start there first.
|
|
</Note>
|
|
|
|
<Frame>
|
|
<img src="https://storage.googleapis.com/cline_public_images/cli-rca.gif" alt="CLI Root Cause Analysis Demo" width="600" />
|
|
</Frame>
|
|
|
|
## Prerequisites
|
|
|
|
This sample assumes you have already:
|
|
|
|
- **Cline CLI** installed and authenticated ([Installation Guide](https://docs.cline.bot/getting-started/installing-cline))
|
|
- **At least one AI model provider** configured (e.g., OpenRouter, Anthropic, OpenAI)
|
|
- **Basic familiarity** with Cline CLI commands
|
|
|
|
Additionally, you'll need:
|
|
|
|
- **GitHub CLI** (`gh`) installed and authenticated
|
|
- **jq** installed for JSON parsing
|
|
- **bash** shell (or compatible shell)
|
|
|
|
### Installation Instructions
|
|
|
|
#### macOS
|
|
|
|
<Note>
|
|
These instructions require [Homebrew](https://brew.sh/) to be installed. If you don't have Homebrew, install it first by running:
|
|
```bash
|
|
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
|
|
```
|
|
</Note>
|
|
|
|
```bash
|
|
# Install GitHub CLI
|
|
brew install gh
|
|
|
|
# Install jq
|
|
brew install jq
|
|
|
|
# Authenticate with GitHub
|
|
gh auth login
|
|
```
|
|
|
|
#### Linux
|
|
|
|
```bash
|
|
# Install GitHub CLI (Debian/Ubuntu)
|
|
sudo apt install gh
|
|
|
|
# Or for other Linux distributions, see: https://cli.github.com/manual/installation
|
|
|
|
# Install jq (Debian/Ubuntu)
|
|
sudo apt install jq
|
|
|
|
# Authenticate with GitHub
|
|
gh auth login
|
|
```
|
|
|
|
## Getting the Script
|
|
|
|
**Option 1: Download directly with curl**
|
|
```bash
|
|
curl -O https://raw.githubusercontent.com/cline/cline/main/src/samples/cli/github-issue-rca/analyze-issue.sh
|
|
```
|
|
|
|
**Option 2: Copy the full script**
|
|
|
|
<Accordion title="Click to view the complete analyze-issue.sh script">
|
|
|
|
```bash
|
|
#!/bin/bash
|
|
# Analyze a GitHub issue using Cline CLI
|
|
|
|
if [ -z "$1" ]; then
|
|
echo "Usage: $0 <github-issue-url> [prompt]"
|
|
echo "Example: $0 https://github.com/owner/repo/issues/123"
|
|
echo "Example: $0 https://github.com/owner/repo/issues/123 'What is the root cause of this issue?'"
|
|
exit 1
|
|
fi
|
|
|
|
# Gather the args
|
|
ISSUE_URL="$1"
|
|
PROMPT="${2:-What is the root cause of this issue?}"
|
|
# Ask Cline for its analysis, showing only the summary
|
|
cline --auto-approve true --json "$PROMPT: $ISSUE_URL" | \
|
|
jq -r 'select(.type == "agent_event" and .event.type == "done") | .event.text' | \
|
|
sed 's/\\n/\n/g'
|
|
```
|
|
|
|
</Accordion>
|
|
|
|
<Note>
|
|
**After downloading or creating the script**, make it executable by running:
|
|
```bash
|
|
chmod +x analyze-issue.sh
|
|
```
|
|
</Note>
|
|
|
|
## Quick Usage Examples
|
|
|
|
### Basic Usage
|
|
|
|
Run this command in your terminal from the directory where you saved the script to analyze an issue with the default root cause prompt:
|
|
|
|
```bash
|
|
./analyze-issue.sh https://github.com/owner/repo/issues/123
|
|
```
|
|
|
|
This will:
|
|
- Fetch issue #123 from the repository
|
|
- Analyze the issue to identify root causes
|
|
- Provide detailed analysis with recommendations
|
|
|
|
### Custom Analysis Prompt
|
|
|
|
Ask specific questions about the issue:
|
|
|
|
```bash
|
|
./analyze-issue.sh https://github.com/owner/repo/issues/456 "What is the security impact?"
|
|
```
|
|
|
|
<Note>
|
|
The script will automatically handle everything: fetching the issue, analyzing it with Cline, and displaying the results. The analysis typically takes 30-60 seconds depending on the issue complexity.
|
|
</Note>
|
|
|
|
## How It Works
|
|
|
|
Let's analyze each component of the script to understand how it works.
|
|
|
|
### Argument Validation
|
|
|
|
The script validates input and provides usage instructions:
|
|
|
|
```bash
|
|
if [ -z "$1" ]; then
|
|
echo "Usage: $0 <github-issue-url> [prompt]"
|
|
echo "Example: $0 https://github.com/owner/repo/issues/123"
|
|
echo "Example: $0 https://github.com/owner/repo/issues/123 'What is the root cause?'"
|
|
exit 1
|
|
fi
|
|
```
|
|
|
|
**Key Points:**
|
|
- Validates required GitHub issue URL
|
|
- Shows clear usage examples
|
|
- Supports optional custom prompt
|
|
|
|
### Argument Parsing
|
|
|
|
The script extracts and sets up the arguments:
|
|
|
|
```bash
|
|
# Gather the args
|
|
ISSUE_URL="$1"
|
|
PROMPT="${2:-What is the root cause of this issue?}"
|
|
```
|
|
|
|
**Explanation:**
|
|
- `ISSUE_URL="$1"` - First argument is always the issue URL
|
|
- `PROMPT="${2:-...}"` - Second argument is optional, defaults to root cause analysis
|
|
- The SDK CLI runs the task directly, so no address flag is required.
|
|
|
|
### The Core Analysis Pipeline
|
|
|
|
This is where the magic happens:
|
|
|
|
```bash
|
|
# Ask Cline for its analysis, showing only the summary
|
|
cline --auto-approve true --json "$PROMPT: $ISSUE_URL" | \
|
|
jq -r 'select(.type == "agent_event" and .event.type == "done") | .event.text' | \
|
|
sed 's/\\n/\n/g'
|
|
```
|
|
|
|
<Accordion title="Pipeline Breakdown: Understanding Each Component">
|
|
|
|
**1. `cline --auto-approve true --json "$PROMPT: $ISSUE_URL"`**
|
|
- `cline` is the Cline CLI binary
|
|
- Act mode is the default for prompt runs
|
|
- `--auto-approve true` allows tool use without interactive prompts
|
|
- `--json` emits newline-delimited JSON for parsing
|
|
- Constructs prompt with issue URL
|
|
|
|
**2. `jq -r 'select(.type == "agent_event" and .event.type == "done") | .event.text'`**
|
|
- Filters for the final agent `done` event
|
|
- Extracts the final text field
|
|
- `-r` outputs raw strings (no JSON quotes)
|
|
|
|
**3. `sed 's/\\n/\n/g'`**
|
|
- Converts escaped newlines to actual newlines
|
|
- Makes output readable
|
|
|
|
</Accordion>
|
|
|
|
## Sample Output
|
|
|
|
Here's an example analyzing a real Flutter issue:
|
|
|
|
```bash
|
|
$ ./analyze-issue.sh https://github.com/csells/flutter_counter/issues/2
|
|
```
|
|
|
|
**Output:**
|
|
|
|
```markdown
|
|
**Root Cause Analysis of Issue #2: "setState isn't cutting it"**
|
|
|
|
After examining the GitHub issue and analyzing the Flutter counter codebase,
|
|
I've identified the root cause of why setState() is insufficient for this
|
|
project's needs:
|
|
|
|
## Current Implementation Problems
|
|
|
|
The current Flutter counter app uses setState() for state management, which
|
|
has several limitations:
|
|
|
|
1. **Local State Only**: setState() only works within a single widget, making
|
|
it difficult to share state across the app
|
|
2. **Rebuild Overhead**: Every setState() call rebuilds the entire widget tree,
|
|
causing performance issues with complex UIs
|
|
3. **No State Persistence**: State is lost when the widget is disposed
|
|
4. **Testing Challenges**: setState-based logic is tightly coupled to the UI,
|
|
making unit testing difficult
|
|
|
|
## Why This Matters
|
|
|
|
As the app grows beyond a simple counter, these limitations become critical:
|
|
- Multiple screens need to access the count
|
|
- State needs to persist across navigation
|
|
- Business logic should be testable independently
|
|
- UI should only rebuild when necessary
|
|
|
|
## Recommended Solutions
|
|
|
|
The issue mentions "Provider or Bloc" - both are excellent alternatives:
|
|
|
|
1. **Provider**: Simple, lightweight state management using InheritedWidget
|
|
- Easy migration path from setState
|
|
- Good for small to medium apps
|
|
- Official Flutter recommendation
|
|
|
|
2. **Bloc**: More structured approach with clear separation between events,
|
|
states, and business logic
|
|
- Better for complex apps
|
|
- Excellent testability
|
|
- Clear architectural patterns
|
|
|
|
3. **Riverpod**: Modern alternative to Provider with better performance and
|
|
developer experience
|
|
- Compile-time safety
|
|
- Better testing support
|
|
- More flexible than Provider
|
|
|
|
4. **GetX**: Full-featured solution with state management, routing, and
|
|
dependency injection
|
|
- Minimal boilerplate
|
|
- Fast and lightweight
|
|
- All-in-one solution
|
|
|
|
## Next Steps
|
|
|
|
The current codebase needs refactoring to implement proper state management
|
|
architecture to handle more complex state scenarios effectively. Provider
|
|
would be the easiest migration path while Bloc provides better long-term
|
|
scalability.
|
|
```
|
|
|
|
## When to Use This Pattern
|
|
|
|
This script pattern is ideal for various development scenarios where automated GitHub issue analysis can accelerate your workflow.
|
|
|
|
### Bug Investigation
|
|
|
|
Quickly analyze bug reports and identify root causes without manual code exploration:
|
|
|
|
```bash
|
|
./analyze-issue.sh https://github.com/project/repo/issues/123 \
|
|
"What is the root cause of this bug?"
|
|
```
|
|
|
|
### Feature Request Analysis
|
|
|
|
Understand context and implications of feature requests:
|
|
|
|
```bash
|
|
./analyze-issue.sh https://github.com/project/repo/issues/456 \
|
|
"What are the implementation challenges?"
|
|
```
|
|
|
|
### Security Audits
|
|
|
|
Assess security implications of reported issues:
|
|
|
|
```bash
|
|
./analyze-issue.sh https://github.com/project/repo/issues/789 \
|
|
"What are the security implications?"
|
|
```
|
|
|
|
### Documentation Generation
|
|
|
|
Generate detailed technical documentation from issues:
|
|
|
|
```bash
|
|
./analyze-issue.sh https://github.com/project/repo/issues/654 \
|
|
"Provide detailed technical documentation for this issue"
|
|
```
|
|
|
|
### Code Review Assistance
|
|
|
|
Get second opinions on proposed changes:
|
|
|
|
```bash
|
|
./analyze-issue.sh https://github.com/project/repo/issues/987 \
|
|
"Review the proposed solution approach"
|
|
```
|
|
|
|
## Conclusion
|
|
|
|
This sample demonstrates how to build an autonomous GitHub issue analysis tool using Cline CLI:
|
|
|
|
1. **Building autonomous CLI tools** using Cline's capabilities
|
|
2. **Parsing structured JSON output** from Cline CLI
|
|
3. **Creating flexible automation scripts** with custom prompting
|
|
4. **Integrating with GitHub** for issue analysis
|
|
5. **Handling command-line arguments** effectively
|
|
|
|
This pattern can be adapted for many other automation scenarios, from pull request reviews to documentation generation to code quality analysis.
|
|
|
|
## Related Resources
|
|
|
|
- [CLI Installation Guide](https://docs.cline.bot/getting-started/installing-cline)
|
|
- [CLI Reference Documentation](https://docs.cline.bot/cli/cli-reference)
|
|
- [Headless Mode](https://docs.cline.bot/usage/cli-overview#headless-mode)
|