Cheatsheetify
cheatsheetify is a command-line tool that generates PDF versions of cheatsheets for popular command-line tools.
Installation¶
Usage¶
Basic¶
python cheatsheetify [commands]
For example, to generate a cheatsheet for ls, you would run:
python cheatsheetify ls
Cheatsheet of multiple commands¶
We also have the option where you can pass a list of commands and we will generated a single PDF for all the cheatsheets of the commands.
python cheatsheetify ls cp rm
Custom title¶
The title of the generated PDF can be changed using the --title flag.
python cheatsheetify ls --title "My cheatsheets"
Custom PDF filename¶
The filename of the generated PDF can be changed using the --filename flag.
python cheatsheetify ls --filename "BestCheatsheet"
This example will generated the PDF as BestCheatsheet.pdf
Custom theme¶
You can select the color scheme of the PDF from the available themes. You can use --theme flag to change the theme. The default theme is based on Catppuccin (Macchiato) theme.
python cheatsheetify ls --theme Nord
Remove credit 😟¶
When the PDF is generated, right below the title, there is a link to this project. If you want to remove that, you can simply use --no-credits flag.
python cheatsheetify ls --no-credits
CLI help¶
To show the help page, just use the --help flag.
python cheatsheetify --help
Credits¶
This project would not have been possible without the awesome tldr project.
Contributing¶
Contributions are welcome! If you'd like to add support for a new feature or themes, feel free to open a pull request.
License¶
This project is licensed under the MIT License - see the LICENSE file for details.