From 3042727f645b20ca2eae645d98c8395678c4d49a Mon Sep 17 00:00:00 2001 From: Aiden Cline <63023139+rekram1-node@users.noreply.github.com> Date: Mon, 22 Dec 2025 11:36:04 -0600 Subject: [PATCH] Delete packages/web/src/content/docs/lsp.mdx --- packages/web/src/content/docs/lsp.mdx | 167 -------------------------- 1 file changed, 167 deletions(-) delete mode 100644 packages/web/src/content/docs/lsp.mdx diff --git a/packages/web/src/content/docs/lsp.mdx b/packages/web/src/content/docs/lsp.mdx deleted file mode 100644 index 7178eb4f8..000000000 --- a/packages/web/src/content/docs/lsp.mdx +++ /dev/null @@ -1,167 +0,0 @@ ---- -title: LSP Servers -description: OpenCode integrates with your LSP servers. ---- - -OpenCode integrates with your Language Server Protocol (LSP) to help the LLM interact with your codebase. It uses diagnostics to provide feedback to the LLM. - ---- - -## Built-in - -OpenCode comes with several built-in LSP servers for popular languages: - -| LSP Server | Extensions | Requirements | -| ------------------ | ------------------------------------------------------------------- | ------------------------------------------------------------ | -| astro | .astro | Auto-installs for Astro projects | -| bash | .sh, .bash, .zsh, .ksh | Auto-installs bash-language-server | -| clangd | .c, .cpp, .cc, .cxx, .c++, .h, .hpp, .hh, .hxx, .h++ | Auto-installs for C/C++ projects | -| csharp | .cs | `.NET SDK` installed | -| dart | .dart | `dart` command available | -| deno | .ts, .tsx, .js, .jsx, .mjs | `deno` command available (auto-detects deno.json/deno.jsonc) | -| elixir-ls | .ex, .exs | `elixir` command available | -| eslint | .ts, .tsx, .js, .jsx, .mjs, .cjs, .mts, .cts, .vue | `eslint` dependency in project | -| fsharp | .fs, .fsi, .fsx, .fsscript | `.NET SDK` installed | -| gleam | .gleam | `gleam` command available | -| gopls | .go | `go` command available | -| jdtls | .java | `Java SDK (version 21+)` installed | -| lua-ls | .lua | Auto-installs for Lua projects | -| nixd | .nix | `nixd` command available | -| ocaml-lsp | .ml, .mli | `ocamllsp` command available | -| oxlint | .ts, .tsx, .js, .jsx, .mjs, .cjs, .mts, .cts, .vue, .astro, .svelte | `oxlint` dependency in project | -| php intelephense | .php | Auto-installs for PHP projects | -| pyright | .py, .pyi | `pyright` dependency installed | -| ruby-lsp (rubocop) | .rb, .rake, .gemspec, .ru | `ruby` and `gem` commands available | -| rust | .rs | `rust-analyzer` command available | -| sourcekit-lsp | .swift, .objc, .objcpp | `swift` installed (`xcode` on macOS) | -| svelte | .svelte | Auto-installs for Svelte projects | -| terraform | .tf, .tfvars | Auto-installs from GitHub releases | -| typescript | .ts, .tsx, .js, .jsx, .mjs, .cjs, .mts, .cts | `typescript` dependency in project | -| vue | .vue | Auto-installs for Vue projects | -| yaml-ls | .yaml, .yml | Auto-installs Red Hat yaml-language-server | -| zls | .zig, .zon | `zig` command available | - -LSP servers are automatically enabled when one of the above file extensions are detected and the requirements are met. - -:::note -You can disable automatic LSP server downloads by setting the `OPENCODE_DISABLE_LSP_DOWNLOAD` environment variable to `true`. -::: - ---- - -## LLM Tool (Experimental) - -OpenCode includes an experimental built-in tool named `lsp` that lets the LLM query your LSP servers for code navigation and symbol information. - -To enable it, set `OPENCODE_EXPERIMENTAL_LSP_TOOL=true` (or `OPENCODE_EXPERIMENTAL=true` to enable all experimental features). - -Once enabled, you can still disable it via your `tools` config: - -```json title="opencode.json" -{ - "$schema": "https://opencode.ai/config.json", - "tools": { - "lsp": false - } -} -``` - -Example prompts: - -- "Use the lsp tool to go to definition of `createServer` in `src/server.ts` at line 12, character 5." -- "Use lsp hover on `User` in `src/models/user.ts` at line 20, character 10." - -:::note -The `lsp` tool only works when an LSP server is available for the file type. -::: - ---- - -## How It Works - -When opencode opens a file, it: - -1. Checks the file extension against all enabled LSP servers. -2. Starts the appropriate LSP server if not already running. - ---- - -## Configure - -You can customize LSP servers through the `lsp` section in your opencode config. - -```json title="opencode.json" -{ - "$schema": "https://opencode.ai/config.json", - "lsp": {} -} -``` - -Each LSP server supports the following: - -| Property | Type | Description | -| ---------------- | -------- | ------------------------------------------------- | -| `disabled` | boolean | Set this to `true` to disable the LSP server | -| `command` | string[] | The command to start the LSP server | -| `extensions` | string[] | File extensions this LSP server should handle | -| `env` | object | Environment variables to set when starting server | -| `initialization` | object | Initialization options to send to the LSP server | - -Let's look at some examples. - ---- - -### Disabling LSP servers - -To disable **all** LSP servers globally, set `lsp` to `false`: - -```json title="opencode.json" {3} -{ - "$schema": "https://opencode.ai/config.json", - "lsp": false -} -``` - -To disable a **specific** LSP server, set `disabled` to `true`: - -```json title="opencode.json" {5} -{ - "$schema": "https://opencode.ai/config.json", - "lsp": { - "typescript": { - "disabled": true - } - } -} -``` - ---- - -### Custom LSP servers - -You can add custom LSP servers by specifying the command and file extensions: - -```json title="opencode.json" {4-7} -{ - "$schema": "https://opencode.ai/config.json", - "lsp": { - "custom-lsp": { - "command": ["custom-lsp-server", "--stdio"], - "extensions": [".custom"] - } - } -} -``` - ---- - -## Additional Information - -### PHP Intelephense - -PHP Intelephense offers premium features through a license key. You can provide a license key by placing (only) the key in a text file at: - -- On macOS/Linux: `$HOME/intelephense/licence.txt` -- On Windows: `%USERPROFILE%/intelephense/licence.txt` - -The file should contain only the license key with no additional content.