From ed91ea50b56fa6b0d4cc6d80ab7cc6d3584bb3d1 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Mon, 15 Sep 2025 09:20:01 +0300 Subject: docs: move build and install guide to its own file --- docs/buildandinstall.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 docs/buildandinstall.md (limited to 'docs') diff --git a/docs/buildandinstall.md b/docs/buildandinstall.md new file mode 100644 index 0000000..7400eda --- /dev/null +++ b/docs/buildandinstall.md @@ -0,0 +1,23 @@ +## 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-tmux-action`) +- Dev build (+ tests, vet, lint): `mage dev` +- Run tests: `mage test` +- Run tests with coverage: `go test ./... -cover` +- Full cross-package coverage and HTML report: `mage coverage` (writes `docs/coverage.html`) +- In restricted sandboxes/CI (no sockets), skip network-based tests: + - `HEXAI_TEST_SKIP_NET=1 go test ./... -cover` +- Install binaries to `GOPATH/bin`: `mage install` + +Note: `mage lint` uses `golangci-lint`. Install via `mage devinstall` if needed. + +## Install + +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-tmux-action@latest` -- cgit v1.2.3