https://github.com/amacfie/cmdmenu

Looks up command line syntax from cheatsheets using fuzzy search
https://github.com/amacfie/cmdmenu

cli command-line command-line-tool git helper menu

Last synced: 3 months ago
JSON representation

Looks up command line syntax from cheatsheets using fuzzy search

• Host: GitHub
• URL: https://github.com/amacfie/cmdmenu
• Owner: amacfie
• License: mit
• Created: 2017-08-19T16:29:07.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-09-17T20:46:37.000Z (about 1 year ago)
• Last Synced: 2024-07-16T18:33:54.085Z (4 months ago)
• Topics: cli, command-line, command-line-tool, git, helper, menu
• Language: JavaScript
• Homepage:
• Size: 31.3 KB
• Stars: 16
• Watchers: 4
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# About

Can't remember the syntax for stuff at the command line?

Make cheatsheets and search them with `cmdmenu`.

Similar to [cheat](https://github.com/chrisallenlane/cheat) but different. Even more similar to the newer [navi](https://github.com/denisidoro/navi).

See also

* [TheR1D/shell_gpt](https://github.com/TheR1D/shell_gpt#shell-commands)

# Install

    $ npm -g install cmdmenu

# Usage

1. Create/get/customize JSON task files. Examples of the file format are

  [here](https://github.com/amacfie/cmdmenu_tasks).

  Each task has a description and a list of keywords to help you search for it.

2. Make an alias for each task file. For example:

    ```bash

    $ alias shm="cmdmenu -f ~/cmdmenu_tasks/linux.json"

    $ alias gim="cmdmenu -f ~/cmdmenu_tasks/git.json"

    ```

3. Get task syntax at the command line.

    ```

    $ shm get folder size

    ? Select task (Use arrow keys)

    ❯ Show folder size

      Show file size

      Merge folders

    (Move up and down to reveal more choices)

    ```

    press enter

    ```

    du -sh 

    ? Copy? (Y/n)

    ```