Prerequisites

Familiarity with Go

You should have some experience with Go. There are some good tutorials here and here which you can use to get started if you are new to Go. These docs assume you are familiar with Go.

Go toolchain

Download go for your OS and install it. The official instructions are here.

If you are using Windows, the installer should setup the path for you. Ensure that `go` is on your path, you should be able to type the command below in `terminal` or `cmd/powershell` and see the installed go version.

go version

Once go is installed, you can add the GOPATH to your system path. GOPATH is where go will install any tools installed using `go install`, This is typically your `$HOME/go/bin`, this should be added to your system PATH to allow you to run installed tools.

Gofs cli

Once go is installed, you can install the gofs cli by running:

go install github.com/gofs-cli/gofs@latest

Make

The Gofs template includes a Makefile for convenience. To check if you have make installed, run

make --version
If you dont see a make version printed then you will need to install it with the instructions for your OS below.

MacOS

On MacOS make comes with Xcode command line tools. Run this command in a terminal to install it
xcode-select --install

Linux

On Linux you can install it with or equivalent for your distro
sudo apt-get install make

Windows

On Windows you will need to install a make tool such as GNU Make

Copyright © 2025