Skip to content
GAP DOCS

Install gap

Go 1.25 or newer, plus git. Go’s bin folder must be on your PATH: $(go env GOPATH)/bin, or GOBIN if you set it. Check with go version.

Terminal window
curl -fsSL https://raw.githubusercontent.com/edheltzel/GAP/master/scripts/install.sh | sh

That line does four things:

  1. curl downloads scripts/install.sh from the master branch of github.com/edheltzel/GAP.
  2. The script clones that repo into a new checkout under ~/.gap/checkouts/ and keeps it there.
  3. It builds gap with go install ./cmd/gap and puts the binary in Go’s bin folder.
  4. It checks whether your shell can find that folder. If not, it prints the export PATH=... line to add. Open a new terminal after adding it.

It needs Go 1.25 or newer and git. Installation writes the source checkout and the Go binary. gap sync publishes the policy and installs the selected components and skills.

Already have the repo checked out? From its root, sh scripts/install.sh builds that copy instead of cloning, including when stdin is redirected. Keep that checkout. gap publishes the checkout it was built from, so it runs from any folder. Run the curl command again after cmd/gap changes. To skip installing, run go run ./cmd/gap sync from a checkout.

Then publish:

Terminal window
gap sync

Node

Section titled “Node”

Node is only needed for extra skills in global/skills.json. Component skill installation, drift repair, and restore do not use Node or npx.

Additional skills in global/skills.json install through skills.sh (npx). They require Node. If that installation is needed but npx is unavailable, sync still publishes the policy, skips that installation, and exits 1.