cargo-green

Crates.iocargo-green
lib.rscargo-green
version0.18.0
created_at2024-05-11 10:27:16.385342+00
updated_at2025-09-07 21:37:37.93051+00
descriptionCargo plugin and $RUSTC_WRAPPER to sandbox & cache cargo builds and execute jobs remotely
homepage
repositoryhttps://github.com/fenollp/supergreen
max_upload_size
id1236783
size357,034
Pierre Fenoll (fenollp)

documentation

README

cargo-green

Cached & remote-ready Rust projects builder by forwarding rustc calls to BuildKit builders.

cargo-green is

  • a cargo plugin that sets a $RUSTC_WRAPPER then calls cargo.

  • a RUSTC_WRAPPER that builds Dockerfiles

Configuration

Reads envs (show values with cargo green supergreen env)

  • $CARGOGREEN_ADD_APK: add.apk TOML setting
  • $CARGOGREEN_ADD_APT_GET: add.apt-get TOML setting
  • $CARGOGREEN_ADD_APT: add.apt TOML setting
  • $CARGOGREEN_BASE_IMAGE_INLINE: base-image-inline TOML setting
  • $CARGOGREEN_BASE_IMAGE: base-image TOML setting
  • $CARGOGREEN_BUILDER_IMAGE: image to use when creating builder container
  • $CARGOGREEN_CACHE_IMAGES: cache-images TOML setting
  • $CARGOGREEN_FINAL_PATH: if set, this file will end up with the final Dockerfile that reproduces the build
  • $CARGOGREEN_INCREMENTAL: incremental TOML setting
  • $CARGOGREEN_LOG_PATH: logfile path
  • $CARGOGREEN_LOG_STYLE
  • $CARGOGREEN_LOG: equivalent to $RUST_LOG (and doesn't conflict with cargo's)
  • $CARGOGREEN_REMOTE: reserved for now
  • $CARGOGREEN_RUNNER: use docker or podman or none as build runner
  • $CARGOGREEN_SET_ENVS: set-envs TOML setting
  • $CARGOGREEN_SYNTAX: use a dockerfile:1-derived BuildKit frontend
  • $CARGOGREEN_WITH_NETWORK: with-network TOML setting

Also passes these envs through to the runner:

  • BUILDKIT_PROGRESS
  • $BUILDX_BUILDER
  • DOCKER_API_VERSION
  • DOCKER_CERT_PATH
  • DOCKER_CONFIG
  • DOCKER_CONTENT_TRUST_SERVER
  • DOCKER_CONTENT_TRUST
  • DOCKER_CONTEXT
  • DOCKER_DEFAULT_PLATFORM
  • DOCKER_HIDE_LEGACY_COMMANDS
  • $DOCKER_HOST
  • DOCKER_TLS_VERIFY
  • DOCKER_TLS
  • HTTP_PROXY
  • HTTPS_PROXY
  • NO_PROXY

Sets

Usage

  • Ensure at least either a docker or podman client is installed
  • Known to work on Ubuntu 22.04 with github.com/docker/buildx v0.11.2 9872040 and rust 1.73
cargo green add
cargo green bench
cargo green build
cargo green check
cargo green clean
cargo green clippy
cargo green doc
cargo green init
cargo green install
cargo green new
cargo green package
cargo green publish
cargo green remove
cargo green run
cargo green search
cargo green test
cargo green uninstall
cargo green update

# or, setting an alias in e.g. ~/.bashrc
alias cargo='cargo green'

# With this, one may also use this set of subcommands: [UNSTABLE API] (refacto into a `cache` cmd)
cargo supergreen config get   VAR*
cargo supergreen config set   VAR VAL
cargo supergreen config unset VAR
cargo supergreen pull-images             Pulls latest versions of images used for the build, no cache (respects $DOCKER_HOST)
cargo supergreen pull-cache              Pulls all from `--cache-from`
cargo supergreen push-cache              Pushes all to `--cache-to`

Fine tuning settings

cargo-green@0.6.0: Cargo plugin and $RUSTC_WRAPPER to sandbox & cache cargo builds and execute jobs remotely
    https://github.com/fenollp/supergreen

Usage:
  cargo green supergreen env             Show used values
  cargo green fetch                      Pulls images (respects $DOCKER_HOST)
  cargo green supergreen push            Push cache image (all tags)
  cargo green supergreen -h | --help
  cargo green supergreen -V | --version

Remote execution

Say you have a bigger machine in your ~/.ssh/config called extra_oomph:

export DOCKER_HOST=ssh://extra_oomph
cargo green test ...

Installation

# Installs to ~/.cargo/bin
cargo install --locked --force --git https://github.com/fenollp/supergreen.git cargo-green

# Make sur $CARGO_HOME/bin is in your $PATH
which cargo-green

Alternatives

In no particular order:

En vrac

Commit count: 284

cargo fmt