Skip to content

Add installer script using binstaller#419

Merged
frjcomp merged 4 commits intomainfrom
copilot/add-installer-script
Dec 2, 2025
Merged

Add installer script using binstaller#419
frjcomp merged 4 commits intomainfrom
copilot/add-installer-script

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Dec 2, 2025

Adds a one-liner installation command for Pipeleek using binstaller, deployed via GitHub Pages.

curl -sL https://compasssecurity.github.io/pipeleek/install.sh | sh

Changes

  • .config/binstaller.yml - Configuration defining asset naming, supported platforms (linux/darwin/windows, amd64/arm64), and Windows .exe handling
  • .github/workflows/docs.yml - Generate and deploy install.sh alongside documentation
  • README.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
    • Triggering command: /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
    • Triggering command: /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

This section details on the original issue you should resolve

<issue_title>Installer</issue_title>
<issue_description>Using https://github.com/binary-install/binstaller create an installer script in the repo. This should be deployed to github pages. There must be single example bash command that is documented in th readme and the documentation, that automatically installs the correct latest binary from github releases.</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: frjcomp <107982661+frjcomp@users.noreply.github.com>
Copilot AI changed the title [WIP] Add installer script for automatic binary installation Add installer script using binstaller Dec 2, 2025
Copilot AI requested a review from frjcomp December 2, 2025 13:41
@frjcomp frjcomp requested a review from Copilot December 2, 2025 13:44
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread docs/introduction/getting_started.md Outdated
To install a specific version:

```bash
curl -sL https://compasssecurity.github.io/pipeleek/install.sh | sh -s -- v0.45.0
Copy link

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

Suggested change
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

Copilot uses AI. Check for mistakes.
Comment thread docs/introduction/getting_started.md Outdated
```

This automatically detects your OS and architecture, then installs the appropriate binary to `~/.local/bin`.

Copy link

Copilot AI Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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""

Suggested change
> **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`).

Copilot uses AI. Check for mistakes.
@frjcomp frjcomp marked this pull request as ready for review December 2, 2025 14:36
@frjcomp frjcomp merged commit 0c0759e into main Dec 2, 2025
11 checks passed
@frjcomp frjcomp deleted the copilot/add-installer-script branch December 2, 2025 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Installer

3 participants