Skip to main content
                    _      _                _       _               _   
  ___ _ __ ___   __| | ___| |__   ___  __ _| |_ ___| |__   ___  ___| |_ 
 / __| '_ ` _ \ / _` |/ __| '_ \ / _ \/ _` | __/ __| '_ \ / _ \/ _ \ __|
| (__| | | | | | (_| | (__| | | |  __/ (_| | |_\__ \ | | |  __/  __/ |_ 
 \___|_| |_| |_|\__,_|\___|_| |_|\___|\__,_|\__|___/_| |_|\___|\___|\__|

Is a terminal command tool 🖥 that helps to store commands you don't want to keep in the head 🧠

Help command

cmdcheatsheet -h

or:

cmdcheatsheet --help

here is the output:

  --commands, -c - Display all commands.
  --commands-info, -ci - Display all commands, including all details such as ids, etc., all commands.
  --commands-table, -ct - Display all commands using a table view.
  --add <command> <description>, -a <command> <description> - Add new command to the list.
  --update <id> <name> <description>, -u <id> <name> <description> - Update a <command> by id.
  --delete <id>, -d <id> - Delete a <command> by id.
  --find <command>, -f <command> - Search for a command.
  --find-info <command>, -fi <command> - Search for a command and include all details, such as ids, etc.
  --global-find <command>, -gf <command> - Global search.
  --detailed-global-find <command>, -gfi <command> - Search globally for a command and include all details, such as ids, etc.
  --find-table <command>, -ft <command> - Search for a command and show it using a table view.
  --available-command-names <number_of_columns:optional>, -acn <number_of_columns:optional> - Show all stored command names.
  --version, -v - Display version.
  --help, -h - Show a program help notes.
  --display-available-configs, -dac - Display available configurations.
  --display-configs <key:optional>, -dc <key:optional> - Display configurations.
  --remove-config <key>, -rc <key> - Remove a config.
  --set-config <key> <value>, -sc <key> <value> - Set config.
  --set-config-to-default, -sctd - Set the configuration to default.
  --set-single-config-to-default <key>, -ssctd <key> - Set a single configuration to default.
  --add-alternative-store <store_name> <store_location>, -aas <store_name> <store_location> - Add alternative commands store (JSON file) location.
  --delete-alternative-store <store_name>, -das <store_name> - Delete alternative commands store (JSON file).
  --display-applied-alternative-store-name, -daasn - Display the name of applied alternative store.
  --display-available-alternative-stores, -daas - Display available alternative stores.
  --switch-to-alternative-store <store_name>, -stas <store_name> - Switch to alternative store location.
  --update-alternative-store <store_name> <store_location>, -uas <store_name> <store_location> - Update alternative commands store (JSON file).

Add command

cmdcheatsheet -a <command> <command_description>

for example:

cmdcheatsheet -a "ls" "List directory content"

Display commands

Display all commands:

cmdcheatsheet -c

or:

cmdcheatsheet

Display commands along with ids:

cmdcheatsheet -ci

Display commands using table view:

cmdcheatsheet -ct

Search for a command

cmdcheatsheet -f <command>

Search for a command and show it along with an id:

cmdcheatsheet -fi <command>

Search for a command and show it using the table view:

cmdcheatsheet -ft <command>

Global search includes search by command or description:

cmdcheatsheet -gf <query>

Global search and show it along with an id:

cmdcheatsheet -gfi <query>

Update command

cmdcheatsheet -u <command_id> <command> <command_description>

Remove command

cmdcheatsheet -d <command_id>

Show all command names

cmdcheatsheet -acn

Configuration

cmdcheatsheet configuration folder is located at ~/.config/cmdcheatsheet.
The config is called config.json

Available configurations

  • currentStoreLocation - Path to file in JSON format that consists of the command list.
  • alternativeStores - Path list to JSON files that might be used as an alternative commands store location. Every item in the list has a storeName property, which is just a store name and the second property is storeLocation, responsible for the path to the commands store (JSON file location).

Here is a config.json example:

{
    "currentStoreLocation": "/Users/myusername/.config/cmdcheatsheet/commands.json",
    "alternativeStores": [
        {
            "storeName": "unix",
            "storeLocation": "/Users/myusername/my-configs/cmdcheatsheet/unix_commands.json"
        },
        {
            "storeName": "windows",
            "storeLocation": "/Users/myusername/my-configs/cmdcheatsheet/windows_commands.json"
        }
    ]
}

Display configuration

cmdcheatsheet -dc

or display configuration by key:

cmdcheatsheet -dc <config_key>

Display available configs

This command displays all available configurations. Each command consists of a key and an explanation.

cmdcheatsheet -dac

Set config

cmdcheatsheet -sc <configuration_key> <configuration_value>

Remove configuration by key

cmdcheatsheet -rc <config_key>

Set configuration to default

cmdcheatsheet -sctd

Set a single config value

cmdcheatsheet -ssctd <configuration_key>

Alternative commands stores

It's possible to have multiple command stores and switch between them. In this way, you'll be able to have separate configs for windows, Linux, and OSX, or in case you want to split the config in some other way. This feature is called alternative command stores.

Add alternative commands store

cmdcheatsheet -aas <store_name> <store_location>

Update alternative commands store

cmdcheatsheet -uas <store_name> <store_location>

Delete alternative commands store

cmdcheatsheet -das <store_name>

Display available alternative stores

cmdcheatsheet -daas

Switch to alternative commands store

cmdcheatsheet -stas <store_name>

Display applied alternative store name

cmdcheatsheet -daasn

Dependencies

Note: that will include Rich. Rich is a library to display information on the terminal, it is required, and when installed, it's deeply integrated into cmdcheatsheet to display beautiful output.

License

This project is licensed under the terms of the MIT license.

Metadata

Release files for cmdcheatsheet 0.0.48

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cmdcheatsheet 0.0.48
File Size Uploaded Provenance Actions
cmdcheatsheet-0.0.48.tar.gz 17.8 kB Without provenance Details for cmdcheatsheet-0.0.48.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cmdcheatsheet 0.0.48
File Interpreter ABI Platform Actions
cmdcheatsheet-0.0.48-py3-none-any.whl Python 3 none any Details for cmdcheatsheet-0.0.48-py3-none-any.whl

Total release size: 49.0 kB

Release files / cmdcheatsheet-0.0.48.tar.gz

Download URL cmdcheatsheet-0.0.48.tar.gz
Size 17.8 kB
Tags Source
SHA-256 checksum
How to use checksums
222e923f2be95e3e737ab870bc69c8e59ef8bb3a1a7ab63baee060407ccdbd66
BLAKE2b-256 checksum
How to use checksums
58299665931e2096ecbefe51e90950fae4c921d5421fc945da255a33c607db4d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.4

Release files / cmdcheatsheet-0.0.48-py3-none-any.whl

Download URL cmdcheatsheet-0.0.48-py3-none-any.whl
Size 31.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1e4a6dd6160538f94b73b06854b1b38245d89fc7efb2026da63c1df3e57f654d
BLAKE2b-256 checksum
How to use checksums
8bc5b1c6b0d986ce960fa9ad12dff37c828f3e22b32a6f414301555ad39edd15
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.4

Security for cmdcheatsheet 0.0.48

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.48 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page