command-reminder 1.0.0

Tool for saving/sharing your mostly used commands for fish shell

command-reminder

Command reminder is a tool for saving and sharing your mostly used fish shell commands. It allows to quickly add commands to a local database, which can then be persisted/shared via Github.

Installation

> pip install command-reminder

Quickstart

1. Create a github repo which will serve as your commands' database.

   > cr init --repo [e-mail]:mygithubuser/my-command-reminder-repository.git
   

   It will create a ~/.command-reminder directory where all your commands will exist. You can change that directory by setting COMMAND_REMINDER_DIR_ENV env variable.

2. Add cr init | source to the ~/.config/fish/config.fish file. It will load default as well as your saved fish functions, every time you start the fish shell.

3. Record a command.

   > cr record --name 'lsof_listening_ports' --command 'lsof -nP -iTCP:$PORT | grep LISTEN'
   

   Remember to use ' except " whenever a command contains $ sign, otherwise the environment variable will be resolved. It saves a command to the local database. You can use tags too:

   > cr record --name 'show_process_rss_memory' --command 'ps o pid,rss -p 23159' --tags '#memory #process'
   

   The record command creates a fish function too (available at shell after cr init | source). It allows to quickly get autosuggestions about available commands just by entering few first command's letters and typing Tab. Currently, it only prints the command content.

4. List all available commands.

   > cr list or > cr list --pretty

   lsof_listening_ports: lsof -nP -iTCP:$PORT | grep LISTEN
   show_process_rss_memory: ps o pid,rss -p 23159
   git_pull: git pull --rebase
   

   Narrow down the results to specific tag.

   > cr list --tags '#memory'
   

5. Load a command to the shell. It would be very inconvenient to copy and paste the listed command. Command reminder comes with a useful shortcut which loads found commands to a fish history - they are available just by typing arrow up.

   > cr list | grep ps | h 
   

   The h shortcut is a function which name is derived from "history" because it loads the command to the fish history. Remember to add it to a fish via cr init | source. Press the arrow up and you can now execute it as a usual command.

6. Push recorded commands to the remote repository.

   > cr push
   

7. You can pull the external repositories too. Let's say you'are working with a team of a few people and have a common set of commands, useful in your working environment. More experienced team members can share their commands to the new ones.

   > cr pull -r [e-mail]:somegithubuser/some-external-commands-repository.git
   

   The pull command adds given repositories to the configuration file: ~/.command-reminder/repositories/main/config.yaml, which is saved in github repo together with recorded commands. When you change a computer, you just init a new project, giving the url to your repo. You will have downloaded your own commands as well as the external ones. To update the commands from external repositories use:

   > cr pull -update_all
   

8. Help menu is available via: cr --help. Each subcommand support help as well, e.g. cr init --help.

Repository structure

~/.command-reminder/
    repositories/
        main/
            commands.json
            fish/
            config.yaml
        external/
            ext1/
                commands.json
                fish/
            ext2/
                commands.json
                fish/

• The main directory is a place when all your own commands are kept. There are internal command reminder files too.
• Configuration file config.yaml contains data to restore your commands anywhere command reminder is installed:

  repositories:
    external:
      - url: ...
      - url: ...
  

• commands.json keeps recorded commands
• fish directory keeps fish functions for commands. It is added to your fish search path, so all commands are available as function with fish autosuggestions. For now the fish functions just print the respective command.
• The external directory contains external repositories commands.

Development

pipenv install --dev

Test

tox

Publish

python setup.py sdist
twine check dist/*
twine upload dist/*

Installation from local setup.py

pip install .

QA:

1. I've got problems with pushing changes to remote repository. The push command use shell git command underneath, so you can just go to the main directory and push it manually.