Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 1.63 KB

README.md

File metadata and controls

51 lines (32 loc) · 1.63 KB

Cheatsheetify

PyPI - Version GitHub Actions Workflow Status

cheatsheetify is a command-line tool that generates PDF versions of cheatsheets for popular command-line tools.

Documentation: cheatsheetify.hyperoot.dev

Features

  • Generates PDF cheatsheets for popular command-line tools.
  • Easy to use with a simple command-line interface.
  • Customizable output options.
  • Custom themes for the PDFs

Installation

To install cheatsheetify, you can use pip:

pip install cheatsheetify

Usage

python cheatsheetify <list of commands>

For example, to generate a cheatsheet for ls cp rm, you would run:

python cheatsheetify ls cp rm

The generated PDF cheatsheet will be saved in the current directory. Read the documentation to learn more about the avialable customizations.

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 command-line tool or improve an existing cheatsheet, feel free to open a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.