opensource/cline
3
0
Fork 0
mirror of https://github.com/cline/cline.git synced 2026-09-24 23:20:16 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
v3.34.1
cline/docs/getting-started/installing-cline.mdx
T
Juan Pablo FloresandCopilot 8f8c4561a6 Docs upgrade (#6907) 
* style(docs): update background color scheme to neutral tones

Update documentation background colors from purple-tinted theme to neutral gray tones. Changed light mode from lavender (#F0E6FF) to off-white (#fafaf9) and dark mode from pure black (#000000) to dark gray (#0f0f0f) for improved visual consistency.

* refactor(docs): remove gradient decoration from theme config

Remove the "decoration": "gradient" property from the documentation
theme configuration. This simplifies the theme settings by removing
the gradient decoration option from the color configuration object.

* docs: change documentation font family to Geist Mono

Replace Roboto with Geist Mono as the default font family in the documentation configuration. This updates the visual styling of the documentation to use a monospace font, which may improve readability for code-heavy content.

* docs: update branding and restructure navigation

- Replace robot panel logos with new Cline brand logos
- Add icons to navbar links (Docs, GitHub, Discord)
- Restructure navigation from groups to tabs format
- Add icons to navigation items for improved UX
- Include new Docs link in navbar with book icon

This update modernizes the documentation appearance and improves navigation hierarchy for better user experience.

* docs: restructure navigation with hierarchical groups and pages

Restructured documentation navigation from flat menu to organized groups:
- Removed redundant "Docs" link from navbar
- Migrated from "menu" to "groups/pages" structure
- Added comprehensive page organization with nested groups:
  * Introduction, Getting Started, Features
  * Prompting Skills, Cline's Tools, Enterprise Solutions
  * MCP Servers, Provider Configuration
- Organized features into logical subgroups (@ Mentions, Commands,
  Customization, Slash Commands)
- Improved documentation discoverability and hierarchy

This change provides better content organization and easier navigation
for users exploring different aspects of Cline documentation.

* docs: remove contextual options from documentation config

Remove the contextual configuration section containing the "copy" option from docs.json. This simplifies the documentation configuration by removing unused contextual menu options.

* docs(multiroot): improve workspace documentation with limitations and technical details

- Add important note about experimental limitations affecting Cline rules and checkpoints
- Add "How it works" section explaining automatic workspace detection and tracking
- Reorganize technical behavior section with detailed subsections for workspace detection, path resolution, and command execution
- Document workspace hint syntax for explicit file references (@workspaceName:path)
- Standardize heading capitalization to sentence case for consistency
- Improve overall content organization and clarity for better user understanding

This update provides users with clearer information about the multiroot feature's current state, its limitations, and how to effectively use workspace hints when working with multiple project folders.

* docs: restructure overview page with enhanced visual layout

- Convert plain markdown sections to CardGroup and Card components with icons
- Add tabbed interface for Plan & Act Mode explanation
- Update description from "development assistant" to "coding agent"
- Reorganize content for improved readability and visual hierarchy
- Enhance feature presentations with icon-based cards

Improves user experience by transforming the overview documentation into a more visually appealing and scannable format using modern documentation components.

* docs: improve installation guide with enhanced structure and UX

Restructure the Cline installation documentation to improve readability and user experience:

- Add prominent note highlighting 2-minute installation time
- Convert prerequisites into visual card components for better clarity
- Transform installation steps into structured Step components for easier following
- Add manual installation instructions for JetBrains IDEs
- Include feature compatibility accordion for JetBrains users
- Enhance visual hierarchy with improved component usage (CardGroup, Steps, Accordion)
- Simplify language and improve descriptions throughout

This makes the installation process clearer for new users and reduces friction during onboarding.

* style(docs): remove text opacity reduction for better readability

* docs: refactor model selection guide with visual step-by-step instructions

- Replace tab-based layout with linear step-by-step flow
- Add screenshots for each configuration step (config, provider, API, model)
- Reorganize content structure for improved clarity and user experience
- Add quickstart options and streamlined provider recommendations
- Improve navigation with visual aids to help users configure Cline faster

* docs: add installation screenshots and context management guide

* docs: flatten provider config structure in documentation

Remove the "Alternative Providers" grouping and move all provider configuration pages (OpenRouter, Cerebras, DeepSeek, Groq, xAI Grok, Mistral AI, Doubao, Fireworks, and ZAI) to the main provider configuration list. This simplifies the documentation navigation by treating all providers equally rather than categorizing some as alternatives.

* docs: restructure context management docs and improve content clarity

**Changes:**
- Reorganized documentation structure by moving context management from
  `/best-practices` to `/prompting` section for better categorization
- Added URL redirect to maintain backward compatibility for old links
- Updated navigation references in welcome page to point to new location
- Improved readability of context management explanations with more
  narrative, conversational prose
- Enhanced context window documentation by adding cache tokens indicator
  and using emoji-based formatting for better visual clarity
- Streamlined Cline Memory Bank setup instructions from 4 to 3 steps
- Updated context bar screenshot to use newer image asset

**Why:**
Better documentation organization and improved user experience through
clearer explanations of how Cline builds and manages context during tasks.

* docs(context-management): convert Quick Reference to Info component

Replace blockquote formatting with Info component for the Quick Reference
section in the context management documentation. This improves visual
presentation and maintains consistency with documentation standards.

Also removes trailing whitespace at the end of the file for cleaner
formatting.

* docs: add Cline Enterprise overview and restructure enterprise section

- Add comprehensive enterprise overview documentation covering security,
  governance, observability, and developer experience features
- Rename "Enterprise & Security" navigation group to "Enterprise"
- Consolidate enterprise documentation by replacing 4 pages with 2:
  new overview page and security concerns
- Document BYOI (Bring Your Own Inference), SSO authentication, and
  role-based access control capabilities

This restructuring provides a clearer entry point for enterprise users
and consolidates previously scattered enterprise information into a
cohesive overview document.

* docs(enterprise): streamline enterprise overview and update font

- Change documentation font from Geist Mono to Geist Sans
- Add enterprise website link card for detailed information
- Remove Developer Experience, Proven at Scale, and Pricing sections
- Consolidate Flexible Inference section content
- Simplify enterprise overview to focus on core capabilities

These changes reduce redundancy by directing users to the enterprise
website for pricing and detailed features while keeping the docs
focused on technical implementation and core capabilities.

* clean-images

* Update docs/getting-started/installing-cline.mdx

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update docs/styles.css

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* docs(cline-cli): add platform availability warning to overview

Add a prominent warning callout indicating that Cline CLI is currently in preview and only supports macOS and Linux, with Windows support coming soon. This sets clear expectations for users about platform compatibility.

Also remove redundant introductory text in the "What you can build with this" section to improve content clarity.

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-10-16 11:51:20 -07:00

410 lines
14 KiB
Plaintext
Raw Permalink Blame History

---
title: "Installing Cline"
description: "Get Cline up and running in your favorite IDE with these simple installation steps"
---
<Note>
**Ready to get started?** Installation takes less than 2 minutes! Choose your editor below and follow the simple steps.
</Note>
## Before You Begin
<CardGroup cols={1}>
<Card title="Create Your Account" icon="user-plus" href="https://app.cline.bot/signup">
Sign up for a **free Cline account** to get:
- Access to multiple AI models including stealth models
- Seamless setup without managing API keys
- Occasional free inferencing through partner providers
</Card>
<Card title="Have a Compatible Editor" icon="code">
Cline works with:
- **VS Code** / **Cursor**
- **JetBrains IDEs** (IntelliJ, PyCharm, WebStorm, etc.)
- **VSCodium** / **Windsurf**
Install one before proceeding.
</Card>
</CardGroup>
## Installation Instructions
<Tabs>
<Tab title="VS Code/Cursor" icon="code">
<Frame>
<img
src="https://storage.googleapis.com/cline_public_images/vscode.png"
alt="VS Code logo"
style={{ width: "100px", height: "auto", display: "block" }}
/>
</Frame>
<Steps>
<Step title="Open Extensions">
Launch VS Code and open the Extensions view:
- Press `Ctrl/Cmd + Shift + X`, or
- Click the Extensions icon in the Activity Bar
</Step>
<Step title="Search for Cline">
Type **"Cline"** in the Extensions marketplace search bar
<Frame>
<img src="https://storage.googleapis.com/cline_public_images/extension-installation.png" alt="VS Code marketplace showing Cline extension"
/>
</Frame>
</Step>
<Step title="Install">
Click the **Install** button 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>
</Step>
<Step title="Access Cline">
After installation completes:
- Click the **Cline icon** in the Activity Bar, or
- Open Command Palette (`Ctrl/Cmd + Shift + P`) → type **"Cline: Open In New Tab"**
<Frame caption="Cline opened in VSCode">
<img
src="https://storage.googleapis.com/cline_public_images/after-installation.png"
alt="Cline opened in VSCode"
/>
</Frame>
<Warning>
If VS Code shows "Running extensions might..." dialog, click **Allow**. If you don't see the Cline icon, restart VS Code.
</Warning>
</Step>
</Steps>
<Check>
**Installation Complete!** You should now see the Cline interface in your editor. Time to sign in!
</Check>
<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" }}
/>
<Note>
Cline for JetBrains works almost identically to VS Code, with all core features: diff editing, tools, multiple API providers, MCP servers, Cline rules/workflows, and more.
</Note>
### Choose Your Installation Method
<Tabs>
<Tab title="From IDE (Recommended)">
<Steps>
<Step title="Open Settings">
In your JetBrains IDE, go to **Settings**:
- Windows/Linux: `Ctrl+Alt+S`
- macOS: `Cmd+,`
</Step>
<Step title="Navigate to Plugins">
Go to **Plugins** → **Marketplace** tab
</Step>
<Step title="Install Cline">
Search for **"Cline"** and click **Install**
<Frame>
<img
src="https://storage.googleapis.com/cline_public_images/jetbrains-installation.png"
alt="JetBrains marketplace showing Cline plugin search results"
/>
</Frame>
</Step>
<Step title="Restart IDE">
Restart your IDE to complete the installation
<Frame>
<img
src="https://storage.googleapis.com/cline_public_images/jetbrains-post-installation.png"
alt="JetBrains marketplace showing Cline plugin search results"
/>
</Frame>
</Step>
</Steps>
</Tab>
<Tab title="Browser Install">
<Steps>
<Step title="Visit Marketplace">
Go to the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/28247-cline)
</Step>
<Step title="Click Install to IDE">
Click the **Install to IDE** button
</Step>
<Step title="Confirm in IDE">
Your IDE will open and prompt you to confirm the installation
</Step>
<Step title="Restart IDE">
Restart to complete the installation
</Step>
</Steps>
</Tab>
<Tab title="Manual Install">
<Steps>
<Step title="Download Plugin">
Download from the [marketplace page](https://plugins.jetbrains.com/plugin/28247-cline)
</Step>
<Step title="Open Settings">
Go to **Settings** → **Plugins**
</Step>
<Step title="Install from Disk">
Click the gear icon → **Install Plugin from Disk**
</Step>
<Step title="Select File & Restart">
Select the downloaded `.zip` file and restart your IDE
</Step>
</Steps>
</Tab>
</Tabs>
<Check>
**Installation Complete!** Find Cline in **View** → **Tool Windows** → **Cline** (usually on the right side).
</Check>
### What Works in JetBrains
<AccordionGroup>
<Accordion title="✅ All Core Features" defaultOpen>
- 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
</Accordion>
<Accordion title="📋 Terminal Integration Difference">
**JetBrains shows terminal output differently than VS Code:**
- VS Code: Output streams directly to chat
- JetBrains: Output appears in collapsible "Command Output" sections
Commands execute successfully in both—just expand the section to see results in JetBrains.
</Accordion>
</AccordionGroup>
<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">
<Note>
These editors use the **Open VSX Registry** instead of the VS Code Marketplace, but the installation process is nearly identical.
</Note>
<Steps>
<Step title="Open Extensions">
Launch your editor (VSCodium, Windsurf, etc.) and open Extensions view:
- Press `Ctrl/Cmd + Shift + X`
</Step>
<Step title="Search for Cline">
Type **"Cline"** in the marketplace search bar
</Step>
<Step title="Install by Author">
Select **"Cline" by saoudrizwan** and click **Install**
</Step>
<Step title="Reload if Needed">
Reload your editor if prompted to complete installation
</Step>
</Steps>
<Check>
**Installation Complete!** Look for the Cline icon in your Activity Bar or use the Command Palette.
</Check>
<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>
## Next Steps: Sign In & Start Building
<Steps>
<Step title="Open Cline">
Find and open Cline in your editor:
- **VS Code/Cursor/VSCodium/Windsurf:** Click the Cline icon in the Activity Bar
- **JetBrains:** Go to **View** → **Tool Windows** → **Cline**
</Step>
<Step title="Sign In">
Click the **Sign Up** button in the Cline interface
<Info>
You'll be redirected to [app.cline.bot](https://app.cline.bot) to authenticate. After signing in, you'll automatically return to your editor.
</Info>
<Frame>
<img src="/assets/installation/login.png" alt="Cline sign up screen"
/>
</Frame>
</Step>
<Step title="You're All Set!">
<Check>
**Congratulations!** You're all set to start using Cline!
Cline is now ready to help you build projects.
</Check>
</Step>
</Steps>
## Tips for Success
<CardGroup cols={2}>
<Card title="Ask Questions" icon="circle-question">
Don't know something? Ask in Plan Mode! Cline can explain concepts, debug errors, and guide you through tasks.
</Card>
<Card title="Use Screenshots" icon="image">
Some models understand screenshots of what you're working on or errors you encounter.
</Card>
<Card title="Share Error Messages" icon="triangle-exclamation">
Use @problems to share error messages for quick solutions and debugging help.
</Card>
<Card title="Speak Naturally" icon="comments">
Use your own words—no need for technical jargon. Cline will translate your ideas into code.
</Card>
</CardGroup>
## Need Help?
<CardGroup cols={2}>
<Card title="Join Our Discord" icon="discord" href="https://discord.gg/cline">
Connect with our team and community for support, tips, and discussions.
</Card>
<Card title="Read the Docs" icon="book-open" href="/getting-started/for-new-coders">
Explore guides for new coders, model selection, and advanced features.
</Card>
</CardGroup>
Reference in New Issue View Git Blame Copy Permalink