Skip to content
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 63 additions & 19 deletions docs/cody/capabilities/auto-edit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,24 +46,20 @@ Auto-edit is supported by both Cody VS Code and JetBrains plugins.
<Tabs>
<Tab title="VS Code">

<Callout type="info">Auto-edit for VS Code is currently in Beta. It's available for Pro, Enterprise Starter, and Enterprise users on Cody Gateway. Auto-edit requires Fireworks to be enabled as a provider. Enterprise customers without Fireworks enabled can disable the feature flag.</Callout>
<Callout type="info">Auto-edit is available for Pro, Enterprise Starter, and Enterprise users on Cody Gateway. Auto-edit requires Fireworks to be enabled as a provider. Enterprise customers without Fireworks enabled can disable the feature flag.</Callout>

## Enabling auto-edit in VS Code

Auto-edit is enabled by default for Cody Pro Enterprise Starter and Enterprise users. You can opt out and switch back to autocomplete by selecting it from the suggestion mode in the Cody VS Code extension settings.

Site admins can opt their organization out of the auto-edit feature by disabling it from their config settings.

### Auto-edit access for Enterprise customers
### Configure auto-edit access

Auto-edit is available for Enterprise customers with [Sourcegraph Cody Gateway](/cody/core-concepts/cody-gateway#sourcegraph-cody-gateway) access. Enabling the feature requires two steps:
Auto-edit is available as default for Enterprise customers with [Sourcegraph Cody Gateway](/cody/core-concepts/cody-gateway#sourcegraph-cody-gateway) access. To **disable** or configure the auto-edit feature, site administrators must do the following steps:

1. Site administrators must:
- Ensure the feature flag `cody-autoedit-experiment-enabled-flag` is enabled (enabled by default)
- Add `fireworks::*` as an [allowed provider](https://sourcegraph.com/docs/cody/enterprise/model-configuration#model-filters) (see below)
2. Once enabled, auto-edit will become the default suggestion mode for all users
3. Users can optionally switch back to autocomplete from the Cody extension settings
4. Site admins can opt out of auto-edits using the `cody-autoedit-experiment-enabled-flag` feature flag
- To disable auto-edit, turn off the feature flag `cody-autoedit-experiment-enabled-flag` as disabled
- Add `fireworks::*` as an [allowed provider](https://sourcegraph.com/docs/cody/enterprise/model-configuration#model-filters)

The following example demonstrates how to add Fireworks as an allowed LLM provider:

Expand Down Expand Up @@ -93,28 +89,74 @@ The following example demonstrates how to add Fireworks as an allowed LLM provid

<Tab title="JetBrains">

<Callout type="info">Auto-edit for JetBrains IDEs is Experimental and supports JetBrains versions 7.84.0+. It's available for Pro, Enterprise Starter, and Enterprise users on Cody Gateway. Auto-edit requires Fireworks to be enabled as a provider. Enterprise customers without Fireworks enabled can disable the feature flag.</Callout>
<Callout type="info">JetBrains IDEs support auto-edit for versions 7.84.0+. It's available for Pro, Enterprise Starter, and Enterprise users on Cody Gateway. Auto-edit requires Fireworks to be enabled as a provider. Enterprise customers without Fireworks enabled can disable the feature flag.</Callout>

## Enabling auto-edit in JetBrains

You can opt-in the auto-edit feature from the JetBrains Cody plugin settings.
Auto-edit is enabled by default for Cody Pro Enterprise Starter and Enterprise users. You can opt out and switch back to autocomplete by selecting it from the suggestion mode in the Cody JetBrains extension settings.

Site admins can opt their organization out of the auto-edit feature by disabling it from their config settings.

- Click the three-dot menu on the top right of the Cody plugin window and select **Open Cody Settings Editor**
- This will open the `cody_settings.json` file in your editor
- Here, add `"cody.suggestions.mode": "auto-edit"` setting to enable the auto-edit feature

![JetBrains-Cody-Settings-Editor](https://storage.googleapis.com/sourcegraph-assets/Docs/jb-cody-settings.png)

### Auto-edit access for Enterprise customers
### Configure auto-edit access

Auto-edit is available for Enterprise customers with [Sourcegraph Cody Gateway](/cody/core-concepts/cody-gateway#sourcegraph-cody-gateway) access. Enabling the feature requires two steps:
Auto-edit is available as default for Enterprise customers with [Sourcegraph Cody Gateway](/cody/core-concepts/cody-gateway#sourcegraph-cody-gateway) access. To **disable** or configure the auto-edit feature, site administrators must do the following steps:

1. Site administrators must:
- Ensure the feature flag `cody-autoedit-experiment-enabled-flag` is enabled from the settings editor
- Add `fireworks::*` as an [allowed provider](https://sourcegraph.com/docs/cody/enterprise/model-configuration#model-filters) (see below)
2. Once enabled, auto-edit will become the default suggestion mode for all users
3. Users can optionally switch back to autocomplete from the Cody extension settings
4. Site admins can opt out of auto-edits using the `cody-autoedit-experiment-enabled-flag` feature flag
- To disable auto-edit, turn off the feature flag `cody-autoedit-experiment-enabled-flag` as disabled
- Add `fireworks::*` as an [allowed provider](https://sourcegraph.com/docs/cody/enterprise/model-configuration#model-filters)

The following example demonstrates how to add Fireworks as an allowed LLM provider:

```json

"cody.enabled": true,
"modelConfiguration": {
"sourcegraph": {
"modelFilters": {
// Only allow "beta" and "stable" models.
// Not "experimental" or "deprecated".
"statusFilter": ["beta", "stable"],

// Allow any models provided by Anthropic, OpenAI, Google and Fireworks.
"allow": [
"anthropic::*", // Anthropic models
"openai::*", // OpenAI models
"google::*", // Google Gemini models
"fireworks::*", // Open source models hosted by Sourcegraph
],
}
}
}
```

</Tab>

<Tab title="Visual Studio">

<Callout type="info">Visual Studio supports auto-edit for versions 17.6 and above. It's available for Pro, Enterprise Starter, and Enterprise users on Cody Gateway. Auto-edit requires Fireworks to be enabled as a provider. Enterprise customers without Fireworks enabled can disable the feature flag.</Callout>

## Enabling auto-edit in Visual Studio

Auto-edit is enabled by default for Cody Pro Enterprise Starter and Enterprise users. Two settings must be enabled by default in the Visual Studio Cody extension settings to make the auto-edit feature work.

1. Automatically trigger completions
2. Enable Cody Auto-edit

You can opt out and switch back to autocomplete by deselecting it from the Cody Visual Studio extension settings.

![Visual-Studio-Cody-Settings-Editor](https://storage.googleapis.com/sourcegraph-assets/Docs/visual-studio-auto-edit-settings.png)

### Configure auto-edit access

Auto-edit is available as default for Enterprise customers with [Sourcegraph Cody Gateway](/cody/core-concepts/cody-gateway#sourcegraph-cody-gateway) access. To **disable** or configure the auto-edit feature, site administrators must do the following steps:

- To disable auto-edit, turn off the feature flag `cody-autoedit-experiment-enabled-flag` as disabled
- Add `fireworks::*` as an [allowed provider](https://sourcegraph.com/docs/cody/enterprise/model-configuration#model-filters)

The following example demonstrates how to add Fireworks as an allowed LLM provider:

Expand Down Expand Up @@ -142,3 +184,5 @@ The following example demonstrates how to add Fireworks as an allowed LLM provid

</Tab>
</Tabs>

<Callout type="info">Self-hosted customers get autocomplete as default. They cannot opt-in for auto-edit until they allow gateway access to Cody.</Callout>