mirror of
https://github.com/cline/cline.git
synced 2026-09-24 23:20:16 +08:00
* docs: update what-is-cline to use generic IDE references Updated documentation to replace VS Code-specific references with generic "IDE" terms, making it applicable to modern IDEs beyond VS Code for broader compatibility. * docs: expand Cline installation guide with comprehensive setup instructions - Add prerequisites section with account creation and editor compatibility - Include detailed installation steps for VS Code/Cursor and JetBrains IDEs - Add troubleshooting sections for common installation issues - Expand editor support information and setup guidance - Improve documentation structure with tabs and accordions for better UX * docs: remove font weight and reorder getting started pages - Remove font weight property from fonts configuration - Reorder getting started pages to place installation before model selection guide * fixes title font-weight to original values * docs: improve JetBrains plugin installation link text Replace generic URL text with descriptive "JetBrains Marketplace" link text for better user experience and accessibility in the Cline installation guide. * docs: add voice mode feature documentation and cross-references Add comprehensive documentation for Voice Mode feature including setup instructions, use cases, and technical requirements. Also add cross-reference tip in plan-and-act.mdx to promote voice mode usage during planning discussions. * docs: rename voice-mode to dictation for clarity Rename voice-mode.mdx to dictation.mdx and update all references throughout the documentation to use "Dictation" instead of "Voice Mode" for more accurate terminology and better user understanding. * feat(docs): add YOLO mode documentation Add comprehensive documentation for YOLO mode feature, covering auto-approval functionality, safety warnings, use cases, and best practices for autonomous operation. * docs: reorganize navigation structure and add redirect for JetBrains install page - Remove JetBrains installation page from getting-started section - Reorder Features section with @ Mentions first, followed by alphabetically sorted individual features - Move Slash Commands group after individual features and add workflows page - Add yolo-mode feature to the end - Add redirect from old JetBrains install path to main installation guide * docs: improve JetBrains logo visibility and simplify dictation instructions - Remove Frame wrapper around JetBrains logo for cleaner markup - Add CSS styling to ensure JetBrains logo visibility in dark mode with background, border, and hover effects - Simplify dictation instructions by removing redundant recording state description
273 lines
10 KiB
Plaintext
273 lines
10 KiB
Plaintext
---
|
||
title: "Installing Cline"
|
||
description: "Get Cline set up in your editor and start building projects with AI assistance."
|
||
---
|
||
|
||
## Prerequisites
|
||
|
||
Before installing Cline, make sure you have the following:
|
||
|
||
### Create a Cline Account
|
||
|
||
Create a Cline account for the best experience. Creating a Cline account is completely free and you can [sign up here](https://app.cline.bot/signup). A Cline account provides:
|
||
- Access to multiple AI models including stealth models
|
||
- Seamless setup without needing to manage API keys
|
||
- At times, we partner with model providers to offer inferencing at no cost through your Cline account
|
||
|
||
### Compatible Editor
|
||
|
||
Cline works with the following IDEs:
|
||
- **VS Code** - Microsoft's popular code editor
|
||
- **Cursor** - AI-powered code editor based on VS Code
|
||
- **JetBrains IDEs** - IntelliJ IDEA, PyCharm, WebStorm, DataSpell, PhpStorm, and other JetBrains products
|
||
- **VSCodium** - Open-source version of VS Code
|
||
- **Windsurf** - VS Code-compatible editor
|
||
|
||
Make sure you have one of these editors installed before proceeding with the Cline installation.
|
||
|
||
## Choose Your Editor
|
||
|
||
Cline works across multiple IDEs. Select your preferred editor below for installation instructions:
|
||
|
||
<Tabs>
|
||
<Tab title="VS Code/Cursor" icon="code">
|
||
### Installation Steps
|
||
|
||
1. **Open VS Code** and navigate to the Extensions view (`Ctrl/Cmd + Shift + X`)
|
||
2. **Search for "Cline"** in the Extensions marketplace
|
||
3. **Click Install** on the Cline extension
|
||
|
||
<Frame caption="VS Code marketplace with Cline extension ready to install">
|
||
<img
|
||
src="https://storage.googleapis.com/cline_public_images/docs/assets/image%20(20).png"
|
||
alt="VS Code marketplace showing Cline extension"
|
||
/>
|
||
</Frame>
|
||
|
||
4. **Access Cline** after installation:
|
||
- Click the Cline icon in the Activity Bar, or
|
||
- Use Command Palette (`Ctrl/Cmd + Shift + P`) → "Cline: Open In New Tab"
|
||
|
||
> **Note:** If VS Code shows "Running extensions might..." dialog, click "Allow". If you don't see the Cline icon, restart VS Code.
|
||
|
||
<Accordion title="Troubleshooting">
|
||
|
||
**Plugin Installation Issues**
|
||
|
||
If you can't find Cline in the marketplace:
|
||
- Make sure you're searching in the **Marketplace** tab (not Installed)
|
||
- Try searching for "Cline AI" or just "Cline"
|
||
- Check that your VS Code version is compatible
|
||
|
||
If installation fails:
|
||
- Restart your VS Code and try again
|
||
- Check your internet connection
|
||
- Try installing from VSIX file as an alternative
|
||
|
||
**Plugin Not Appearing**
|
||
|
||
If you don't see the Cline tool window after installation:
|
||
- Restart VS Code completely (File → Exit and reopen)
|
||
- Check **View** → **Command Palette** → "Cline: Open In New Tab"
|
||
- Verify the plugin is enabled in **Extensions** view
|
||
- Look for the Cline icon in your Activity Bar (usually on the left side)
|
||
|
||
**Common Issues**
|
||
|
||
Plugin appears to be installed but doesn't work:
|
||
- Ensure you've restarted VS Code after installation
|
||
- Check if there are any error messages in the Developer Console
|
||
- Try disabling and re-enabling the extension
|
||
|
||
Performance or compatibility issues:
|
||
- Make sure you're using a supported VS Code version
|
||
- Check for VS Code updates that might improve compatibility
|
||
- Consider closing other resource-intensive extensions if needed
|
||
|
||
Need help? Join our [Discord community](https://discord.gg/cline).
|
||
|
||
</Accordion>
|
||
</Tab>
|
||
|
||
<Tab title="JetBrains IDEs" icon="brain">
|
||
<img
|
||
src="https://storage.googleapis.com/cline_public_images/docs/assets/jetbrains-logo.svg"
|
||
alt="JetBrains logo"
|
||
style={{ width: "200px", height: "auto", margin: "0 auto 20px auto", display: "block" }}
|
||
/>
|
||
|
||
Cline for JetBrains works almost identically to Cline in VSCode. All the core features work properly: diff editing, using tools, logging in with different providers, MCP servers, Cline rules and workflows, and more.
|
||
|
||
|
||
### Installation Steps
|
||
|
||
**Method 1: From IDE (Recommended)**
|
||
1. Open your JetBrains IDE
|
||
2. Go to **Settings** (`Ctrl+Alt+S` on Windows/Linux, `Cmd+,` on macOS)
|
||
3. Navigate to **Plugins** → **Marketplace**
|
||
4. Search for "Cline" and click **Install**
|
||
5. Restart your IDE
|
||
|
||
<Frame>
|
||
<img
|
||
src="https://storage.googleapis.com/cline_public_images/docs/assets/cline-jetbrains-marketplace-search.png"
|
||
alt="JetBrains marketplace showing Cline plugin search results"
|
||
/>
|
||
</Frame>
|
||
|
||
**Method 2: Browser Install**
|
||
|
||
Visit the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/28247-cline) and click **Install to IDE**.
|
||
|
||
<Accordion title="Method 3: Manual Installation">
|
||
|
||
1. Download the plugin from the [marketplace page](https://plugins.jetbrains.com/plugin/28247-cline)
|
||
2. Go to **Settings** → **Plugins**
|
||
3. Click the gear icon → **Install Plugin from Disk**
|
||
4. Select the downloaded `.zip` file
|
||
5. Restart your IDE
|
||
|
||
</Accordion>
|
||
|
||
### Using the Plugin
|
||
|
||
After installation, you’ll find Cline in your IDE. Look for the Cline tool window (usually on the right side) or go to View → Tool Windows → Cline.
|
||
|
||
### Key Features
|
||
|
||
Cline for JetBrains includes all core features:
|
||
- Diff editing and file modifications
|
||
- Multiple API providers (Anthropic, OpenAI, local models)
|
||
- MCP servers and custom tools
|
||
- Cline rules and workflows
|
||
- @ mentions for files, folders, and problems
|
||
- Drag & drop support
|
||
|
||
> **Note:** Terminal output appears in collapsible sections rather than streaming directly to chat.
|
||
|
||
### Key Differences from VSCode
|
||
The terminal integration works differently in JetBrains. Unlike VSCode where terminal output streams directly to the chat, JetBrains shows command output in a collapsible section. Commands still execute successfully - you just need to expand the Command Output section to see results.
|
||
|
||
<Accordion title="Troubleshooting">
|
||
|
||
**Plugin Installation Issues**
|
||
|
||
If you can't find Cline in the marketplace:
|
||
- Make sure you're searching in the **Marketplace** tab (not Installed)
|
||
- Try searching for "Cline AI" or just "Cline"
|
||
- Check that your IDE version is compatible (2023.1 or later recommended)
|
||
|
||
If installation fails:
|
||
- Restart your IDE and try again
|
||
- Check your internet connection
|
||
- Try installing from disk as an alternative
|
||
|
||
**Plugin Not Appearing**
|
||
|
||
If you don't see the Cline tool window after installation:
|
||
- Restart your IDE completely (File → Exit and reopen)
|
||
- Check **View** → **Tool Windows** → **Cline**
|
||
- Verify the plugin is enabled in **Settings** → **Plugins** → **Installed** tab
|
||
- Look for the Cline icon in your IDE's tool window bar (usually on the right side)
|
||
|
||
**Common Issues**
|
||
|
||
Plugin appears to be installed but doesn't work:
|
||
- Ensure you've restarted your IDE after installation
|
||
- Check if there are any error messages in the IDE's event log
|
||
- Try disabling and re-enabling the plugin in Settings
|
||
|
||
Performance or compatibility issues:
|
||
- Make sure you're using a supported JetBrains IDE version
|
||
- Check for IDE updates that might improve compatibility
|
||
- Consider allocating more memory to your IDE if needed
|
||
|
||
Need help? Join our [Discord community](https://discord.gg/cline).
|
||
|
||
</Accordion>
|
||
</Tab>
|
||
|
||
<Tab title="VSCodium/Windsurf" icon="terminal">
|
||
### Installation Steps
|
||
|
||
For VS Code-compatible editors using Open VSX Registry:
|
||
|
||
1. **Open your editor** (VSCodium, Windsurf, etc.)
|
||
2. **Navigate to Extensions view** (`Ctrl/Cmd + Shift + X`)
|
||
3. **Search for "Cline"** in the marketplace
|
||
4. **Select "Cline" by saoudrizwan** and click **Install**
|
||
5. **Reload** if prompted
|
||
|
||
> **Note:** These editors use the Open VSX Registry instead of the VS Code Marketplace.
|
||
|
||
<Accordion title="Troubleshooting">
|
||
|
||
**Plugin Installation Issues**
|
||
|
||
If you can't find Cline in the marketplace:
|
||
- Make sure you're searching in the **Marketplace** tab (not Installed)
|
||
- Try searching for "Cline AI" or just "Cline"
|
||
- Check that your editor version is compatible
|
||
|
||
If installation fails:
|
||
- Restart your editor and try again
|
||
- Check your internet connection
|
||
- Try installing from disk as an alternative
|
||
|
||
**Plugin Not Appearing**
|
||
|
||
If you don't see the Cline tool window after installation:
|
||
- Restart your editor completely (File → Exit and reopen)
|
||
- Check **View** → **Command Palette** → "Cline: Open In New Tab"
|
||
- Verify the plugin is enabled in **Extensions** view
|
||
- Look for the Cline icon in your Activity Bar (usually on the left side)
|
||
|
||
**Common Issues**
|
||
|
||
Plugin appears to be installed but doesn't work:
|
||
- Ensure you've restarted your editor after installation
|
||
- Check if there are any error messages in the Developer Console
|
||
- Try disabling and re-enabling the extension
|
||
|
||
Performance or compatibility issues:
|
||
- Make sure you're using a supported editor version
|
||
- Check for editor updates that might improve compatibility
|
||
- Consider closing other resource-intensive extensions if needed
|
||
|
||
Need help? Join our [Discord community](https://discord.gg/cline).
|
||
|
||
</Accordion>
|
||
</Tab>
|
||
</Tabs>
|
||
|
||
### Sign In to Your Cline Account
|
||
|
||
Now that you have Cline installed, sign in to access your account:
|
||
|
||
1. **Open Cline** in your editor (click the Cline icon in the Activity Bar or Tool Windows)
|
||
2. **Click "Sign In"** - you'll see this button in the Cline interface
|
||
3. **Complete authentication** - you'll be redirected to [app.cline.bot](https://app.cline.bot) to sign in
|
||
4. **Return to your editor** - once signed in, you'll be automatically redirected back
|
||
|
||
|
||
### Your First Interaction with Cline
|
||
|
||
You're ready to start building! Copy and paste this prompt into the Cline chat window:
|
||
|
||
```
|
||
Hey Cline! Could you help me create a new project folder called "hello-world" in my Cline directory and make a simple webpage that says "Hello World" in big blue text?
|
||
```
|
||
|
||
> **Pro Tip:** Cline will help you create the project folder and set up your first webpage!
|
||
|
||
### Tips for Working with Cline
|
||
|
||
- **Ask Questions:** If you're unsure about something, ask Cline!
|
||
- **Use Screenshots:** Cline can understand images — show him what you're working on.
|
||
- **Copy and Paste Errors:** Share error messages in the chat for solutions.
|
||
- **Speak Plainly:** Use your own words — Cline will translate them into code.
|
||
|
||
### Still Struggling?
|
||
|
||
Join our [Discord community](https://discord.gg/cline) and engage with our team and other Cline users directly.
|