# Pipelight - Tiny automation pipelines.

Automate your most boring and repetitive tasks.

## 📦 A lightweight tool for CICD

Pipelight is a [Rust](https://www.rust-lang.org/) based small(13Mb) cli tool to be used from inside a terminal.

* Define pipelines using **typescript, toml, hcl and yaml**.
    
* Trigger on events: git hooks, file changes...
    

Checkout the [Documentation](https://pipelight.dev/) for a much friendly approach and a deeper understanding.

![pipelight_demo](https://github.com/pipelight/doc.pipelight/raw/master/public/images/showcase.gif align="left")

## Define pipelines with a programming language.

Fold your bash commands into an object `Pipeline{ Step{ Command }}` written in **Typescript**.

As long as you know javascript, you are ready to go with your favorite syntax flavor.

Use a verbose and declarative syntax (Objects API).

```plaintext
const my_pipeline = {
  name: "build_my_website",
  steps: [
    {
      name: "clean directory",
      commands: ["rm -rf ./dist"],
    },
    {
      name: "build",
      commands: ["pnpm install", "pnpm lint", "pnpm build"],
    },
  ],
};
```

Use the provided sweet shorthands (Helpers API).

```plaintext
const my_pipeline = pipeline("build website", () => [
  step("clean directory", () => [`rm -rf ${build_dir}`]),
  step("build", () => ["pnpm install", "pnpm lint", "pnpm build"]),
  step("send to host", () => [`scp -r ${build_dir}`]),
  step("do stuffs on host", () => [
    ssh("host", () => ["systemctl restart nginx"]),
  ]),
]);
```

## Define pipelines with a configuration language

For your most simple pipelines.

Toml

```plaintext
[[pipelines]]
name = "test"

[[pipelines.steps]]
name = "build"
commands = ["pnpm install", "pnpm build"]

[[pipelines.triggers]]
branches = ["master","dev"]
actions= ["pre-push", "pre-commit"]
```

Hcl

```plaintext
# A pipeline
pipelines = [{
  name = "test"
  steps = [{
    name     = "build"
    commands = ["pnpm install", "pnpm build"]
  }]
  triggers = [{
    branches = ["master","dev"]
    actions  = ["pre-push", "pre-commit"]
  }]
}]
```

Yaml

```plaintext
pipelines:
  - name: test
    steps:
      - name: build
        commands:
          - pnpm install
          - pnpm build
  - triggers:
      - branches:
          - master
          - dev
        actions:
          - pre-push
          - pre-commit
```

## Automatic triggers

Add automatic triggers to your pipeline.

*If you want to run tests on file change or deploy to production on push to master.*

```plaintext
# enable watcher and git hooks.
pipelight enable git-hooks
pipelight enable watcher
```

```plaintext
pipeline.add_trigger({
  branch: ["master"],
  actions: ["pre-push"],
});
```

## 🫦 Pretty and verbose logs

Get the pipeline most relevant informations or dive into the steps and commands standard outputs.

Get the pipeline status, event, execution time... and more.

```plaintext
pipelight logs
```

[![pretty logs](https://camo.githubusercontent.com/4f22a83511ddbc0d04461ef45a66eae9d082ab55df7e9e9f1736753a2f75c088/68747470733a2f2f706970656c696768742e6465762f696d616765732f6c6f675f6c6576656c5f6572726f722e706e67 align="left")](https://camo.githubusercontent.com/4f22a83511ddbc0d04461ef45a66eae9d082ab55df7e9e9f1736753a2f75c088/68747470733a2f2f706970656c696768742e6465762f696d616765732f6c6f675f6c6576656c5f6572726f722e706e67)

Get a tranparent outputs of every subprocesses.

```plaintext
pipelight logs -vvvv
```

[![pretty logs](https://camo.githubusercontent.com/28520babb55aea489f5dd523bba2eb83b4d946930f24798a42d18bb4bb72d1d6/68747470733a2f2f706970656c696768742e6465762f696d616765732f6c6f675f6c6576656c5f74726163652e706e67 align="left")](https://camo.githubusercontent.com/28520babb55aea489f5dd523bba2eb83b4d946930f24798a42d18bb4bb72d1d6/68747470733a2f2f706970656c696768742e6465762f696d616765732f6c6f675f6c6576656c5f74726163652e706e67)

## 🛠️ Install (Linux)

Important

Pipelight is not (yet) compatible with macOS or Windows.

Checkout the [instruction guide](https://pipelight.dev/introduction/install.html) for your favorite package manager.

## 🚀 Get started!

Create a default configuration file `pipelight.ts` in your project root directory with:

```plaintext
pipelight init
```

Try the harmless default pipeline:

```plaintext
pipelight run
```

And explore logs:

```plaintext
pipelight logs -vvvv
```

## Community

Reach the community whenever you need support or software improvements. On [discord](https://discord.gg/swNRD3Xysz) or on telegram at [@Areskul](https://t.me/areskul) or send a mail at [areskul@areskul.com](mailto:areskul@areskul.com).

## Roadmap

Support other configuration languages:

Can't tell the difference between them, but Rustacean made crates for it.

* feat: add support for hashicorp hcl
    
* feat: add support for apple pkl
    
* feat: add support for CNCF kcl
    

Crate:

* doc: add example for pipelight\_utils crate
    

Javascript helpers:

* feat: add helper for jucenit proxy
    
* refactor: rewrite docker helpers in rust wasm
    

Cli:

* feat: add a tui interface with ratatui
    
* feat: add a live view for processing pipelines
    

Community:

* feat: add a news page on Documentation website
    
* refactor: move out of discord
    

Licensed under GNU GPLv2 Copyright (C) 2023 Areskul