summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-09-07 14:29:35 +0300
committerPaul Buetow <paul@buetow.org>2025-09-07 14:29:35 +0300
commit23482b5d8da5c67da1fc501ddbafdd123be3972c (patch)
tree452dc7c418055ebb79a88a303e50d2dbc1877f09 /README.md
parent76f388f9759cdc15cb1eba985cd87cde1906208b (diff)
feat: rename hexai-action -> hexai-tmux-action; remove --tmux/--no-tmux; tmux-only flow; update docs and Magefile
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 4 insertions, 5 deletions
diff --git a/README.md b/README.md
index be68bec..dc5b4cf 100644
--- a/README.md
+++ b/README.md
@@ -12,21 +12,20 @@ It has got improved capabilities for Go code understanding (for example, create
* LSP Code actions
* LSP in-editor chat with the LLM
* Stand-alone command line tool for LLM interaction
-* TUI code-action runner (`hexai-action`) with Bubble Tea
+* TUI code-action runner (`hexai-tmux-action`) with Bubble Tea
* Support for OpenAI, GitHub Copilot, and Ollama
## Documentation
* [Configuration guide](docs/configuration.md)
* [Usage examples](docs/usage.md)
-* [Source structure](docs/source-structure.md)
## Build and tasks
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`, and `hexai-action`)
+- Build binaries: `mage build` (produces `hexai`, `hexai-lsp`, and `hexai-tmux-action`)
- Dev build (+ tests, vet, lint): `mage dev`
- Run tests: `mage test`
- Run tests with coverage: `go test ./... -cover`
@@ -43,5 +42,5 @@ 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`
-- Action runner: `go install codeberg.org/snonux/hexai/cmd/hexai-action@latest`
-Install: `mage install` (copies `hexai-action` to `GOPATH/bin` together with other binaries)
+- Action runner: `go install codeberg.org/snonux/hexai/cmd/hexai-tmux-action@latest`
+Install: `mage install` (copies `hexai-tmux-action` to `GOPATH/bin` together with other binaries)