crondoc

crondoc

generate crontab document tool

Description

• crondoc is tool what generate crontab document from crontab or stdin
• Grouping up to line break

Usage

$ crodoc /etc/crontab
$ crontab -l | crodoc -s

usage: crondoc [OPTIONS] <args> crontab_path

argument
	[crontab_path] generate crontab document

Available options are:
	-v --version	print versions
	-h --help		print help
	-s --stdin		generate crontab document from stdin

document exsample

it will be such an output ....

• SHELL=/bin/bash
• PATH=/sbin:/bin:/usr/sbin:/usr/bin
• MAILTO=root,hoge@mail.co.jp
• HOME=/

run-parts

monday.sh

• Author : hoge
• param : env[dev|stg|prod]
• start every monday

document format

only markdown now ....

document tags

• @title
• @author
• @param

Install

Just want the binary?

Go to the releases page

To install, use go get:

$ go get -d github.com/ogasawara_takahiro/crondoc

Contribution

1. Fork (https://github.com/ogataka50/crondoc/fork)
2. Create a feature branch
3. Commit your changes
4. Rebase your local changes against the master branch
5. Run test suite with the go test ./... command and confirm that it passes
6. Run gofmt -s
7. Create a new Pull Request

TODO

• Selectable output format
• Add many types of tags

License

MIT

Author

ogataka50