turbo-editors/turbo-go · install.md

⑂ v1.0.0

install.md · 89 lines · 3.7 KBmarkdown    Blame HistoryRaw
   1# How to install and build Turbo Go
3This guide shows how to get a working `turbo-go` binary. It assumes you have Go 1.26 or later and can use a terminal.
5## The short way, from a checkout
8git clone ssh://git@rickub.com/turbo-editors/turbo-go.git
9cd turbo-go
10make install
13That builds the editor, puts it where your shell looks for commands, and tells you what it found: the Go version, where the binary went, whether that directory is on your `PATH`, and whether `gopls` is installed. The build goes to a temporary file first, so a failed build never replaces a working installation.
15Then, from any Go project:
18turbo-go main.go
21### Options
24scripts/install.sh --prefix ~/bin     # install somewhere of your choosing
25scripts/install.sh --with-gopls       # install the language server too
26scripts/install.sh --uninstall        # remove it again  (make uninstall)
27scripts/install.sh --help
30Without `--prefix`, the editor goes where `go install` would put it: `$GOBIN`, or `$GOPATH/bin` when `GOBIN` is unset — usually `~/go/bin`.
32## Just build it, without installing
35
36./bin/turbo-go main.go
39## From the module proxy, without a checkout
42go install rickub.com/turbo-editors/turbo-go@latest
45If the command is then "not found", the install directory is not on your `PATH`:
48export PATH="$PATH:$(go env GOPATH)/bin"
51## Check it works
54turbo-go -version
55turbo-go -list-themes
58The first names the commit the binary was built from, which is what to quote in a bug report; [the version number](../reference/versioning.md) explains what each form means. The second prints the themes compiled into the binary and tells you where your own would go.
60## Variants
62- **You only want to run it once**: `go run rickub.com/turbo-editors/turbo-go@latest main.go`
63- **You want the binary somewhere specific**: `go build -o /usr/local/bin/turbo-go .`
64- **Your terminal has no true colour**: use `turbo-go -theme turbo-classic`, which is built from the sixteen ANSI colours only. `turbo-dark` and `borland-light` use 24-bit colours.
66## When something goes wrong
68**`the installed binary does not run`.** The installer prints whatever the system said just above that line — read it first, because it names the actual problem.
70The installer replaces the binary rather than writing over the one that is there, so a reinstall gives the file a fresh identity. That matters on macOS, which caches a binary's code signature against its inode: writing new bytes into the old inode leaves the cached signature describing something else, and the kernel then refuses to run a binary that built and installed perfectly. If you have an older copy installed by something that used `cp`, removing it first clears any such state:
73scripts/install.sh --uninstall
74scripts/install.sh
77**`Go x.y or later is needed`.** The version comes from `go.mod`, so it cannot drift from what the code actually needs. Upgrade Go, or build from a tag that matches the toolchain you have.
79**`build failed; nothing was installed`.** Your existing installation is untouched — the build goes to a temporary file first. The compiler's own output is printed above the message.
81## Terminal requirements
83Turbo Go needs a terminal that reports its size and supports mouse reporting — every mainstream one does. It reads `TERM` through tcell; if the display is wrong, check that `TERM` matches your terminal (`xterm-256color` is a safe default).
85## See also
87- Every flag: [command line reference](../reference/cli.md)
88- Getting completion working: [How to enable Go completion](enable-completion.md)
89- A guided first session: [Your first file in Turbo Go](../tutorials/getting-started.md)

📦 Turbo Go 3d7798b k33g 12h ago	1	# How to install and build Turbo Go
	2
	3	This guide shows how to get a working `turbo-go` binary. It assumes you have Go 1.26 or later and can use a terminal.
	4
	5	## The short way, from a checkout
	6
	7	```bash
	8	git clone ssh://git@rickub.com/turbo-editors/turbo-go.git
	9	cd turbo-go
	10	make install
	11	```
	12
	13	That builds the editor, puts it where your shell looks for commands, and tells you what it found: the Go version, where the binary went, whether that directory is on your `PATH`, and whether `gopls` is installed. The build goes to a temporary file first, so a failed build never replaces a working installation.
	14
	15	Then, from any Go project:
	16
	17	```bash
	18	turbo-go main.go
	19	```
	20
	21	### Options
	22
	23	```bash
	24	scripts/install.sh --prefix ~/bin # install somewhere of your choosing
	25	scripts/install.sh --with-gopls # install the language server too
	26	scripts/install.sh --uninstall # remove it again (make uninstall)
	27	scripts/install.sh --help
	28	```
	29
	30	Without `--prefix`, the editor goes where `go install` would put it: `$GOBIN`, or `$GOPATH/bin` when `GOBIN` is unset — usually `~/go/bin`.
	31
	32	## Just build it, without installing
	33
	34	```bash
	35	make build
	36	./bin/turbo-go main.go
	37	```
	38
	39	## From the module proxy, without a checkout
	40
	41	```bash
	42	go install rickub.com/turbo-editors/turbo-go@latest
	43	```
	44
	45	If the command is then "not found", the install directory is not on your `PATH`:
	46
	47	```bash
	48	export PATH="$PATH:$(go env GOPATH)/bin"
	49	```
	50
	51	## Check it works
	52
	53	```bash
	54	turbo-go -version
	55	turbo-go -list-themes
	56	```
	57
	58	The first names the commit the binary was built from, which is what to quote in a bug report; [the version number](../reference/versioning.md) explains what each form means. The second prints the themes compiled into the binary and tells you where your own would go.
	59
	60	## Variants
	61
	62	- You only want to run it once: `go run rickub.com/turbo-editors/turbo-go@latest main.go`
	63	- You want the binary somewhere specific: `go build -o /usr/local/bin/turbo-go .`
	64	- Your terminal has no true colour: use `turbo-go -theme turbo-classic`, which is built from the sixteen ANSI colours only. `turbo-dark` and `borland-light` use 24-bit colours.
65
66	## When something goes wrong
67
68	`the installed binary does not run`. The installer prints whatever the system said just above that line — read it first, because it names the actual problem.
69
70	The installer replaces the binary rather than writing over the one that is there, so a reinstall gives the file a fresh identity. That matters on macOS, which caches a binary's code signature against its inode: writing new bytes into the old inode leaves the cached signature describing something else, and the kernel then refuses to run a binary that built and installed perfectly. If you have an older copy installed by something that used `cp`, removing it first clears any such state:
71
72	```bash
73	scripts/install.sh --uninstall
74	scripts/install.sh
75	```
76
77	`Go x.y or later is needed`. The version comes from `go.mod`, so it cannot drift from what the code actually needs. Upgrade Go, or build from a tag that matches the toolchain you have.
78
79	`build failed; nothing was installed`. Your existing installation is untouched — the build goes to a temporary file first. The compiler's own output is printed above the message.
80
81	## Terminal requirements
82
83	Turbo Go needs a terminal that reports its size and supports mouse reporting — every mainstream one does. It reads `TERM` through tcell; if the display is wrong, check that `TERM` matches your terminal (`xterm-256color` is a safe default).
84
85	## See also
86
87	- Every flag: [command line reference](../reference/cli.md)
88	- Getting completion working: [How to enable Go completion](enable-completion.md)
89	- A guided first session: [Your first file in Turbo Go](../tutorials/getting-started.md)