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

Automatically generates pipelines for your project.
https://github.com/pipelinit/pipelinit-cli

cli code-quality continuous-integration css deno docker eslint hacktoberfest html javascript npm python sass typescript yarn

Last synced: 28 days ago
JSON representation

Automatically generates pipelines for your project.

• Host: GitHub
• URL: https://github.com/pipelinit/pipelinit-cli
• Owner: pipelinit
• License: mit
• Created: 2021-08-13T20:10:44.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-07-15T18:43:04.000Z (almost 2 years ago)
• Last Synced: 2024-05-19T04:03:09.653Z (about 2 months ago)
• Topics: cli, code-quality, continuous-integration, css, deno, docker, eslint, hacktoberfest, html, javascript, npm, python, sass, typescript, yarn
• Language: TypeScript
• Homepage: https://pipelinit.com
• Size: 380 KB
• Stars: 40
• Watchers: 3
• Forks: 6
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Lists

• awesome-stars - pipelinit/pipelinit-cli - Automatically generates pipelines for your project. (typescript)

README

        


  

    

  





  

    

  

  

    

  

  

    

  



> 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](https://pipelinit.com/playground) 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](https://aur.archlinux.org/packages/)):

```

yay -Sy pipelinit-bin

```

Support for more package managers needed!

### Install version with latest changes

Start by installing [Deno](https://deno.land/) following their [official site](https://deno.land/#installation)

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](https://github.com/pipelinit/pipelinit-cli/releases) 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](docs/reference/stack-support.md), to learn more about the stages read [Stages](docs/explanation/stages.md).

## 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](CONTRIBUTING.md) is the best

place to start!

### Building and installing from source code

- [Building the @pipelinit/core package](core/README.md)

- [Building the CLI executable](cli/README.md)