Skip to main content

Personal shell command keeper

Project description

![logo](https://raw.githubusercontent.com/OrkoHunter/keep/master/data/logo.png)

[![PyPI](https://img.shields.io/pypi/v/keep)](https://github.com/orkohunter/keep/releases) ![PyPI - Downloads](https://img.shields.io/pypi/dm/keep)

# A Meta CLI toolkit

> Your personal shell command keeper

## Why?

Writwick Wraj loves using the command line.

Writwick googles "How to do X in terminal?" and multiple forums and blog posts finally provide him the magical _command_ for the rescue. Problem Solved !

Fast forward couple weeks, Writwick has to do X in terminal, again. Wraj remembers solving this few weeks ago. Let him do a reverse-i-search with _Ctrl+R_. Nope, can't remember sh*t. Browser search history? 25 web pages found matching _X_. Argh!

Writwik finally finds the solution. From this time Writwik starts writing the commands somewhere online for the future.

Wait, why shouldn't he keep the command in his terminal itself if this is only place where he'll ever have use it?

## Features

  • Save a new command with a brief description

  • Search the saved commands using powerful patterns

  • Save the commands as a secret GitHub gist

  • Use keep push and keep pull to sync the commands between GitHub gist and other computers.

ProTip : Save the commands you usually forget in ssh sessions and sync it with your local machine.

## Installation

$ pip3 install keep

Use Python 3.6 or later.

You can install pip3 using apt-get as sudo apt install python3-pip.

## Usage

Usage: keep [OPTIONS] COMMAND [ARGS]…

Keep and view shell commands in terminal only.

Read more at https://github.com/orkohunter/keep

Options:
-v, --verbose

Enables verbose mode.

--help

Show this message and exit.

Commands:

edit Edit a saved command. github_token Register a GitHub Token to use GitHub Gists as a backup. grep Searches for a saved command. init Initializes the CLI. list Shows the saved commands. new Saves a new command. pull Pull commands from saved GitHub gist. push Push commands to a secret GitHub gist. rm Deletes a saved command. run Executes a saved command. update Check for an update of Keep.

[See the detailed usage and tutorial.](https://github.com/OrkoHunter/keep/blob/master/tutorial.md)

### Command-line Completion

To enable command-line completion (TAB completion) follow these steps for the shell of your choice

#### bash

  1. Create a directory in your home directory called .bash

    mkdir -p ~/.bash

  2. Copy [completion/keep.bash](https://github.com/OrkoHunter/keep/blob/master/completions/keep.bash) to ~/.bash/keep

    curl -SLo “~/.bash/keep” “https://raw.githubusercontent.com/OrkoHunter/keep/master/completions/keep.bash

  3. Add the following lines to ~/.bashrc file

    [ -f “~/.bash/keep.bash” ] && . “~/.bash/keep”

#### zsh

  1. Create a directory in your home called .zsh

    mkdir -p ~/.zsh

  2. Copy [completion/keep.zsh](https://github.com/OrkoHunter/keep/blob/master/completions/keep.zsh) to ~/.zsh/_keep

    curl -SLo “~/.zsh/_keep” “https://raw.githubusercontent.com/OrkoHunter/keep/master/completions/keep.zsh

  3. Add the following lines inside ~/.zshrc file

    fpath=(~/.zsh $fpath) autoload -Uz compinit && compinit

### Contribute

This is a very young project. If you have got any suggestions for new features or improvements, please comment over [here](https://github.com/OrkoHunter/keep/issues/11). Pull Requests are most welcome !

Not a command line fanatic? Here are some resources for you :

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

keep-2.10.1.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

keep-2.10.1-py3-none-any.whl (15.8 kB view details)

Uploaded Python 3

File details

Details for the file keep-2.10.1.tar.gz.

File metadata

  • Download URL: keep-2.10.1.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.23.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.5

File hashes

Hashes for keep-2.10.1.tar.gz
Algorithm Hash digest
SHA256 3abbe445347711cecd9cbb80dab4a0777418972fc14a14e9387d0d2ae4b6adb7
MD5 588b6cdee3eb8c34302a995e5fc328d4
BLAKE2b-256 6df22c35a4bb1332d81f2b1d94725a9ede4d44902fa8ec11b25dedd210394c2f

See more details on using hashes here.

File details

Details for the file keep-2.10.1-py3-none-any.whl.

File metadata

  • Download URL: keep-2.10.1-py3-none-any.whl
  • Upload date:
  • Size: 15.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.23.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.5

File hashes

Hashes for keep-2.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9e0ce040db9fee88682b70a02b6a000d0b3fef9e9a0a182ceb5a50801980acd3
MD5 857032f9aa217565c5ae56576c6cf87b
BLAKE2b-256 7be22690a6521cad6a83fce272ec98a38ae33355ce3694db21cf9bf438640099

See more details on using hashes here.

Supported by

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