Skip to main content

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

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cheatsheetify-0.1.2.tar.gz (541.9 kB view details)

Uploaded Source

Built Distribution

cheatsheetify-0.1.2-py3-none-any.whl (543.9 kB view details)

Uploaded Python 3

File details

Details for the file cheatsheetify-0.1.2.tar.gz.

File metadata

  • Download URL: cheatsheetify-0.1.2.tar.gz
  • Upload date:
  • Size: 541.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.14 Linux/6.5.0-1018-azure

File hashes

Hashes for cheatsheetify-0.1.2.tar.gz
Algorithm Hash digest
SHA256 614e89452aada7e4b76b9b37d3bb57cee284547647b305cdeec94a9f507a2c65
MD5 7b3e4057be9be9a017f48db4ca0e1933
BLAKE2b-256 4372a3d9a53c70fa435ef24385001c2a22106dd08538f32c915a53daf6dfb2ff

See more details on using hashes here.

File details

Details for the file cheatsheetify-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: cheatsheetify-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 543.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.14 Linux/6.5.0-1018-azure

File hashes

Hashes for cheatsheetify-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 76fc1cc2d73180e703b94ef2bce6ad05bb0ee015f5039374ae063833e8f6825b
MD5 4e0a224355274ccef3ce35e4ccf79d9d
BLAKE2b-256 ac0c95235da6619241da22eaed4ea8011b8dd3fb5e11aaeee5599545b273545c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page