Skip to main content

Quickstart

Let's discover Runt in less than 5 minutes!

Getting Started​

Firstly, let's download runt. This can be done by using the following:

Using homebrew:

brew tap jharrilim/runt
brew install runt

Writing your first Runtfile​

With runt installed, let's go ahead and create a Runtfile. You may create this in any directory you like, although ideally at the root of a project.

Runtfile
# MyProject

## Hello World

This is a hello world

```bash
echo "Hello, world!"
```

Running a task​

With your Runtfile now created, you may now run a task.

Let's do it!

$ runt hello-world

Hello, world!

Notice how the "Hello World" header was converted into the name of the command for runt to execute. To see the help text associated with it, run runt --help:

$ runt --help

Usage: runt [COMMAND]

Commands:
  hello-world  This is a hello world
  help         Print this message or the help of the given subcommand(s)

Options:
  -h, --help   Print help