diff --git a/docs/cody/capabilities/autocomplete.mdx b/docs/cody/capabilities/autocomplete.mdx index 884d52a99..b0451fcd5 100644 --- a/docs/cody/capabilities/autocomplete.mdx +++ b/docs/cody/capabilities/autocomplete.mdx @@ -19,7 +19,7 @@ The autocompletion model is designed to enhance speed, accuracy, and the overall First, you'll need the following setup: - A Free or Pro account via Sourcegraph.com or a Sourcegraph Enterprise instance -- A supported editor extension (VS Code, JetBrains) +- A supported editor extension (VS Code, JetBrains, Visual Studio, Eclipse) The autocomplete feature is enabled by default on all IDE extensions, i.e., VS Code and JetBrains. Generally, there's a checkbox in the extension settings that confirms whether the autocomplete feature is enabled or not. In addition, some autocomplete settings are optionally and explicitly supported by some IDEs. For example, JetBrains IDEs have settings that allow you to customize colors and styles of the autocomplete suggestions. diff --git a/docs/cody/capabilities/chat.mdx b/docs/cody/capabilities/chat.mdx index 50da4d15d..24d2a0e36 100644 --- a/docs/cody/capabilities/chat.mdx +++ b/docs/cody/capabilities/chat.mdx @@ -4,7 +4,7 @@ You can **chat** with Cody to ask questions about your code, generate code, and edit code. By default, Cody has the context of your open file and entire repository, and you can use `@` to add context for specific files, symbols, remote repositories, or other non-code artifacts. -You can do it from the **chat** panel of the supported editor extensions ([VS Code](/cody/clients/install-vscode), [JetBrains](/cody/clients/install-jetbrains), [Visual Studio](/cody/clients/install-visual-studio)) or in the [web](/cody/clients/cody-with-sourcegraph) app. +You can do it from the **chat** panel of the supported editor extensions ([VS Code](/cody/clients/install-vscode), [JetBrains](/cody/clients/install-jetbrains), [Visual Studio](/cody/clients/install-visual-studio), [Eclispe](/cody/clients/install-eclipse)) or in the [web](/cody/clients/cody-with-sourcegraph) app. ## Prerequisites diff --git a/docs/cody/clients/cody-with-sourcegraph.mdx b/docs/cody/clients/cody-with-sourcegraph.mdx index c43a56bf9..a769fd14b 100644 --- a/docs/cody/clients/cody-with-sourcegraph.mdx +++ b/docs/cody/clients/cody-with-sourcegraph.mdx @@ -2,7 +2,7 @@

Learn how to use Cody in the web interface with your Sourcegraph.com instance.

-In addition to the Cody extensions for [VS Code](/cody/clients/install-vscode), [JetBrains](/cody/clients/install-jetbrains) and [Visual Studio](/cody/clients/install-visual-studio ) IDEs, Cody is also available in the Sourcegraph web app. Community users can use Cody for free by logging into their accounts on Sourcegraph.com, and enterprise users can use Cody within their Sourcegraph instance. +In addition to the Cody extensions for [VS Code](/cody/clients/install-vscode), [JetBrains](/cody/clients/install-jetbrains), [Visual Studio](/cody/clients/install-visual-studio ), and [Eclispe](/cody/clients/install-eclipse) IDEs, Cody is also available in the Sourcegraph web app. Community users can use Cody for free by logging into their accounts on Sourcegraph.com, and enterprise users can use Cody within their Sourcegraph instance. diff --git a/docs/cody/clients/feature-reference.mdx b/docs/cody/clients/feature-reference.mdx index 1f58e5264..f4e373058 100644 --- a/docs/cody/clients/feature-reference.mdx +++ b/docs/cody/clients/feature-reference.mdx @@ -3,26 +3,27 @@

This document compares Cody's features and capabilities across different clients and platforms like VS Code, JetBrains, and Sourcegraph.com (Web UI).

## Chat -| **Feature** | **VS Code** | **JetBrains** | **Visual Studio** | **Web** | **CLI** | -| ---------------------------------------- | ----------- | ------------- | ----------------- | -------------------- | ------- | -| Chat with Cody | ✅ | ✅ | ✅ | ✅ | ✅ | -| Chat history | ✅ | ✅ | ✅ | ✅ | ❌ | -| Clear chat history | ✅ | ✅ | ✅ | ✅ | ❌ | -| Edit sent messages | ✅ | ✅ | ✅ | ✅ | ❌ | -| SmartApply/Execute | ✅ | ❌ | ❌ | ❌ | ❌ | -| Show context files | ✅ | ✅ | ✅ | ✅ | ❌ | -| @-file | ✅ | ✅ | ✅ | ✅ | ❌ | -| @-symbol | ✅ | ❌ | ✅ | ✅ | ❌ | -| Ollama support (experimental) | ✅ | ✅ | ✅ | ❌ | ❌ | -| LLM Selection | ✅ | ✅ | ✅ | ✅ | ❌ | -| **Context Selection** | | | | | | -| Single-repo context | ✅ | ✅ | ✅ | ✅ | ❌ | -| Multi-repo context | ❌ | ❌ | ❌ | ✅ (public code only) | ❌ | -| Local context | ✅ | ✅ | ✅ | ❌ | ✅ | -| OpenCtx context providers (experimental) | ✅ | ❌ | ❌ | ❌ | ❌ | -| **Prompts** | | | | | | -| Access to prompts and Prompt library | ✅ | ✅ | ✅ | ✅ | ❌ | -| Promoted Prompts | ✅ | ❌ | ❌ | ✅ | ❌ | + +| **Feature** | **VS Code** | **JetBrains** | **Visual Studio** | **Eclipse** | **Web** | **CLI** | +| ---------------------------------------- | ----------- | ------------- | ----------------- | ----------- | -------------------- | ------- | +| Chat with Cody | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | +| Chat history | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | +| Clear chat history | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | +| Edit sent messages | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | +| SmartApply/Execute | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | +| Show context files | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | +| @-file | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | +| @-symbol | ✅ | ❌ | ✅ | ✅ | ✅ | ❌ | +| Ollama support (experimental) | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | +| LLM Selection | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | +| **Context Selection** | | | | | | | +| Single-repo context | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | +| Multi-repo context | ❌ | ❌ | ❌ | ❌ | ✅ (public code only) | ❌ | +| Local context | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ | +| OpenCtx context providers (experimental) | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | +| **Prompts** | | | | | | | +| Access to prompts and Prompt library | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | +| Promoted Prompts | ✅ | ❌ | ❌ | ❌ | ✅ | ❌ | ## Code Autocomplete @@ -37,13 +38,13 @@ Few exceptions that apply to Cody Pro and Cody Enterprise users: -- Multi-repo context is not supported in VS Code, JetBrains, Visual Studio or the Web UI for Cody Pro +- Multi-repo context is not supported in VS Code, JetBrains, or the Web UI for Cody Pro -- Admin LLM selection is suported on VS Code, JetBrains, and Web both for chat and code autocomplete +- Admin LLM selection is suported on VS Code, JetBrains, Visual Studio, and Web both for chat and code autocomplete - Multi-repo context is supported on VS Code, JetBrains, Visual Studio, and Web - [Guardrails](/cody/clients/enable-cody-enterprise#guardrails) are supported on VS Code, JetBrains, and Web - [Repo-based Cody Context Filters](/cody/capabilities/ignore-context#cody-context-filters) are supported on all Cody clients. diff --git a/docs/cody/clients/index.mdx b/docs/cody/clients/index.mdx index 101b47052..a4d87a5ef 100644 --- a/docs/cody/clients/index.mdx +++ b/docs/cody/clients/index.mdx @@ -6,6 +6,7 @@ + diff --git a/docs/cody/clients/install-eclipse.mdx b/docs/cody/clients/install-eclipse.mdx new file mode 100644 index 000000000..c3883f9d7 --- /dev/null +++ b/docs/cody/clients/install-eclipse.mdx @@ -0,0 +1,76 @@ +# Installing Cody in Eclipse + +

Learn how to use Cody and its features with the Eclipse editor.

+ +Cody for Eclipse is currently in the Experimental stage. It is compatible with Eclipse version 2024-03 (4.31.0) and runs on Windows 11. At this time, it only supports chat functionality. + +Cody extension for Eclipse enhances your coding experience by providing intelligent and contextually aware answers to your questions. This guide will walk you through installing and setting Cody within your Eclipse editor. + + + + + +## Prerequisites + +- You have the correct version of [Eclipse](https://www.eclipse.org/downloads/packages/release/2024-03/r) IDE installed +- You have a Free or Pro account via Sourcegraph.com or a Sourcegraph Enterprise account + +## Install the Eclipse extension + +- Inside Eclipse, go to **Help > Install New Software** +- Next, add the site URL `https://sourcegraph.github.io/eclipse` +- After adding this URL, you should see the **Cody** category in the list of available plugins + +![add-eclispe-extension](https://storage.googleapis.com/sourcegraph-assets/Docs/add-eclipse-url-1124.png) + +- Click **Next** and follow the installation instructions +- After you have completed the installation and restarted Eclipse, you should see the **Cody** view in the **Window > Show View > Other** menu + +![eclipse-cody-view](https://storage.googleapis.com/sourcegraph-assets/Docs/eclipse-cody-view-1124.png) + +## Connect the extension to Sourcegraph + +Cody for Eclipse is available for all Cody plans, including Cody Free, Pro, and Enterprise. + +After a successful installation, open the **Cody** view. You should see a button to sign into your Sourcegraph account. + +![eclipse-cody-sign-in](https://storage.googleapis.com/sourcegraph-assets/Docs/eclispe-signin-sourcegraph-1124-2.png) + +Cody Free or Pro users can sign in to their Sourcegraph.com accounts. Meanwhile, Sourcegraph Enterprise users should connect Cody via their Enterprise instance URL and the Access Token. + +Complete these steps, and you'll be ready to use Cody chat in Eclipse. + +## Chat + +Cody in Eclipse allows you to ask questions about your code and get contextually aware answers. The chat window is available in a unified interface next to your code. All your previous and existing chats are stored for later use and can be accessed via the **History** icon from the top menu. You can download them to share or use later in a `.json` file or delete them. + +The chat input field has a default `@-mention` [context chips](#context-retrieval). These are automatically populated with the names of the files you have open in your editor. There is also a drop-down for [LLM selection](#llm-selection) and a button to run pre-built [prompts](#prompts). + +![cody-eclipse-chat](https://storage.googleapis.com/sourcegraph-assets/Docs/eclipse-cody-chat-1124.png) + +## LLM selection + +Cody offers a variety of large language models (LLMs) to power your chat experience. Cody Free users can access the latest base models from Anthropic, OpenAI, Google, and Mixtral. At the same time, Cody Pro and Enterprise users can access more extended models. + +Local models are also available through Ollama to Cody Free and Cody Pro users. To use a model in Cody chat, simply download it and run it in Ollama. + +You can read more about it in our [Supported LLM models docs](/cody/capabilities/supported-models). + +## Selecting Context with @-mentions + +Cody's chat allows you to [add files and symbols as context](/cody/core-concepts/context) in your messages. + +- Type `@-file` and then a filename to include a file as a context +- Type `@#` and then a symbol name to include the symbol's definition as context. Functions, methods, classes, types, etc., are all symbols + +### Context retrieval + +When you start a new Cody chat, the chat input window opens with a default `@-mention` context chips for all the context it intends to use. This context is based on your current repository and current file (or a file selection if you have code highlighted). + +At any point in time, you can edit these context chips or remove them completely if you do not want to use these as context. Any chat without a context chip will instruct Cody to use no codebase context. However, you can always provide an alternate `@-mention` file or symbols to let Cody use it as a new context source. + +When you have both a repository and files @-mentioned, Cody will search the repository for context while prioritizing the mentioned files. + +## Prompts + +Cody offers a variety of [pre-built prompts](/cody/capabilities/commands) to help you get the most out of your chat experience. You can access these prompts from the chat input field. diff --git a/docs/cody/index.mdx b/docs/cody/index.mdx index 6064d2802..7aa1a1840 100644 --- a/docs/cody/index.mdx +++ b/docs/cody/index.mdx @@ -6,7 +6,7 @@ Cody is an AI coding assistant that uses all the latest LLMs and your developmen -Cody connects seamlessly with codehosts like [GitHub](https://github.com/login?client_id=e917b2b7fa9040e1edd4), [GitLab](https://gitlab.com/users/sign_in) and IDEs like [VS Code](/cody/clients/install-vscode), [JetBrains](/cody/clients/install-jetbrains) and [Visual Studio](/cody/clients/install-visual-studio). Once connected, Cody acts as your personal AI coding assistant, equipped with the following capabilities: +Cody connects seamlessly with codehosts like [GitHub](https://github.com/login?client_id=e917b2b7fa9040e1edd4), [GitLab](https://gitlab.com/users/sign_in) and IDEs like [VS Code](/cody/clients/install-vscode), [JetBrains](/cody/clients/install-jetbrains), [Visual Studio](/cody/clients/install-visual-studio), and [Eclipse](/cody/clients/install-eclipse). Once connected, Cody acts as your personal AI coding assistant, equipped with the following capabilities: 1. Developer chat with the most powerful models and context 2. Code completions, code edits, and customizable prompts @@ -20,6 +20,7 @@ You can start using Cody with one of the following options: + diff --git a/docs/cody/troubleshooting.mdx b/docs/cody/troubleshooting.mdx index 679019134..5753f92f7 100644 --- a/docs/cody/troubleshooting.mdx +++ b/docs/cody/troubleshooting.mdx @@ -223,3 +223,27 @@ When sharing code with Cody, wrap your code in triple backticks (```) to ensure $filteredResults = preg_grep('*\.' . basename($inputPath) . '\.*', $fileList); ``` ```` + +## Eclipse extension + +### See a white screen the first time you open Cody chat + +This can happen if Eclipse prompts you to set up a password for secure storage and Cody timeouts while waiting. Simply close and re-open the Cody chat. + +### "No password provided" in the error log + +If you see this error in the error log, it happens because the default OS password integration has been corrupted. Go to **Preferences > General > Security > Secure Storage** and ensure your OS integration is checked. + +Then click **Clear Passwords** at the top, and then click **Change Password**. If you see a dialog saying **An error occurred while decrypting stored values... Do you want to cancel password change?** Click **No**. + +This will reset the secure storage master password for OS integration. You will be asked if you want to provide additional information for password recovery, which is optional. Click **Apply and Close** and then restart Eclipse. + +### General Tips + +You can open the Cody Log view using the same steps as above, but instead, select **Cody Log**. + +![cody-logs](https://storage.googleapis.com/sourcegraph-assets/Docs/eclipse-cody-log-1124.png) + +This will include more information about what Cody is doing, including any errors. There is a copy button at the top right of the log view that you can use to copy the log to your clipboard and send it to us. Be careful not to include any sensitive information, as the log communication is verbose and may contain tokens. + +Additionally, Eclipse's built-in Error Log can be used to view any uncaught exceptions and their stack traces. You can open the Error Log using the **Window > Show View > Error Log** menu. diff --git a/src/data/navigation.ts b/src/data/navigation.ts index 6defd654a..98fb720e0 100644 --- a/src/data/navigation.ts +++ b/src/data/navigation.ts @@ -37,6 +37,7 @@ export const navigation: NavigationItem[] = [ { title: "Cody for VS Code", href: "/cody/clients/install-vscode", }, { title: "Cody for JetBrains", href: "/cody/clients/install-jetbrains", }, { title: "Cody for Visual Studio", href: "/cody/clients/install-visual-studio", }, + { title: "Cody for Eclipse", href: "/cody/clients/install-eclipse", }, { title: "Cody for Web", href: "/cody/clients/cody-with-sourcegraph", }, ] },