-
Notifications
You must be signed in to change notification settings - Fork 6k
docs: add goose for vs code extension #6262
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,66 +1,73 @@ | ||
| --- | ||
| title: VS Code Extension | ||
| title: goose for VS Code Extension | ||
| sidebar_label: VS Code Extension | ||
| sidebar_position: 4 | ||
| unlisted: true | ||
| --- | ||
|
|
||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
| import IconGoose from "@site/src/components/icons/goose"; | ||
|
|
||
| :::warning | ||
| This is an experimental extension enables you to use goose within VS Code. It is not to be confused with the [VS Code MCP Server](/docs/mcp/vs-code-mcp). | ||
| The [goose for VS Code extension](https://marketplace.visualstudio.com/items?itemName=block.vscode-goose) lets you interact with goose directly within VS Code. | ||
|
|
||
| :::warning Experimental Feature | ||
| goose for VS Code is in active development. Behavior and configuration may change in future releases. | ||
| ::: | ||
|
|
||
| This tutorial covers how to install and use the [goose VS Code Extension](https://marketplace.visualstudio.com/items?itemName=block.vscode-goose) so you can use goose within VS Code. | ||
| The extension uses the [Agent Client Protocol (ACP)](/docs/guides/acp-clients) to communicate with goose. | ||
|
|
||
| :::info Prerequisite | ||
| - [VS Code](https://code.visualstudio.com/) version 1.95.0 or higher is required | ||
| - [goose Desktop](https://block.github.io/goose/) must be installed and **running** | ||
| ::: | ||
| ## Install the Extension | ||
|
|
||
| ## Configuration | ||
| :::info Prerequisites | ||
| - [VS Code](https://code.visualstudio.com/) version 1.95.0 or higher | ||
| - [goose CLI](/docs/getting-started/installation) version 1.16.0 or higher | ||
| ::: | ||
|
|
||
| <Tabs> | ||
| <TabItem value="desktop" label="goose Desktop"> | ||
| Use these steps to install the [goose for VS Code extension](https://marketplace.visualstudio.com/items?itemName=block.vscode-goose) in VS Code. | ||
|
|
||
| 1. Open VS Code | ||
| 2. Open the Extensions view in VS Code: | ||
| - Windows/Linux: `Ctrl+Shift+X` | ||
| 2. Open the Extensions marketplace in VS Code: | ||
| - macOS: `Cmd+Shift+X` | ||
| - Windows/Linux: `Ctrl+Shift+X` | ||
| - Or use: View → Extensions | ||
| 3. Search for `VS Code goose` | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. is there a link? i cant find the new one when i search. also anyone can make an extension so we want to be sure to point them to the right one
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The link is on line 24. Hmm, searching with "VS Code goose" worked for me and showed version 0.2.1 updated 2 days ago
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
| 4. Click Install on [VS Code goose](https://marketplace.visualstudio.com/items?itemName=block.vscode-goose) by Block | ||
| 4. On the `goose for VS Code` page, click the `Install` button | ||
| 5. Restart VS Code if prompted | ||
| 6. Open the goose: Chat side panel to start a new conversation or view conversation history | ||
| 6. Click the <IconGoose className="inline" size={16} /> icon in the Activity Bar to open the side panel and start chatting with goose | ||
|
|
||
| </TabItem> | ||
| <TabItem value="cli" label="goose CLI"> | ||
| ## Share Context with goose | ||
|
|
||
| Not available via CLI. | ||
| There are two ways to provide context to goose. | ||
|
|
||
| </TabItem> | ||
| </Tabs> | ||
| ### Send Selected Code | ||
|
|
||
| :::tip | ||
| You can ask goose about a particular file or code block by: | ||
| - Selecting the code you want to discuss | ||
| - Right-clicking and choosing "Ask goose about this code" | ||
| - The code will appear as a reference chip above the chat input | ||
| ::: | ||
| 1. Select the code you want to discuss in your editor | ||
| 2. Send the selection to goose: | ||
| - macOS: `Cmd+Shift+G` | ||
| - Windows/Linux: `Ctrl+Shift+G` | ||
| - Right-click and choose `Send to goose` | ||
|
|
||
| The selected code will appear as a context chip above the chat input. | ||
|
|
||
| ### Attach Files with @ Mentions | ||
|
|
||
| 1. Type `@` in the chat input and start typing the file name | ||
| 2. Select the file: | ||
| - Use the arrow keys (↑/↓) to select the file and press `Enter` | ||
| - Use your mouse to select the file | ||
|
|
||
| The attached file will appear as a context chip above the chat input. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| The goose VS Code Extension connects directly to your editor, letting you manage files, projects, and workflows with AI. It includes the following features: | ||
| The goose for VS Code extension connects directly to your editor, letting you manage files, projects, and workflows with AI. It includes the following features: | ||
|
|
||
| - Interactive chat UI | ||
| - Access to goose's AI capabilities directly within VS Code | ||
| - Unified session switching | ||
| - Code referencing with visual chips in the chat UI | ||
| - Quick actions for common coding tasks | ||
| - Interactive chat UI with streaming responses | ||
| - Access to goose's AI capabilities and enabled extensions | ||
| - Session management with history replay | ||
| - Context sharing and visual context chips in the chat UI | ||
| - Clipboard tools to copy code snippets/responses for easy sharing | ||
|
|
||
|
|
||
| ### goose Prompt | ||
|
|
||
| ``` | ||
|
|
@@ -88,4 +95,4 @@ I also included helpful information about the hot-reloading feature and the loca | |
|
|
||
| Is there anything else you'd like me to add or modify in the contributing guide? | ||
|
|
||
| ``` | ||
| ``` | ||

Uh oh!
There was an error while loading. Please reload this page.