Skip to content

Commit

Permalink
update usage
Browse files Browse the repository at this point in the history
  • Loading branch information
dzhou121 committed Apr 16, 2024
1 parent c3d913e commit fef6148
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,35 @@ Run below to install latest Tiron binary to ```/usr/local/bin```
curl -sL https://tiron.run/install.sh | sh
```

## Usage

To run a Tiron runbook

```console
$ tiron run
```

Full usage:

```console
$ tiron -h

A reasonable automation engine

Usage: tiron <COMMAND>

Commands:
run Run Tiron runbooks
check Check Tiron runbooks
fmt Format Tiron runbooks
action Show Tiron action docs
help Print this message or the help of the given subcommand(s)

Options:
-h, --help Print help
-V, --version Print version
```

## TUI Navigation

| Key | Action |
Expand Down

0 comments on commit fef6148

Please sign in to comment.