hunter/README.md
Miguel de la Cruz 547643c2b6 Initial commit
2024-07-05 11:11:13 +02:00

32 lines
815 B
Markdown

# Hunter
From comment hunter, Mastodon, Mammoths... I don't like it either, but
I want to start coding :P
```sh
$ hunter --help
Usage: hunter <command> [flags]
Flags:
-h, --help Show context-sensitive help.
--debug Enables debug mode.
Commands:
parse <file> [flags]
Parses a file looking for a frontmatter key.
statuses <url> [flags]
Gets statuses for a given URL.
Run "hunter <command> --help" for more information on a command.
```
## Roadmap
- [X] Add a proper CLI
- [ ] Add support for templates (YAML should be implemented that way
instead of through a yaml lib)
- [ ] Embed the basic templates
- [ ] Add a subcommand to recursively parse a directory looking for
files with a given key in frontmatter and generate outputs
through a template for those files