Skip to content

Installation

Requirements and how to add a go.getarcane.app module to your project.

  • Go 1.27 or newer. Every module declares go 1.27 in its go.mod.
  • A Docker Engine for the Docker-facing modules (docker, docker/compat, builds, updater). They talk to the daemon through the official github.com/moby/moby/client module.
  • Linux for the probes in sys/cgroup. On other platforms they quietly return zero values.
  1. Fetch the module you need. Each one is versioned on its own, so install only the ones you use:

    Terminal window
    go get go.getarcane.app/acfs@latest
  2. Import it:

    import "go.getarcane.app/acfs"
  3. Tidy your module graph:

    Terminal window
    go mod tidy

Tags are prefixed with the module’s directory, but you don’t need to include that prefix when you ask the Go toolchain for a version:

Terminal window
go get go.getarcane.app/kit@v0.4.0

To list the available versions:

Terminal window
go list -m -versions go.getarcane.app/updater

If you are changing a module alongside your application, point your build at a local checkout with a Go workspace:

Terminal window
git clone https://github.com/getarcaneapp/kit
go work init . ./kit/updater ./kit

The kit repository has its own go.work that already includes every nested module, so you can run go test ./... from inside any module directory.