Skip to content

Getting Started

Software size

Pipelight tries to keep it lightweight with a binary that wheights around 13Mb.

Install with your distribution package manager

Arch Linux (and derivates)

Install the binary from the AUR with an AUR helper like yay, paru, aura...

sh
paru -S pipelight
paru -S pipelight

or compile from the source code for latest updates

sh
paru -S pipelight-git
paru -S pipelight-git
Debian (ubuntu and derivates)

The software being quite young, it can't be found in the big distros repository yet. You will have to install it manually.

First install dependencies:

  • Deno, javascript runtime (optionnal)
  • Git, software version manager (optionnal)
sh
curl -O https://packages.pipelight.dev/pipelight-0.7.14-1-any.deb
dpkg -i pipelight-0.7.14-1-any.deb
curl -O https://packages.pipelight.dev/pipelight-0.7.14-1-any.deb
dpkg -i pipelight-0.7.14-1-any.deb
Fedora (centos and derivates)

The software being quite young, it can't be found in the big distros repository yet. You will have to install it manually.

First install dependencies:

  • Deno, javascript runtime (optionnal)
  • Git, software version manager (optionnal)
sh
curl -O https://packages.pipelight.dev/pipelight-0.7.14-1-any.rpm
yum install pipelight-0.7.14-1-any.rpm
curl -O https://packages.pipelight.dev/pipelight-0.7.14-1-any.rpm
yum install pipelight-0.7.14-1-any.rpm
Nixos (with flakes)

Try it in an isolated shell.

nix
nix shell github:pipelight/pipelight
nix shell github:pipelight/pipelight

Install it on your system.

nix
{
  description = "NixOS configuration for crocuda development";

  inputs = {
    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
    pipelight.url = "github:pipelight/pipelight";
  };

  outputs = {
    nixpkgs,
    pipelight,
  }: {

    # Put this somewhere in your
    # environment system packages
    # user packages
    # or
    # home manager packages
    pipelight.packages.${system}.default

  };
}
{
  description = "NixOS configuration for crocuda development";

  inputs = {
    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
    pipelight.url = "github:pipelight/pipelight";
  };

  outputs = {
    nixpkgs,
    pipelight,
  }: {

    # Put this somewhere in your
    # environment system packages
    # user packages
    # or
    # home manager packages
    pipelight.packages.${system}.default

  };
}

Do not forget to update for newest versions.

sh
nix flake upgrade
nix flake upgrade

Install with the Rust package manager (Cargo)

Cargo build from source
sh
cargo install --git https://github.com/pipelight/pipelight

# Install specific version
cargo install --git https://github.com/pipelight/pipelight --branch master
cargo install --git https://github.com/pipelight/pipelight --tag v0.7.14
cargo install --git https://github.com/pipelight/pipelight

# Install specific version
cargo install --git https://github.com/pipelight/pipelight --branch master
cargo install --git https://github.com/pipelight/pipelight --tag v0.7.14

Install with tool version managers (asdf or rtx) alpha

Asdf and Rtx are systems to manage your runtimes and ensure that versions are the same across multiple devices.

asdf
sh
asdf plugin add pipelight https://github.com/kogeletey/asdf-pipelight

# Install specific version
asdf install pipelight latest
asdf plugin add pipelight https://github.com/kogeletey/asdf-pipelight

# Install specific version
asdf install pipelight latest
rtx
sh
rtx plugin add https://github.com/kogeletey/asdf-pipelight

# Install specific version
rtx install pipelight@latest
rtx plugin add https://github.com/kogeletey/asdf-pipelight

# Install specific version
rtx install pipelight@latest

Install from source

Clone the repo. Build binaries. Move binaries to your bin directory.

sh
git clone https://github.com/pipelight/pipelight.git
cd pipelight
cargo build --release
cp target/release/pipelight /usr/bin/
git clone https://github.com/pipelight/pipelight.git
cd pipelight
cargo build --release
cp target/release/pipelight /usr/bin/

Install with the installation script alpha

For any other linux distribution.

sh
curl https://packages.pipelight.dev/scripts/install.sh | sh
curl https://packages.pipelight.dev/scripts/install.sh | sh