docs: add goose for vs code extension (#6262)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
@@ -29,6 +29,11 @@ The list of experimental features may change as goose development progresses. So
|
|||||||
description="Enable remote access to goose Desktop from the goose AI mobile app via secure tunneling."
|
description="Enable remote access to goose Desktop from the goose AI mobile app via secure tunneling."
|
||||||
link="/docs/experimental/mobile-access"
|
link="/docs/experimental/mobile-access"
|
||||||
/>
|
/>
|
||||||
|
<Card
|
||||||
|
title="goose for VS Code Extension"
|
||||||
|
description="Interact with goose directly from VS Code via ACP."
|
||||||
|
link="/docs/experimental/vs-code-extension"
|
||||||
|
/>
|
||||||
<Card
|
<Card
|
||||||
title="Using goose in ACP Clients"
|
title="Using goose in ACP Clients"
|
||||||
description="Interact with goose natively in ACP-compatible clients like Zed."
|
description="Interact with goose natively in ACP-compatible clients like Zed."
|
||||||
|
|||||||
@@ -4,7 +4,13 @@ sidebar_position: 2
|
|||||||
sidebar_label: Ollama Tool Shim
|
sidebar_label: Ollama Tool Shim
|
||||||
---
|
---
|
||||||
|
|
||||||
The Ollama tool shim is an experimental feature that enables tool calling capabilities for language models that don't natively support tool calling (like DeepSeek). It works by instructing the primary model to output json for intended tool usage, the interpretive model uses ollama structured outputs to translate the primary model's message into valid json, and then that json is translated into valid tool calls to be invoked.
|
The Ollama tool shim enables tool calling capabilities for language models that don't natively support tool calling (like DeepSeek).
|
||||||
|
|
||||||
|
:::warning Experimental Feature
|
||||||
|
Ollama tool shim is an experimental feature. Behavior and configuration may change in future releases.
|
||||||
|
:::
|
||||||
|
|
||||||
|
The tool shim works by instructing the primary model to output json for intended tool usage, the interpretive model uses ollama structured outputs to translate the primary model's message into valid json, and then that json is translated into valid tool calls to be invoked.
|
||||||
|
|
||||||
|
|
||||||
#### How to use the Ollama Tool Shim
|
#### How to use the Ollama Tool Shim
|
||||||
|
|||||||
@@ -1,66 +1,65 @@
|
|||||||
---
|
---
|
||||||
title: VS Code Extension
|
title: goose for VS Code Extension
|
||||||
sidebar_label: VS Code Extension
|
sidebar_label: VS Code Extension
|
||||||
sidebar_position: 4
|
sidebar_position: 4
|
||||||
unlisted: true
|
|
||||||
---
|
---
|
||||||
|
|
||||||
import Tabs from '@theme/Tabs';
|
import IconGoose from "@site/src/components/icons/goose";
|
||||||
import TabItem from '@theme/TabItem';
|
|
||||||
|
|
||||||
:::warning
|
The [goose for VS Code extension](https://marketplace.visualstudio.com/items?itemName=block.vscode-goose) lets you interact with goose directly within VS Code.
|
||||||
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).
|
|
||||||
|
:::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
|
## Install the Extension
|
||||||
- [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**
|
:::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
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Configuration
|
1. Go to [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=block.vscode-goose)
|
||||||
|
2. Click `Install`
|
||||||
|
3. On the popup window, click `Open Visual Studio Code`
|
||||||
|
4. In Visual Studio Code, click `Install`
|
||||||
|
5. Click the <IconGoose className="inline" size={16} /> icon in the Activity Bar to open the side panel and start chatting with goose
|
||||||
|
|
||||||
<Tabs>
|
## Share Context with goose
|
||||||
<TabItem value="desktop" label="goose Desktop">
|
|
||||||
|
|
||||||
1. Open VS Code
|
There are two ways to provide context to goose.
|
||||||
2. Open the Extensions view in VS Code:
|
|
||||||
- Windows/Linux: `Ctrl+Shift+X`
|
|
||||||
- macOS: `Cmd+Shift+X`
|
|
||||||
- Or use: View → Extensions
|
|
||||||
3. Search for `VS Code goose`
|
|
||||||
4. Click Install on [VS Code goose](https://marketplace.visualstudio.com/items?itemName=block.vscode-goose) by Block
|
|
||||||
5. Restart VS Code if prompted
|
|
||||||
6. Open the goose: Chat side panel to start a new conversation or view conversation history
|
|
||||||
|
|
||||||
</TabItem>
|
### Send Selected Code
|
||||||
<TabItem value="cli" label="goose CLI">
|
|
||||||
|
|
||||||
Not available via CLI.
|
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`
|
||||||
|
|
||||||
</TabItem>
|
The selected code will appear as a context chip above the chat input.
|
||||||
</Tabs>
|
|
||||||
|
|
||||||
:::tip
|
### Attach Files with @ Mentions
|
||||||
You can ask goose about a particular file or code block by:
|
|
||||||
- Selecting the code you want to discuss
|
1. Type `@` in the chat input and start typing the file name
|
||||||
- Right-clicking and choosing "Ask goose about this code"
|
2. Select the file:
|
||||||
- The code will appear as a reference chip above the chat input
|
- 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
|
## 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
|
- Interactive chat UI with streaming responses
|
||||||
- Access to goose's AI capabilities directly within VS Code
|
- Access to goose's AI capabilities and enabled extensions
|
||||||
- Unified session switching
|
- Session management with history replay
|
||||||
- Code referencing with visual chips in the chat UI
|
- Context sharing and visual context chips in the chat UI
|
||||||
- Quick actions for common coding tasks
|
|
||||||
- Clipboard tools to copy code snippets/responses for easy sharing
|
- Clipboard tools to copy code snippets/responses for easy sharing
|
||||||
|
|
||||||
|
|
||||||
### goose Prompt
|
### goose Prompt
|
||||||
|
|
||||||
```
|
```
|
||||||
@@ -88,4 +87,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?
|
Is there anything else you'd like me to add or modify in the contributing guide?
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -20,7 +20,11 @@ The client manages the goose lifecycle automatically, including:
|
|||||||
- **Multiple Sessions**: The client manages multiple concurrent goose conversations simultaneously
|
- **Multiple Sessions**: The client manages multiple concurrent goose conversations simultaneously
|
||||||
|
|
||||||
:::info Session Persistence
|
:::info Session Persistence
|
||||||
ACP sessions are saved to goose's session history where you can access and manage them using goose. However, these sessions aren't persisted in ACP clients, so you'll need to start a new conversation each time you restart the client.
|
ACP sessions are saved to goose's session history where you can access and manage them using goose. Access to session history in ACP clients might vary.
|
||||||
|
:::
|
||||||
|
|
||||||
|
:::tip Reference Implementation
|
||||||
|
The [goose for VS Code](/docs/experimental/vs-code-extension) extension uses ACP to communicate with goose. See the [vscode-goose](https://github.com/block/vscode-goose) repository for implementation details.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
## Setup in ACP Clients
|
## Setup in ACP Clients
|
||||||
@@ -37,7 +41,7 @@ Ensure you have both Zed and goose CLI installed:
|
|||||||
- **Zed**: Download from [zed.dev](https://zed.dev/)
|
- **Zed**: Download from [zed.dev](https://zed.dev/)
|
||||||
- **goose CLI**: Follow the [installation guide](/docs/getting-started/installation)
|
- **goose CLI**: Follow the [installation guide](/docs/getting-started/installation)
|
||||||
|
|
||||||
- ACP support works best with version 1.14.2 or later - check with `goose --version`.
|
- ACP support works best with version 1.16.0 or later - check with `goose --version`.
|
||||||
|
|
||||||
- Temporarily run `goose acp` to test that ACP support is working:
|
- Temporarily run `goose acp` to test that ACP support is working:
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user