ok

👌 ok

A unified task runner that discovers and executes tasks from multiple build tools.

Currently supports:

• Just (Justfile)
• Make (Makefile)
• Mise (mise.toml)
• NPM (package.json scripts)
• Yarn (yarn.lock + package.json scripts)
• Rake (Rakefile)
• Task (Taskfile.yml / Taskfile.yaml)
• Nx (nx.json)
• Shell (*.sh / *.bash / *.zsh)

Installation

Install Script (Linux/macOS)

curl -sSL https://raw.githubusercontent.com/broothie/ok/main/install.sh | sh

Or download and inspect first:

curl -sSL https://raw.githubusercontent.com/broothie/ok/main/install.sh -o install.sh
sh install.sh

Homebrew

brew install broothie/ok/ok

Go Install

go install github.com/broothie/ok@latest

Usage

List all available tasks

$ ok
TASK        TOOL   FILE
test-just   Just   Justfile
test-make   Make   Makefile
test-npm    NPM    package.json
test-rake   Rake   Rakefile
test-shell  Shell  test-shell.sh
test-task   Task   Taskfile.yml
test-yarn   NPM    package.json

Run a task

ok <task-name> [args...]

ok will automatically find the task and run it with the appropriate tool, passing along any additional arguments. For example:

$ ok test-npm

> test-npm
> echo 'from npm'

from npm

Help

$ ok -h
ok v0.3.2

Usage:
  ok [options] <task> [task args]

Options:
  -V  --version            Print command version.                                                 (default: false)
  -h  --help               Show command help.                                                     (default: false)
  -d  --directory          Directory to run command from.                                         (default: .)
      --timeout            Command timeout.                                                       (default: 5s)
      --filter-tools --ft  Filter tools by case-insensitive name. Use commas for multiple values  (default: )
      --list-tools         List tools.                                                            (default: false)
      --load-dot-env       Pick up local .env files.                                              (default: true)
      --debug              Output debug logs.                                                     (default: false)