Skip to content

Commit

Permalink
docs: update instructions for new cli flags
Browse files Browse the repository at this point in the history
  • Loading branch information
lirantal committed Aug 6, 2022
1 parent 72c5311 commit 1b6126b
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,27 @@ A complete example of this configuration file:
}
```

### Gigsboat CLI arguments

You can provide the gigsboat CLI with arguments to control the behaviour of the CLI.

Run the CLI with the `--help` argument to see a list of available arguments:

```sh
Options:
--help Show help [boolean]
--version Show version number [boolean]
-o, --output-file [string] [default: "README-gigsfile.md"]
-s, --source-directory [string] [default: "pages"]
```

As such, you can control the source file directory and the output file name,
for example:

```sh
npx gigsboat -s ~/myProject/data/pages -o README-gigs.md
```

## I already track events via YAML / Markdown

Use the `gigsboat` CLI to manage them all!
Expand Down

0 comments on commit 1b6126b

Please sign in to comment.