Skip to content

Installation

curl -sSf https://rpcplane.dev/install.sh | sh

Installs rpc-plane to /usr/local/bin. When cosign is installed, the script also verifies the Sigstore signature before installing.

Platform support

Platform Status
Linux x86_64 Supported
Linux aarch64 (ARM) Supported
macOS x86_64 Supported
macOS arm64 (Apple Silicon) Supported
Windows Not yet

Linux binaries are built against glibc 2.35 (Ubuntu 22.04). Compatible with Ubuntu 22.04+, Debian 12+, Amazon Linux 2023, Rocky/RHEL 9+. For older systems use the Docker image or build from source.

Manual download

Download the binary for your platform from GitHub Releases.

Each release includes:

  • Binary for each supported platform
  • .sha256 checksum file
  • .cosign.bundle Sigstore signature

Verify the signature

cosign verify-blob \
  --bundle rpc-plane-x86_64-unknown-linux-gnu.cosign.bundle \
  --certificate-identity-regexp \
    '^https://github\.com/rpcplane/rpc-plane/\.github/workflows/release\.yml@refs/tags/v[0-9].*$' \
  --certificate-oidc-issuer 'https://token.actions.githubusercontent.com' \
  rpc-plane-x86_64-unknown-linux-gnu

Replace x86_64-unknown-linux-gnu with your platform triple:

Platform Triple
Linux x86_64 x86_64-unknown-linux-gnu
Linux aarch64 aarch64-unknown-linux-gnu
macOS x86_64 x86_64-apple-darwin
macOS arm64 aarch64-apple-darwin

Docker

docker run \
  -v $(pwd)/rpc-plane.toml:/etc/rpc-plane.toml \
  -p 9400:9400 \
  -p 9401:9401 \
  ghcr.io/rpcplane/rpc-plane

Images are published to ghcr.io/rpcplane/rpc-plane:{version,latest} and signed with Sigstore.

When running in Docker, set server.listen = "0.0.0.0:9400" in your config so the port is reachable from the host.

From source

cargo install --git https://github.com/rpcplane/rpc-plane rpc-plane

Requires Rust stable. Build time is roughly 2 minutes on a modern machine.

After installing

# Verify the install
rpc-plane --version

# Generate a starter config in the current directory
rpc-plane init

# Validate config and test provider connectivity
rpc-plane check

# Start the proxy
rpc-plane run

CLI reference

rpc-plane run        Start the proxy (default command)
rpc-plane check      Validate config and test provider connectivity
rpc-plane status     Show live provider health (proxy must be running)
rpc-plane init       Generate a starter config file

Flags:
  -c, --config <PATH>   Path to config file (default: rpc-plane.toml)
  -h, --help            Print help
  -V, --version         Print version