Sublime Syntax definition for bat to colorize command --help messages.
It provides just enough color to help find your way around a help message.
See examples from other help messages.
This syntax is included with bat since version 0.21.0.
If you have an earlier version of bat or you want the latest version of cmd-help, you can add it as a new syntax. You have to copy this file.
To check that everything works, run git --help | bat -plhelp
You can find various configuration tips in the wiki. Some of the topics it covers include:
- Setting a
bathelpalias to avoid typing the fullbatcommand with options each time (basic configuration). - Adding a
helpfunction you can use like$ help <CMD>, or even$ help <CMD> <SUBCMD>. - Enhancing
--helpso you can simply type$ <CMD> --helpas usual.
cmd-help is compatible with most bat themes (~2/3rds). To get the best experience, ensure your configured theme is supported. You can find the full list of compatible themes here.
Contributions are welcome! :D
Make sure to give CONTRIBUTING.md a cursory read to learn how you can help.
If you want to hack on the project, look at the Development doc to help get you started.
If you like cmd-help, please star it on GitHub and spread the word. :)
MIT © Víctor González Prieto