Part 1: Get comby

WARNING

comby is hosted in a private Git repository and cannot be downloaded using the go get command. There are ways to host comby as a Golang package through a proxy server, but this has not been done yet. Accordingly, a comby user currently only needs access to the Git repository.

Clone Git Repository

Currently comby can be downloaded via git clone.

git clone git@github.com:gradientzero/comby.git

What is important here is the folder structure of the project in which comby is to be used. Ideally, comby and the actual project using comby are at the same folder level. Whatever folder structure you choose, after successfully cloning comby, the next step is to adjust the path in the actual project.

Adjust project's go.mod

In your project's go.mod file, add the following line to replace the github.com/gradientzero/comby/v2 with the local path to your cloned comby repository.

require github.com/gradientzero/comby/v2 v2.0.0
replace github.com/gradientzero/comby/v2 v2.0.0 => /path/to/your/cloned/comby

This will allow you to use the comby framework in your project. Once comby is available in your go.mod file, you can use the following command to get the comby package.

go get github.com/gradientzero/comby/v2