grog

command module
v0.50.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 19, 2026 License: MIT Imports: 3 Imported by: 0

README

Grog


Test status Go Reference Coverage release version Join Slack

Grog is the monorepo build tool for the grug-brained developer.

Grog is fully agnostic on how you run your builds.

Grog delivers cached incremental runs, parallel execution, and more!

What it feels like:

Grog demo

Read more in Why grog?

Highlights

  • 🌐 Language agnostic
  • 🚀 Parallelize your build commands
  • 🔄 Only rebuilds changed targets (incremental)
  • 💾 (Remote) output caching
  • 🌳 Share local cache hits across Git worktrees automatically
  • 🛠️ Simple build configuration with either Makefile, JSON, yaml, ...
  • 📦 Single binary

Installation

MacOS:

brew tap chrismatix/grog
brew install grog

Debian / Ubuntu (swap amd64 for arm64 on ARM):

curl -LO https://grog.build/latest/grog-linux-amd64.deb
sudo apt install ./grog-linux-amd64.deb

Fedora / RHEL:

sudo dnf install https://grog.build/latest/grog-linux-amd64.rpm

Nix:

nix profile install github:chrismatix/grog            # or #grog-with-pkl to include the Pkl CLI

GitHub Actions:

- uses: chrismatix/setup-grog@v1
  with:
    pkl-version: 0.31.1 # optional

Any other Linux:

curl -L https://grog.build/latest/grog-linux-amd64 -o /usr/local/bin/grog
chmod +x /usr/local/bin/grog

To query execution traces with grog traces, install grog-full instead (brew install grog-full, grog-full-linux-amd64.deb, #grog-full), which embeds DuckDB.

Windows (x64, PowerShell):

Invoke-WebRequest https://grog.build/latest/grog-windows-amd64.exe -OutFile grog.exe
.\grog.exe version

Move grog.exe to a directory on PATH. Install Git for Windows with Git on PATH; Grog uses its POSIX shell for target commands and scripts. Native Windows executables work as bin_output. Symlink outputs require Windows Developer Mode or administrator privileges. The default cache lives in %USERPROFILE%\.grog.

Documentation

Grog's documentation is available at grog.build.

Versioning

While Grog is still in pre-release (<1.0.0) all version changes might be breaking. After that Grog will follow semver.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
integration
task_ui command
internal
cmd
cmd/flagtypes
Package flagtypes provides reusable pflag value types.
Package flagtypes provides reusable pflag value types.
dag
oci_push
Package oci_push performs daemon-free registry-to-registry image copies via go-containerregistry.
Package oci_push performs daemon-free registry-to-registry image copies via go-containerregistry.
ociproxy
Package ociproxy implements a minimal OCI Distribution v2 registry that listens on a loopback port and proxies blob/manifest reads and writes to grog's content-addressable store.
Package ociproxy implements a minimal OCI Distribution v2 registry that listens on a loopback port and proxies blob/manifest reads and writes to grog's content-addressable store.
output/push
Package push turns a target's oci_push map into the work that ships its images.
Package push turns a target's oci_push map into the work that ships its images.
resolvers
Package resolvers holds the dependency resolver protocol document and the built-in resolvers that produce it without shelling out.
Package resolvers holds the dependency resolver protocol document and the built-in resolvers that produce it without shelling out.
tools
coveragereport command
Command coveragereport renders a package-level coverage dashboard and badge from a Go coverage profile.
Command coveragereport renders a package-level coverage dashboard and badge from a Go coverage profile.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL