Skip to content

pipelinit/pipelinit-cli

Repository files navigation

GitHub release (latest SemVer) Twitter Follow

Automatically create complete pipelines for your project

Say goodbye to YAML!

Pipelinit detects the stack of your project and automatically creates a fully working pipeline configuration for multiple continous integration (CI) platforms (currently supporting GitHub Actions).

Start by using the Pipelinit Playgroud right on your browser! 🚀

How to install

Using a Docker image

Run the command below inside a checkout of your project's source code:

docker run -it -v $(pwd):/workdir ghcr.io/pipelinit/pipelinit-cli

Using package managers

Homebrew (macOS):

brew tap pipelinit/pipelinit-cli
brew install pipelinit/pipelinit-cli

ArchLinux User Repository (AUR):

yay -Sy pipelinit-bin

Support for more package managers needed!

Install version with latest changes

Start by installing Deno following their official site

Checkout the Pipelinit repository in your computer:

git clone https://github.com/pipelinit/pipelinit-cli.git

Then install Pipelinit with the Deno script installer:

deno install -A -f --unstable cli/pipelinit.ts

You should see the following message in your terminal:

✅ Successfully installed pipelinit

Manual download

Download one of the executables from the Releases page and add the binary into your PATH.

We provide binaries for Linux, Windows and Mac.

How to use

Just run pipelinit on the root of your project's source code and follow the instructions:

pipelinit

Supported stacks overview

Pipelinit Support Matrix
Stack Stage GitHub Actions GitLab CI
CSS Format ✔️ Coming soon
Lint ✔️
Docker Build ✔️
Lint ✔️
SAST ✔️
HTML Format ✔️
Lint ✔️
Java Build ✔️
SAST ✔️
JavaScript / TypeScript Format ✔️ ✔️
Lint ✔️ ✔️
Test ✔️ ✔️
SAST ✔️ ✔️
Markdown Lint ✔️ Coming soon
Python Format ✔️ ✔️
Lint ✔️ ✔️
Test ✔️ ✔️
SAST ✔️ ✔️
Ruby Lint ✔️ Coming soon
Format ✔️
SAST ✔️
Shell Script Lint ✔️
Terraform Lint ✔️
Format ✔️

To see details about which tools are used read the Detailed stack support, to learn more about the stages read Stages.

How it works

When you run Pipelinit in the root of a software project:

  1. It checks what kind of files exists there to detect the stacks.
  2. It collects more detailed data about each stack.
  3. It uses that data to build the CI configuration files.

Developing and contributing

We love contributions and our Contributing Guide is the best place to start!

Building and installing from source code