Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ jobs:
- name: Build book
run: mdbook build book/

- name: Copy init script
run: cp website/init book/book/init
- name: Copy init scripts
run: cp website/init website/init-legacy book/book/

- name: Setup Pages
uses: actions/configure-pages@v5
Expand Down
19 changes: 17 additions & 2 deletions book/src/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,33 @@ Bender is a single standalone binary. You can either use our recommended shell i

## Recommended: Shell Installer

The fastest way to install Bender is using our shell script. It detects your operating system and architecture, downloads the latest release, and places it in your path (typically `~/.cargo/bin`).
The fastest way to install Bender is using our shell script. It detects your operating system and architecture, downloads the matching release, and places the `bender` binary in the current directory:

```sh
curl --proto '=https' --tlsv1.2 https://pulp-platform.github.io/bender/init -sSf | sh
```

After the script finishes, you'll find a `bender` executable in your current directory. Move it onto your `PATH` (e.g. `mv bender ~/.local/bin/`) or invoke it as `./bender`.

### Installing a Specific Version
If you need a specific version of Bender (e.g., `0.31.0`), you can pass it as an argument:
Pass the desired version (e.g. `0.31.0`) as a positional argument:
```sh
curl --proto '=https' --tlsv1.2 https://pulp-platform.github.io/bender/init -sSf | sh -s -- 0.31.0
```

### Global Install
Pass `global` to install into `${CARGO_HOME:-$HOME/.cargo}/bin` instead of the current directory. For v0.32.0 and newer, this also adds the install directory to your `PATH` automatically via the underlying [cargo-dist](https://opensource.axo.dev/cargo-dist/) installer; for older versions, the binary is moved into place but you may need to add the directory to `PATH` manually.

```sh
# Latest release, global install
curl --proto '=https' --tlsv1.2 https://pulp-platform.github.io/bender/init -sSf | sh -s -- global

# Specific version, global install (order of arguments is interchangeable)
curl --proto '=https' --tlsv1.2 https://pulp-platform.github.io/bender/init -sSf | sh -s -- global 0.32.0
```

> **Note:** The installer always overwrites an existing `bender` at the target location without prompting.

## Alternative: Build from Source

If you prefer building your own binary, you will need to [install Rust](https://rustup.rs/).
Expand Down
4 changes: 3 additions & 1 deletion book/src/workflow/ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ variables:
BENDER_VERSION: "0.31.0"

before_script:
# Install Bender using the init script
# Install Bender using the init script. The default install drops `bender` in
# the current directory; add it to PATH for subsequent steps. Alternatively,
# pass `global` to install into $CARGO_HOME/bin instead.
- curl --proto '=https' --tlsv1.2 https://pulp-platform.github.io/bender/init -sSf | sh -s -- $BENDER_VERSION
- export PATH=$PATH:$(pwd)

Expand Down
Loading
Loading