Working Install Instructions

Question

Working Install Instructions

jamesbraza opened this issue 2 years ago · comments

Following the currently suggested install instructions: go install github.com/google/yamlfmt/cmd/yamlfmt@latest

> go install github.com/google/yamlfmt/cmd/yamlfmt@latest
go: downloading github.com/google/yamlfmt v0.5.0
go: downloading gopkg.in/yaml.v3 v3.0.1
go: downloading github.com/RageCage64/multilinediff v0.2.0
go: downloading github.com/mitchellh/mapstructure v1.5.0
go: downloading github.com/bmatcuk/doublestar/v4 v4.2.0
go: downloading github.com/RageCage64/go-utf8-codepoint-converter v0.1.0
go: downloading github.com/google/go-cmp v0.5.9
> yamlfmt
zsh: command not found: yamlfmt

The request is to have working install instructions in the README. Excited to start using yamlfmt!

Braydon Kains · Answer 1 · Fri Oct 14 2022 02:19:56 GMT+0800 (China Standard Time)

Thanks for making an issue!
go install actually installs the binary to the GOBIN environment variable, which is by default $HOME/go/bin. If you add $HOME/go/bin to your path this should work. I forgot that this wasn't done by default. I'll adjust the install instructions to mention that.

James Braza · Answer 2 · Fri Oct 14 2022 02:55:08 GMT+0800 (China Standard Time)

Yeah fwiw I added this to my ~/.zshrc: export PATH=$PATH:$(go env GOPATH)/bin.

Thank you!

Braydon Kains · Answer 3 · Sun Jan 08 2023 05:29:35 GMT+0800 (China Standard Time)

Sorry I'd forgotten about this. In #73 I included a new line to suggest a DigitalOcean article that has a go install setup guide. Hopefully this should work!