https://github.com/victor-gp/cmd-help-sublime-syntax
Sublime Syntax definition for sharkdp/bat to colorize command --help messages.
https://github.com/victor-gp/cmd-help-sublime-syntax
bat command-line help regex sublime-syntax syntax-highlighting terminal
Last synced: 3 months ago
JSON representation
Sublime Syntax definition for sharkdp/bat to colorize command --help messages.
- Host: GitHub
- URL: https://github.com/victor-gp/cmd-help-sublime-syntax
- Owner: victor-gp
- License: mit
- Created: 2022-03-03T19:24:47.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-16T12:42:54.000Z (3 months ago)
- Last Synced: 2025-02-16T13:52:09.247Z (3 months ago)
- Topics: bat, command-line, help, regex, sublime-syntax, syntax-highlighting, terminal
- Language: YAML
- Homepage:
- Size: 6.15 MB
- Stars: 22
- Watchers: 1
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Roadmap: docs/Roadmap.md
Awesome Lists containing this project
README
# cmd-help.sublime-syntax
Sublime Syntax definition for [`bat`](https://github.com/sharkdp/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.](https://github.com/victor-gp/cmd-help-sublime-syntax/tree/demo/examples)
## Installation
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](https://github.com/sharkdp/bat#adding-new-syntaxes--language-definitions). You have to copy [this file](./syntaxes/cmd-help.sublime-syntax).
To check that everything works, run `git --help | bat -plhelp`
## Configuration
You can find various configuration tips [in the wiki](https://github.com/victor-gp/cmd-help-sublime-syntax/wiki/Configuration-tips). Some of the topics it covers include:
- Setting a `bathelp` alias to avoid typing the full `bat` command with options each time (basic configuration).
- Adding a `help` function you can use like `$ help `, or even `$ help `.
- Enhancing `--help` so you can simply type `$ --help` as 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](https://github.com/victor-gp/cmd-help-sublime-syntax/wiki/Bat-theme-support).
## Contributing
Contributions are welcome! :D
Make sure to give [CONTRIBUTING.md](./CONTRIBUTING.md) a cursory read to learn how you can help.
If you want to hack on the project, look at [the Development doc](./docs/Development.md) to help get you started.
If you like `cmd-help`, please [star it on GitHub](https://github.com/victor-gp/cmd-help-sublime-syntax) and spread the word. :)
## License
MIT © Víctor González Prieto