opencode_offline/sdks/vscode/README.md

35 lines
1.7 KiB
Markdown
Raw Normal View History

2025-07-20 23:33:41 +08:00
# opencode VS Code Extension
2025-07-28 03:54:45 +08:00
A Visual Studio Code extension that integrates [opencode](https://opencode.ai) directly into your development workflow.
2025-07-20 23:33:41 +08:00
## Prerequisites
2025-07-28 03:54:45 +08:00
This extension requires the [opencode CLI](https://opencode.ai) to be installed on your system. Visit [opencode.ai](https://opencode.ai) for installation instructions.
2025-07-20 23:33:41 +08:00
## Features
2025-07-28 03:54:45 +08:00
- **Quick Launch**: Use `Cmd+Esc` (Mac) or `Ctrl+Esc` (Windows/Linux) to open opencode in a split terminal view, or focus an existing terminal session if one is already running.
- **New Session**: Use `Cmd+Shift+Esc` (Mac) or `Ctrl+Shift+Esc` (Windows/Linux) to start a new opencode terminal session, even if one is already open. You can also click the opencode button in the UI.
- **Context Awareness**: Automatically share your current selection or tab with opencode.
- **File Reference Shortcuts**: Use `Cmd+Option+K` (Mac) or `Alt+Ctrl+K` (Linux/Windows) to insert file references. For example, `@File#L37-42`.
2025-07-20 23:33:41 +08:00
## Support
This is an early release. If you encounter issues or have feedback, please create an issue at https://github.com/sst/opencode/issues.
2025-07-23 01:21:45 +08:00
## Development
1. `code sdks/vscode` - Open the `sdks/vscode` directory in VS Code. **Do not open from repo root.**
2. `bun install` - Run inside the `sdks/vscode` directory.
3. Press `F5` to start debugging - This launches a new VS Code window with the extension loaded.
#### Making Changes
`tsc` and `esbuild` watchers run automatically during debugging (visible in the Terminal tab). Changes to the extension are automatically rebuilt in the background.
To test your changes:
1. In the debug VS Code window, press `Cmd+Shift+P`
2. Search for `Developer: Reload Window`
3. Reload to see your changes without restarting the debug session