Quick Start

1. Install the gofs cli

info

You need Go 1.24 or greater. If you don't have Go installed, see Prerequisites.

Install the latest gofs cli by running the command:

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

tip

If you have an existing project, you can install gofs cli with the tool directive feature of Go added in v1.24.

To install gofs cli as a tool, use

go get -tool github.com/gofs-cli/gofs@latest

Navigate to the folder where you want to initialize your project. Provide gofs with a go module name such as github.com/myorg/myapp

If you have created a project folder, from your project folder run

gofs init github.com/myorg/myapp

If you want gofs to create the project folder, run

gofs init github.com/myorg/myapp myfolder

tip

If you have an existing project and you installed gofs as a tool, run

go tool gofs init github.com/myorg/myapp

info

The Gofs template includes a Makefile for convenience. If you don't have Make installed, see Prerequisites.

From your project directory run

make