Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/HYP3R00T/Cheatsheetify
A python tool to generate cheatsheet of command line tools as a PDF
https://github.com/HYP3R00T/Cheatsheetify
cheatsheet pdf-generation poetry python python3 tldr
Last synced: 3 months ago
JSON representation
A python tool to generate cheatsheet of command line tools as a PDF
- Host: GitHub
- URL: https://github.com/HYP3R00T/Cheatsheetify
- Owner: HYP3R00T
- License: mit
- Created: 2024-05-02T10:28:18.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-06-17T15:16:46.000Z (8 months ago)
- Last Synced: 2024-07-30T20:54:22.962Z (6 months ago)
- Topics: cheatsheet, pdf-generation, poetry, python, python3, tldr
- Language: Python
- Homepage: http://cheatsheetify.hyperoot.dev/
- Size: 1.11 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Cheatsheetify
cheatsheetify is a command-line tool that generates PDF versions of cheatsheets for popular command-line tools.
Documentation: [cheatsheetify.hyperoot.dev](https://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:
```sh
pip install cheatsheetify
```
## Usage
```sh
python cheatsheetify
```
For example, to generate a cheatsheet for `ls cp rm`, you would run:
```sh
python cheatsheetify ls cp rm
```
The generated PDF cheatsheet will be saved in the current directory. Read the [documentation](https://cheatsheetify.hyperoot.dev/) to learn more about the avialable customizations.
## Credits
This project would not have been possible without the awesome [tldr](https://tldr.sh/) 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](LICENSE) file for details.