Conversation
Co-authored-by: frjcomp <107982661+frjcomp@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR adds a convenient one-liner installation script for Pipeleek using binstaller, making it easier for users to install the tool without manually downloading binaries or using Go. The installer automatically detects the user's OS and architecture and downloads the appropriate binary from GitHub releases.
Key changes:
- Added binstaller configuration that maps to the existing goreleaser asset naming convention
- Modified the documentation deployment workflow to generate and publish the installer script alongside docs
- Updated README and documentation with installation examples using the new script
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
.config/binstaller.yml |
Defines the binstaller configuration with asset naming template matching goreleaser output, platform support for linux/darwin/windows on amd64/arm64, and Windows .exe handling |
.github/workflows/docs.yml |
Adds steps to install binstaller and generate the install script into the docs site directory for GitHub Pages deployment |
README.md |
Adds a "Quick Install" section with the one-liner curl command for Linux/macOS users |
docs/introduction/getting_started.md |
Adds comprehensive quick install documentation including the basic command, custom directory installation, and specific version installation examples |
| To install a specific version: | ||
|
|
||
| ```bash | ||
| curl -sL https://compasssecurity.github.io/pipeleek/install.sh | sh -s -- v0.45.0 |
There was a problem hiding this comment.
[nitpick] The example version v0.45.0 may not exist and could confuse users. Consider using a more obviously placeholder version like v1.2.3 or adding a note that this is an example version. Alternatively, use a concrete existing version number.
| curl -sL https://compasssecurity.github.io/pipeleek/install.sh | sh -s -- v0.45.0 | |
| # Replace v1.2.3 with the desired release version | |
| curl -sL https://compasssecurity.github.io/pipeleek/install.sh | sh -s -- v1.2.3 |
| ``` | ||
|
|
||
| This automatically detects your OS and architecture, then installs the appropriate binary to `~/.local/bin`. | ||
|
|
There was a problem hiding this comment.
[nitpick] Consider adding a note that users may need to add ~/.local/bin to their PATH if it's not already present. For example: "Note: Ensure ~/.local/bin is in your PATH. You can add it with: export PATH="$HOME/.local/bin:$PATH""
| > **Note:** Ensure `~/.local/bin` is in your `PATH`. If you cannot run `pipeleek` after installation, add the following to your shell: | |
| > | |
| > ```bash | |
| > export PATH="$HOME/.local/bin:$PATH" | |
| > ``` | |
| > | |
| > To make this change permanent, add the above line to your shell profile (e.g., `~/.bashrc`, `~/.zshrc`). |
Adds a one-liner installation command for Pipeleek using binstaller, deployed via GitHub Pages.
curl -sL https://compasssecurity.github.io/pipeleek/install.sh | shChanges
.config/binstaller.yml- Configuration defining asset naming, supported platforms (linux/darwin/windows, amd64/arm64), and Windows.exehandling.github/workflows/docs.yml- Generate and deployinstall.shalongside documentationREADME.md/docs/introduction/getting_started.md- Document the quick install command with options for custom directory (-b /usr/local/bin) and specific version (v0.45.0)The installer auto-detects OS/arch and downloads the correct binary from GitHub releases.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
https://api.github.com/repos/CompassSecurity/pipeleek/releases/latest/home/REDACTED/go/bin/binst /home/REDACTED/go/bin/binst check --config .config/binstaller.yml(http block)https://api.github.com/repos/CompassSecurity/pipeleek/releases/tags/1.0.0/home/REDACTED/go/bin/binst /home/REDACTED/go/bin/binst check --config .config/binstaller.yml(http block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.