bake-rs - GitLite

KO | EN

gitlite — search

#javascript #python #typescript #go #golang #android #docker #nodejs #windows #pytorch #ios #mcp #openai #open-source

bake-rs

(★ 150)

Simple and easy to use "script runner" written in Rust.

File Explorer

Download Latest Version (.zip)

- - release.yaml
- - arg_parser.rs
  - capabilities.rs
  - help.rs
  - main.rs
  - repl.rs
  - serve.rs
  - show_tasks.rs
- Cargo.lock
- Cargo.toml
- - lib.rs
- Cargo.lock
- Cargo.toml
.gitignore
Cargo.lock
Cargo.toml
Changes.md
install.sh
LICENSE
logo.png
README.md
screenshot.jpg

# Installation Guide

1. Get the code

git clone https://github.com/ali77gh/bake-rs

Downloads the entire project code from GitHub to your computer.

cd bake-rs

Moves into the project folder you just downloaded.

2. Rust

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

- name: cargo

Type this command into your terminal and run it.

check: [cargo --version]

Type this command into your terminal and run it.

dependencies: [cargo] # dependencies can depend on other dependencies

Type this command into your terminal and run it.

check: [cargo clippy --version]

Type this command into your terminal and run it.

commands: [cargo install clippy] # install button will automatically install

Type this command into your terminal and run it.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Bake-rs

<img src="./logo.png" width=600/>

[![OS - Linux](https://img.shields.io/badge/OS-Linux-blue?logo=linux&logoColor=white)](https://www.linux.org/ "Go to Linux homepage")
[![OS - macOS](https://img.shields.io/badge/OS-macOS-blue?logo=apple&logoColor=white)](https://www.apple.com/macos/ "Go to Apple homepage")
[![OS - Windows](https://img.shields.io/badge/OS-Windows-blue?logo=windows&logoColor=white)](https://www.microsoft.com/ "Go to Microsoft homepage")

![GitHub top language](https://img.shields.io/github/languages/top/ali77gh/bake-rs)
[![GitHub license](https://badgen.net/github/license/ali77gh/bake-rs)](https://github.com/ali77gh/bake-rs/blob/master/LICENSE)

Bake is a universal cross-platform script runner written in Rust which can be used for any kind of project or application.

Essentially, you put your tasks in a YAML file. Then, you have an interactive CLI + TUI + GUI interface to run these tasks, enabling your coworkers (and yourself six months later, having forgotten all the commands) to execute your commands with the click of a button!

Bake can also help users install dependencies and setup environment variables. Furthermore, it supports a plugin system that allows you to import other people's bakefile.yaml configurations into your own.

You can see roadmap [here](https://github.com/users/ali77gh/projects/5/)

<img src="screenshot.jpg" width=600/>

## Table of content

- [Bake-rs](#bake-rs)
  - [Table of content](#table-of-content)
  - [Installation](#installation)
    - [Linux, Mac, WSL and Docker:](#linux-mac-wsl-and-docker)
    - [Windows:](#windows)
  - [Basic](#basic)
    - [Usage](#usage)
  - [End event handlers](#end-event-handlers)
    - [Handler syntax :](#handler-syntax-)
    - [Events names:](#events-names)
    - [Example:](#example)
  - [Keep alive](#keep-alive)
    - [Example](#example-1)
  - [Dependencies](#dependencies)
    - [Run other tasks from a task](#run-other-tasks-from-a-task)
  - [Platform specific commands](#platform-specific-commands)
  - [Environment variables](#environment-variables)
  - [Working directory](#working-directory)
  - [Plugin system](#plugin-system)
  - [Web app and API (serve)](#web-app-and-api-serve)
  - [Stars](#stars)

## Installation

### Linux, Mac, WSL and Docker:

Single command installation:

```bash
curl -sfL https://raw.githubusercontent.com/ali77gh/bake-rs/stable/install.sh | sudo bash -
```

### Windows:

Download latest release from [here](https://github.com/ali77gh/bake-rs/releases) and copy that where you want and than add installation path to PATH env variable and than you are good to go.

## Basic

Make a file named 'bakefile.yaml'

```yaml
tasks:
  - name: clean
    help_msg: this task removes what you build
    commands: [rm ./build]

- name: hello
    help_msg: this task says hello
    commands:
      - echo hello world
      - echo hello from Bake
```

### Usage

See list of tasks:

```sh
$ bake --show # or --list
 Tasks:

⚙  1  clean (this task removes what you build)

⚙  2  hello (this task says hello)
```

Run specific task:

```sh
$ bake hello
  🛈 Verbose : task 'hello' is running...
hello world
hello from bake
  🛈 Verbose : Task 'hello' finished successfully. time: 2ms
```

Note: you can also run task by index like 'bake 1'

Start interactive CLI (see screen shot):

```sh
bake
```

This will run bake in loop

## End event handlers

### Handler syntax :

```
<EVENT_NAME>: <FUNCTION_CALL>
```

### Events names:

1. on_success: runs if task ends with zero code
2. on_error: runs if task ends with non-zero code
3. on_end: runs anyway (runs after on_success and on_error)

### Example:

This script checks if 'build' directory exist and if it's exist it runs 'another_task1' if it's not exist it runs another_task2, and after that it runs another_task3 in ether ways.

```yaml
tasks:
  - name: task_name
    commands:
      - ls build
    on_success: "@this.another_task1"
    on_error: "@this.another_task2"
    on_end: "@this.another_task3"
```

> [!WARNING]  
> DO NOT recursive call same function (bake will panic for stack overflow at some point) use [keep_alive](#keep-alive) instead.

## Keep alive

This option will run your task in a loop without considering exit-code

Note: default is false

### Example

```yaml
tasks:
  - name: task_name
    commands:
      - npm start
    keep_alive: true
```

## Dependencies

Sometimes you need some stuff installed on system to run a command.

for example to compile a Rust code-base you need to have 'cargo' installed.

```yaml
dependencies:
  - name: cargo
    check: [cargo --version]
    link: https://www.rust-lang.org/tools/install # install button opens browser and user should manually install it

- name: clippy
    dependencies: [cargo] # dependencies can depend on other dependencies
    check: [cargo clippy --version]
    commands: [cargo install clippy] # install button will automatically install

- name: check-file-exist-dependency
    check: [ls target] # you can check if a file or directory exist like this
    commands: [cargo build]
```

Now you tasks can depends on dependencies

```yaml
tasks:
  - name: release
    dependencies: [cargo]
    commands:
      - cargo build --release

- name: check
    dependencies: [cargo, clippy]
    commands:
      - cargo check
      - cargo clippy
      - cargo fmt --check
      - cargo test
```

Note: by running 'release' Bake first gonna check if you have rust installed by running specified command: "cargo --version", if this commands exit with non zero code (means cargo is not installed) Bake will run cargo installation commands that you provided (or open provided link in browser) and while cargo is installed Bake will run 'release' task commands one by one.

Note: 'check' command works with [exit code](https://en.wikipedia.org/wiki/Exit_status#:~:text=In%20computing%2C%20the%20exit%20status,referred%20to%20as%20an%20errorlevel.)
so if the exit code is 0 this means dependency is installed or exist but any other non-zero code will try to run your specified command or link to get your dependency installed.

You can also specify different commands or links for installing on different platforms:

Note: by default bake will ask yes/no question before start installing,
but by passing '--non-interactive' switch bake will not wait for stdin and will start installing dependency.

```yaml
dependencies:
  - name: wget
    check: [wget --version]
    commands_linux: [sudo apt install wget] # linux only
    link: https://www.gnu.org/software/wget/ # mac and windows (in this case)
```

### Run other tasks from a task

For running other task from your task you need to put a '@' at the beginning of your command (so the parser will know it's a Bake command and not a system binary)

> [!WARNING]
> '@' syntax should always be used inside double quotes.

```yaml
tasks:
  - name: release
    dependencies: [rust]
    commands:
      - "@this.check" # here
      - cargo build --release
      - "@this.publish" # here

- name: check
    commands:
      - cargo check
      - cargo clippy
      - cargo fmt --check
      - cargo test

- name: publish
    commands:
      - cargo publish
```

## Platform specific commands

Sometimes you need to run different commands on different operating systems:

```yaml
tasks:
  - name: clean
    commands: # default (linux and mac in this case)
      - rm ./target
    commands_windows:
      - del target
```

Note: If you run this on a windows system only the windows commands will run but as you did not specify commands_linux and commands_macos if you run this task on Linux or MacOS it will run default commands.

Note: if you don't specify platform specific commands for a platform with no default commands Bake will show an error while running that task on that specific platform.

## Environment variables

Sometimes your tasks need some environment variables to run, in this case you can specify some 'envs' for your task and Bake will check if that environment variable is exist or not.

Note: you can also provide a default value for your env by providing 'default' field in your yaml

```yaml
tasks:
  - name: listen
    envs:
      - name: PORT
        default: 80
    commands: [nc -l -p $PORT]
```

You can also specify simple validation for your env that checks value before run.

1. number (float or integer)
1. integer
1. variants(variation1|variation2|variation3,...)

```yaml
tasks:
  - name: task_with_envs
    envs:
      - name: PORT
        default: 5
        validator: integer

- name: build-mode
        default: debug
        validator: variants(debug|release)
```

And you can pass env to a task while calling it from another task

syntax is like:

```yaml
tasks:
  - name: task_with_envs_caller
    commands:
      - "@this.task_with_envs --PORT 80 --build-mode release" # passing args to other task
```

Note: by default bake will ask for env on cli if it's not set,
but by passing '--non-interactive' switch bake will not wait for stdin and will raise an error.

## Working directory

You can setup working directory of a task:

```yaml
tasks:
  - name: my_task
    commands:
      - "touch yoho"
    working_directory: sub_directory
```

This task will make "./sub_directory/yoho" file

You can also pass absolute path like: "/home/ali/Music" if you want.

## Plugin system

You can import other peoples '.yaml' files and call there tasks from your tasks or depend on their dependencies.

```yaml
plugins:
  - name: fs
    path: ./.bake/fs.yaml
```

```yaml
tasks:
  - name: my_task
    commands:
      - "@fs.copy_file"
```

Note: you can also write your local plugins for your project.

## Web app and API (serve)

Bake can host a web app and a JSON api for your tasks:

```sh
$ bake serve --port 8080 # default port is 8000
```

It serves two things on the same port:

1. **Web app**: open `http://localhost:8080` in browser, you will see list of tasks.
   By clicking on a task you go to `/{taskName}` page where you can fill task envs (as normal html inputs)
   and click 'Run' to run the task and see output logs live.

2. **JSON API**:
   - `GET /` returns list of tasks with descriptions, commands and more
   - `GET /{taskName}` returns single task info
   - `POST /{taskName}` runs the task and streams std-out/stderr as plain text

Note: browsers get html pages (by `Accept: text/html` header) and other clients (curl, scripts, etc) get json.

Example:

```sh
$ curl localhost:8080/
$ curl -X POST "localhost:8080/greet?NAME=ali&COUNT=3"
```

Params can be passed by query string or form body (`NAME=ali&COUNT=3`).

## Stars

[![Stargazers over time](https://starchart.cc/ali77gh/bake-rs.svg)](https://starchart.cc/ali77gh/bake-rs)