diff options
| author | Paul Buetow <paul@buetow.org> | 2026-02-12 09:33:49 +0200 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2026-02-12 09:33:49 +0200 |
| commit | da160fbdfb30a55a4d617553baeb5b0a5a9d5fb8 (patch) | |
| tree | 8c8c184d3947211c82f10b198c7b366a01cd4780 /docs | |
| parent | cfd02d2874992f7e293d5098bd328a495825a8d4 (diff) | |
Rename hexai-lsp command to hexai-lsp-server
Amp-Thread-ID: https://ampcode.com/threads/T-019c50bc-2906-77db-a31e-0d553338d99b
Co-authored-by: Amp <amp@ampcode.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/buildandinstall.md | 4 | ||||
| -rw-r--r-- | docs/custom-code-actions.md | 6 | ||||
| -rw-r--r-- | docs/usage.md | 6 |
3 files changed, 8 insertions, 8 deletions
diff --git a/docs/buildandinstall.md b/docs/buildandinstall.md index 89a7c57..2240be0 100644 --- a/docs/buildandinstall.md +++ b/docs/buildandinstall.md @@ -3,7 +3,7 @@ Hexai uses Mage for developer tasks. Install Mage, then run targets like build, dev, test, and install. - Install Mage: `go install github.com/magefile/mage@latest` -- Build binaries: `mage build` (produces `hexai`, `hexai-lsp`, `hexai-tmux-action`, and `hexai-tmux-edit`) +- Build binaries: `mage build` (produces `hexai`, `hexai-lsp-server`, `hexai-tmux-action`, and `hexai-tmux-edit`) - Dev build (+ tests, vet, lint): `mage dev` - Run tests: `mage test` - Run tests with coverage: `go test ./... -cover` @@ -19,6 +19,6 @@ Note: `mage lint` uses `golangci-lint`. Install via `mage devinstall` if needed. Either use the Mage method as mentioned above, or install directly with: - CLI: `go install codeberg.org/snonux/hexai/cmd/hexai@latest` -- LSP: `go install codeberg.org/snonux/hexai/cmd/hexai-lsp@latest` +- LSP: `go install codeberg.org/snonux/hexai/cmd/hexai-lsp-server@latest` - Action runner: `go install codeberg.org/snonux/hexai/cmd/hexai-tmux-action@latest` - Tmux popup editor: `go install codeberg.org/snonux/hexai/cmd/hexai-tmux-edit@latest` diff --git a/docs/custom-code-actions.md b/docs/custom-code-actions.md index 9f5b132..2da534f 100644 --- a/docs/custom-code-actions.md +++ b/docs/custom-code-actions.md @@ -1,6 +1,6 @@ # Custom Code Actions Design -This document proposes how Hexai can support user-defined code actions via the config file, and surface them in both hexai-lsp and hexai-tmux-action. +This document proposes how Hexai can support user-defined code actions via the config file, and surface them in both hexai-lsp-server and hexai-tmux-action. ## Goals @@ -65,7 +65,7 @@ Notes: ### Validation -Implement `func (a App) Validate() error` and call it on startup in hexai-lsp and hexai-tmux-action. Fail fast with a descriptive error if any rule is violated: +Implement `func (a App) Validate() error` and call it on startup in hexai-lsp-server and hexai-tmux-action. Fail fast with a descriptive error if any rule is violated: - Duplicate `id` among custom actions (case-insensitive): "config: duplicate custom action id: <id>" - Duplicate custom action `hotkey` (case-insensitive, non-empty): "config: duplicate custom action hotkey: <hotkey>" - `tmux.custom_menu_hotkey` collides with built-in tmux top-level hotkeys (`r,i,c,t,p,s`) or is not a single character: "config: invalid tmux.custom_menu_hotkey: <value>" @@ -76,7 +76,7 @@ Implement `func (a App) Validate() error` and call it on startup in hexai-lsp an - Invalid `scope` value: "config: custom action <id> has invalid scope: <value>" If validation fails: -- hexai-lsp: log the error and exit the server (do not serve requests). +- hexai-lsp-server: log the error and exit the server (do not serve requests). - hexai-tmux-action: print the error on stderr and exit non-zero. ## LSP Integration diff --git a/docs/usage.md b/docs/usage.md index 4d1b50b..f5d977b 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -5,10 +5,10 @@ inline triggers, code actions, and the CLI — with examples. ## LSP server -- Run over stdio: `hexai-lsp` +- Run over stdio: `hexai-lsp-server` - Flags: - `-version`: print Hexai version and exit. - - `-log`: path to log file (default `/tmp/hexai-lsp.log`). + - `-log`: path to log file (default `/tmp/hexai-lsp-server.log`). ### Configure in Helix @@ -23,7 +23,7 @@ formatter = { command = "goimports" } language-servers = [ "gopls", "golangci-lint-lsp", "hexai" ] [language-server.hexai] -command = "hexai-lsp" +command = "hexai-lsp-server" ``` Note: additional LSPs (`gopls`, `golangci-lint-lsp`) are optional; Hexai works without them. |
