purl

(โ˜… 178)

No description available.

  • .gitignore
  • AGENTS.md
  • Cargo.lock
  • Cargo.toml
  • install.sh
  • LICENSE
  • Makefile
  • purl.toml.example
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/stripe/purl

Downloads the entire project code from GitHub to your computer.

cd purl

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
brew install stripe/purl/purl

Installs the pre-built package via Homebrew โ€” no source build required.

cargo install --locked --path cli

Builds and installs the package published on crates.io โ€” no need to clone the repo yourself.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo install --locked --path cli

Builds and installs the package published on crates.io โ€” no need to clone the repo yourself.

โœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make build # Build

Compiles the code based on the generated build configuration to produce an executable.

make test # Run tests

Compiles the code based on the generated build configuration to produce an executable.

make release # Build release binary

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation