Skip to main content

Cheatos: Your terminal post-it notes manager

Project description

Cheatos

Inspired by the need to stop forgetting one-liners for tools like tar, ffmpeg, or git rebase.

Cheatos is a terminal post-it notes manager — lightweight CLI tool for storing cheat sheets called "cheatos", that you access, edit, and tag right from your shell.


✨ Features

  • ✅ Create, edit, and delete short snippets of command-line knowledge
  • 🏷️ Organize with tags
  • 🖊️ Uses $EDITOR for clean editing flow
  • 🔍 Fuzzy search (soon!)
  • 📦 Export/import in JSON or BSON format
  • 🧠 Shell autocompletion for subcommands, cheato names, and tags

🚀 Installation

pipx install cheatos

Make sure to have pipx and Python 3.7+ installed. pipx is preferred over pip for global installations to avoid dependency conflicts and not breaking your OS' Python installation.


🛠️ First Time Use

When you run Cheatos for the first time, it will prompt to enable shell autocompletion for Bash/Zsh automatically.


🧪 Usage

Create a new cheato

cheatos add archive

Your $EDITOR opens. Write your note. Example:

To archive a directory:
tar czf archive.tar.gz folder/

You'll then be prompted to enter tags like:

archive, tar, linux

Show a cheato

cheatos show archive

List all cheatos (optionally by tag)

cheatos list
cheatos list --tag linux

Edit content or tags

cheatos edit archive
cheatos edit archive --tags

Delete a cheato

cheatos remove archive

Rename a cheato

cheatos rename oldname newname

🔁 Export / Import

Export all cheatos to a backup:

cheatos export backup.json
cheatos export backup.bson

Import cheatos from backup:

cheatos import backup.json
cheatos import backup.bson

Use --force to overwrite existing ones.


🧩 Autocompletion

If you skip setup on first run, you can manually enable shell autocompletion:

eval "$(register-python-argcomplete cheatos)"

Add this to your .bashrc or .zshrc.

(I plan to add a command to re-prompt for autocompletion setup.)


✅ Coming Soon

  • cheatos search with fuzzy matching
  • cheatos config command to tweak behavior
  • More export formats (e.g. Markdown)

📄 License

MIT © 2025 Gorbiel

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

cheatos-1.0.2.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cheatos-1.0.2-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

Details for the file cheatos-1.0.2.tar.gz.

File metadata

  • Download URL: cheatos-1.0.2.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cheatos-1.0.2.tar.gz
Algorithm Hash digest
SHA256 95213d157a13e27760c802bf0fdc813684acfc5f4ee8183a14db52a33a360130
MD5 b5b228290fff6819e76a389ff75a7dd1
BLAKE2b-256 216b889354a4d7abd0c34d39cece3f8955ccc63bbe497241b7b871eb0bdd4805

See more details on using hashes here.

Provenance

The following attestation bundles were made for cheatos-1.0.2.tar.gz:

Publisher: python-publish.yml on Gorbiel/Cheatos

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cheatos-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: cheatos-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 9.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cheatos-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d2a6a222c6a10d0c74e027d3590f6bddce24de527d6fee120cba939007997d0a
MD5 f7447e7f3330db61ab537c55469a2d7d
BLAKE2b-256 f7a2a684bc2e780ed4105a3dd609e856c56fe421c0f2c1da3890f1a0aa1f4ee3

See more details on using hashes here.

Provenance

The following attestation bundles were made for cheatos-1.0.2-py3-none-any.whl:

Publisher: python-publish.yml on Gorbiel/Cheatos

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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