docs: Restructure and improve AI configuration docs (#35133)
Adding a number of settings that weren't documented, restructuring things a bit to separate what is model-related settings from agent panel usage-related settings, adding the recently introduced `disable_ai` key, and more. Release Notes: - Improved docs around configuring and using AI in Zed
This commit is contained in:
Danilo Leal
@@ -0,0 +1,223 @@
|
||||
# Agent Settings
|
||||
|
||||
Learn about all the settings you can customize in Zed's Agent Panel.
|
||||
|
||||
## Model Settings {#model-settings}
|
||||
|
||||
### Default Model {#default-model}
|
||||
|
||||
If you're using Zed's hosted LLM service, it sets `claude-sonnet-4` as the default model.
|
||||
But if you're not subscribed to the hosted service or simply just want to change it, you can do it so either via the model dropdown in the Agent Panel's bottom-right corner or by manually editing the `default_model` object in your settings:
|
||||
|
||||
```json
|
||||
{
|
||||
"agent": {
|
||||
"version": "2",
|
||||
"default_model": {
|
||||
"provider": "zed.dev",
|
||||
"model": "gpt-4o"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Feature-specific Models {#feature-specific-models}
|
||||
|
||||
Assign distinct and specific models for the following AI-powered features in Zed:
|
||||
|
||||
- Thread summary model: Used for generating thread summaries
|
||||
- Inline assistant model: Used for the inline assistant feature
|
||||
- Commit message model: Used for generating Git commit messages
|
||||
|
||||
```json
|
||||
{
|
||||
"agent": {
|
||||
"version": "2",
|
||||
"default_model": {
|
||||
"provider": "zed.dev",
|
||||
"model": "claude-sonnet-4"
|
||||
},
|
||||
"inline_assistant_model": {
|
||||
"provider": "anthropic",
|
||||
"model": "claude-3-5-sonnet"
|
||||
},
|
||||
"commit_message_model": {
|
||||
"provider": "openai",
|
||||
"model": "gpt-4o-mini"
|
||||
},
|
||||
"thread_summary_model": {
|
||||
"provider": "google",
|
||||
"model": "gemini-2.0-flash"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
> If a model isn't set for one of these features, they automatically fall back to using the default model.
|
||||
|
||||
### Alternative Models for Inline Assists {#alternative-assists}
|
||||
|
||||
The Inline Assist feature in particular has the capacity to perform multiple generations in parallel using different models.
|
||||
That is possible by assigning more than one model to it, taking the configuration shown above one step further.
|
||||
|
||||
When configured, the inline assist UI will surface controls to cycle between the outputs generated by each model.
|
||||
|
||||
The models you specify here are always used in _addition_ to your [default model](#default-model).
|
||||
|
||||
For example, the following configuration will generate two outputs for every assist.
|
||||
One with Claude Sonnet 4 (the default model), and one with GPT-4o.
|
||||
|
||||
```json
|
||||
{
|
||||
"agent": {
|
||||
"default_model": {
|
||||
"provider": "zed.dev",
|
||||
"model": "claude-sonnet-4"
|
||||
},
|
||||
"inline_alternatives": [
|
||||
{
|
||||
"provider": "zed.dev",
|
||||
"model": "gpt-4o"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Model Temperature
|
||||
|
||||
Specify a custom temperature for a provider and/or model:
|
||||
|
||||
```json
|
||||
"model_parameters": [
|
||||
// To set parameters for all requests to OpenAI models:
|
||||
{
|
||||
"provider": "openai",
|
||||
"temperature": 0.5
|
||||
},
|
||||
// To set parameters for all requests in general:
|
||||
{
|
||||
"temperature": 0
|
||||
},
|
||||
// To set parameters for a specific provider and model:
|
||||
{
|
||||
"provider": "zed.dev",
|
||||
"model": "claude-sonnet-4",
|
||||
"temperature": 1.0
|
||||
}
|
||||
],
|
||||
```
|
||||
|
||||
## Agent Panel Settings {#agent-panel-settings}
|
||||
|
||||
Note that some of these settings are also surfaced in the Agent Panel's settings UI, which you can access either via the `agent: open configuration` action or by the dropdown menu on the top-right corner of the panel.
|
||||
|
||||
### Default View
|
||||
|
||||
Use the `default_view` setting to change the default view of the Agent Panel.
|
||||
You can choose between `thread` (the default) and `text_thread`:
|
||||
|
||||
```json
|
||||
{
|
||||
"agent": {
|
||||
"default_view": "text_thread"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Auto-run Commands
|
||||
|
||||
Control whether you want to allow the agent to run commands without asking you for permission.
|
||||
|
||||
```json
|
||||
{
|
||||
"agent": {
|
||||
"always_allow_tool_actions": "true"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
> This setting is available via the Agent Panel's settings UI.
|
||||
|
||||
### Single-file Review
|
||||
|
||||
Control whether you want to see review actions (accept & reject) in single buffers after the agent is done performing edits.
|
||||
|
||||
```json
|
||||
{
|
||||
"agent": {
|
||||
"single_file_review": "true"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
When set to false, these controls are only available in the multibuffer review tab.
|
||||
|
||||
> This setting is available via the Agent Panel's settings UI.
|
||||
|
||||
### Sound Notification
|
||||
|
||||
Control whether you want to hear a notification sound when the agent is done generating changes or needs your input.
|
||||
|
||||
```json
|
||||
{
|
||||
"agent": {
|
||||
"play_sound_when_agent_done": "true"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
> This setting is available via the Agent Panel's settings UI.
|
||||
|
||||
### Modifier to Send
|
||||
|
||||
Make a modifier (`cmd` on macOS, `ctrl` on Linux) required to send messages.
|
||||
This is encouraged for more thoughtful prompt crafting.
|
||||
|
||||
```json
|
||||
{
|
||||
"agent": {
|
||||
"use_modifier_to_send": "true"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
> This setting is available via the Agent Panel's settings UI.
|
||||
|
||||
### Edit Card
|
||||
|
||||
Use the `expand_edit_card` setting to control whether edit cards show the full diff in the Agent Panel.
|
||||
It is set to `true` by default, but if set to false, the card's height is capped to a certain number of lines, requiring a click to be expanded.
|
||||
|
||||
```json
|
||||
{
|
||||
"agent": {
|
||||
"expand_edit_card": "false"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Terminal Card
|
||||
|
||||
Use the `expand_terminal_card` setting to control whether terminal cards show the command output in the Agent Panel.
|
||||
It is set to `true` by default, but if set to false, the card will be fully collapsed even while the command is running, requiring a click to be expanded.
|
||||
|
||||
```json
|
||||
{
|
||||
"agent": {
|
||||
"expand_terminal_card": "false"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Feedback Controls
|
||||
|
||||
Control whether you want to see the thumbs up/down buttons to give Zed feedback about the agent's performance.
|
||||
|
||||
```json
|
||||
{
|
||||
"agent": {
|
||||
"enable_feedback": "false"
|
||||
}
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user