https://github.com/rumkin/bake

Bake is a bash task runner
https://github.com/rumkin/bake

bash runner task task-runner

Last synced: 27 days ago
JSON representation

Bake is a bash task runner

• Host: GitHub
• URL: https://github.com/rumkin/bake
• Owner: rumkin
• Created: 2016-03-11T15:19:51.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-03-25T18:15:27.000Z (almost 8 years ago)
• Last Synced: 2024-10-31T11:36:52.345Z (about 2 months ago)
• Topics: bash, runner, task, task-runner
• Language: Shell
• Homepage:
• Size: 31.3 KB
• Stars: 26
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Changelog: changelog.md

Awesome Lists containing this project

README

        
# Bake

Bake is a modular task running tool written on pure bash.

## Usage

All you need is to create `bake.sh` into root of your project. Run `bake bake:init`

command. It will create empty `bake.sh` file and `bake_modules` directory.

Example bakefile:

```bash

# bake.sh

# Initialize new node package

task:hello() {

    echo 'Hello'

}

task:say_hello() {

    echo 'Hello again'

}

```

Now you can run tasks:

```shell

bake hello # -> Hello

bake say-hello # -> Hello again

```

## Modules

Modular system is inspired by node.js and golang it uses `bake_modules` directory

and url based package naming. Module requires with command `bake:module`.

Module file could contain tasks and custom functions or variables.

Install module:

```bash

bake -i "github.com/rumkin/test_module"

ls bake_modules/github.com/rumkin/test_module # -> module.sh

```

This command will install module into directory

`bake_modules/github.com/rumkin/test_module`.

Example:

```bash

# bake_modules/github.com/rumkin/test_module/module.sh

rumkin:test_module:print() {

  echo "Hello world"

}

# bake.sh

bake:module "github.com/rumkin/test_module"

task:run() {

    rumkin:test_module:print # -> Hello world

}

```

### Git modules

Git module could be started with "http://" or "https://" and one of popular

repository "github.com" or "bitbucket.org"

```

bake -i "https://github.com/rumkin/test_module"

tree bake_modules

```

Output:

```

bake_modules/

`-- github.com

    `-- rumkin

        `-- test_module

            `-- module.sh

```

### Local modules

Local module must starts with ".", ".." or "/" and will be installed by it's

base name. Example:

```

bake -i ../some-bake-module

ls bake_modules # -> some-bake-module

```

## CLI arguments

* `-l` – List tasks.

* `-e [environment]` – Specify environment located in `bake_env/${environment}.sh` or output current environment variables.

* `-i ` – Install module

* `-v` – Print bake version.

* `-h` – Print bake help.

## Lookup and $PWD

Bake by default looking up the directory tree and search for `.bakerc` then `bake.sh`

file. After that bake switch `$PWD` to the project's root. Calling directory will be stored in `$CWD` variable.

Example:

```bash

# example/bake.sh

task:pwd() {

    echo $PWD $CWD

}

task:ls() {

    ls .

}

```

```bash

cd example/nest

bake pwd # -> example example/nest

bake ls # -> bake.sh nest

```

## Environment

Environments store in `bake_env` directory in shell files like `dev.sh`. Current

environment lays at `.env` file. To dump current environment run `bake -e`. To

switch environment run `bake -e `. To use environment in current

call run `bake -e  `.

## License

MIT.