From 752378323bdc5849c71e959212e4eae210bb98df Mon Sep 17 00:00:00 2001 From: Gabe Torres Date: Mon, 22 Dec 2025 16:40:49 -0800 Subject: [PATCH] docs: add documentation for Cody edit modes - Create new edit-modes.mdx page covering Quick Edit (Alt+K) and Chat Panel Edit mode - Document differences in workflow, interface, and when to use each approach - Add comparison table and shared functionality section - Update capabilities index to include edit modes link --- docs/cody/capabilities/edit-modes.mdx | 111 ++++++++++++++++++++++++++ docs/cody/capabilities/index.mdx | 7 ++ 2 files changed, 118 insertions(+) create mode 100644 docs/cody/capabilities/edit-modes.mdx diff --git a/docs/cody/capabilities/edit-modes.mdx b/docs/cody/capabilities/edit-modes.mdx new file mode 100644 index 000000000..27dd0af31 --- /dev/null +++ b/docs/cody/capabilities/edit-modes.mdx @@ -0,0 +1,111 @@ +# Edit Modes + +

+ Cody provides two ways to edit code: the Chat Panel Edit mode and the Quick Edit command (Alt+K). + Both apply changes inline to your files but differ in workflow and interface. +

+ +Cody offers powerful code editing capabilities that let you describe changes in natural language and have them applied directly to your code. There are two main ways to access this functionality: + +- **Quick Edit (Alt+K)**: A dedicated dialog for fast, focused edits +- **Chat Panel Edit Mode**: Edit through the chat interface with a conversational record + +## Quick Edit (Alt+K) + +Quick Edit provides a streamlined way to edit code without leaving your editor context. It opens a dedicated input dialog where you can describe your desired changes. + +### How to use Quick Edit + +1. Select the code you want to edit in your editor +2. Press `Opt+K` (macOS) or `Alt+K` (Windows/Linux) +3. Describe the change you want in the input dialog +4. Optionally configure: + - Range selection + - Model selection + - Context items (@-mentions for files/symbols) +5. Submit your instruction + +Alternatively, you can: +- Right-click and select **Cody → Edit Code** +- Use the 💡 lightbulb menu with `Cmd+.` (macOS) or `Ctrl+.` (Windows/Linux) + +### Quick Edit workflow + +Changes appear directly in your file with decorations showing what was modified. Code lenses appear above the changes with the following options: + +| Action | Keyboard Shortcut | Description | +|--------|-------------------|-------------| +| Accept | `Alt+A` | Apply the suggested changes | +| Undo | `Alt+X` | Revert to the original code | +| Retry | `Alt+R` | Regenerate with a new prompt | +| Show Diff | - | View the changes in diff format | + +## Chat Panel Edit Mode + +The Chat Panel Edit mode lets you request code edits through the chat interface. This is useful when you want a conversational record of your edits or prefer working within the chat panel. + +### How to use Chat Panel Edit mode + +1. Select the code you want to edit in your editor +2. Open the Cody chat panel +3. Click the mode selector dropdown and choose **Edit** + - Or use `Cmd+.` (macOS) or `Ctrl+.` (Windows/Linux) to cycle through modes +4. Type your edit instruction in the chat input +5. Submit your message + +### Chat Panel Edit workflow + +When you submit an edit request through chat: + +1. The diff is first displayed as a formatted message in the chat panel +2. The same inline changes and code lenses appear in your file +3. You have both a chat record AND inline edit controls + +This mode provides visibility into what changes Cody proposes before they appear in your file, along with a persistent record of the edit in your chat history. + +## Comparing the two approaches + +| Feature | Quick Edit (Alt+K) | Chat Panel Edit Mode | +|---------|-------------------|---------------------| +| Interface | Dedicated dialog | Chat input | +| Configuration options | Range, model, @-mentions in dialog | Standard chat @-mentions | +| Result display | Inline changes only | Diff in chat + inline changes | +| Chat history | No record | Preserved in chat history | +| Keyboard shortcut | `Alt+K` / `Opt+K` | Toggle with `Cmd+.` / `Ctrl+.` | +| Best for | Quick, focused edits | Conversational editing with history | + +## When to use each mode + +**Use Quick Edit (Alt+K) when you:** +- Want the fastest path to making an edit +- Don't need to keep a record of the change +- Prefer a dedicated, focused interface + +**Use Chat Panel Edit mode when you:** +- Want to see the diff preview in chat before it's applied +- Need a conversational record of your edits +- Are already working in the chat panel +- Want to iterate on edits with follow-up messages + +## Shared functionality + +Both edit modes use the same underlying system once the edit is triggered. This means you get: + +- **Inline decorations**: Visual indicators showing added and removed code +- **Code lenses**: Accept, Undo, Retry, and Show Diff options above changes +- **Model selection**: Choose which LLM generates the edit +- **Context awareness**: Cody uses your codebase context to make informed edits + +## Insert mode + +In addition to Edit mode, the chat panel also offers an **Insert** mode. While Edit mode modifies existing code, Insert mode generates new code at your cursor position. Toggle between modes using the mode selector dropdown or by pressing `Cmd+.` (macOS) or `Ctrl+.` (Windows/Linux). + +## Client support + +Edit modes are available in the following Cody clients: + +- [VS Code](/cody/clients/install-vscode) +- [JetBrains](/cody/clients/install-jetbrains) +- [Visual Studio](/cody/clients/install-visual-studio) + +See the [feature parity reference](/cody/clients/feature-reference) for detailed client comparison. diff --git a/docs/cody/capabilities/index.mdx b/docs/cody/capabilities/index.mdx index d362a658e..b2a9c0783 100644 --- a/docs/cody/capabilities/index.mdx +++ b/docs/cody/capabilities/index.mdx @@ -15,6 +15,13 @@ description="Use Cody's chat to get contextually-aware answers to your questions." /> + +