{
"info": {
"author": "@select@github.com",
"author_email": "falko@webpgr.com",
"bugtrack_url": null,
"classifiers": [
"License :: OSI Approved :: MIT License",
"Operating System :: POSIX :: Linux",
"Programming Language :: Python :: 3"
],
"description": "# TermCheat: your terminal cheat sheet\n\n## Synopsis\n\nTermCheat is a searchable library of commands that you can copy remix and extend. \n\n\n\n## Usage\n\n```bash\nterm-cheat\n```\n\nEven better if you add a keyboard shortcut to start TermCheat e.g. Ctrla \n\nAdd this to your `.bashrc` or `.zshrc` or ...\n\n```\nbindkey -s '^A' 'term-cheat --filter^M'\n```\n\n- `-s` simulate keyboard input\n- `^A` Ctrla\n- `^M` Enter key to run the command\n\n## Keyboard Shortcuts\n\nIn *list* mode\n- enter execute command\n- / to fuzzy filter / search for a command \n- a add new command\n- e edit selected command\n- d delected the selected command\n\n\nIn *edit* mode\n- esc to leave edit mode without saving\n- ctrl o to save the command to your database\n\nIn *filter* mode\n- esc to clear the filter\n\n## Installation\n\nWhile the package is waiting for approval from the snap store you can install it by downloading it from here and installing it with snap. \n```\ncurl -OL https://github.com/select/term-cheat/releases/download/0.1.11/term-cheat-0.1.11_amd64.snap\nsudo snap install --classic --dangerous term-cheat-0.1.11_amd64.snap\n```\n\n\nTo install it from source do the following.\n```bash\ngit clone https://github.com/select/term-cheat.git\ncd term-cheat\npipenv install\npipenv shell\npython3 term-cheat-app\n```\n\n## Related Tools and Projects\n\n**Reveser History Search**\\\nSearch through your shell history with CtrlR\n\n**Alias** \\\nCreate a file that contains aliases for your most used commands. \nCreate a the aliases file with `touch ~/.aliases` and add some aliases like\n```\nalias lt='ls -ltr'\nalias df='pydf -h -B'\n```\nnow source the file in your `.bashrc` or `.zshrc` \n```\nsource $HOME/.aliases\n```\nYou could write all aliases directly in you rc file but this way it's more portable if you switch from e.g. bash to zsh.\n\nAnother trick is to sort your history for the commands you use the most and created aliases for these commands to save you time. Here is a command to get your top ten most used commands:\n```\nhistory | awk '{CMD[$2]++;count++;}END { for (a in CMD)print CMD[a] \" \" CMD[a]/count*100 \"% \" a;}' | grep -v \"./\" | column -c3 -s \" \" -t | sort -nr | nl | head -n10\n```\n\n**Autosuggestions** \\\nIf you are using zsh there is a neat plugin called [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions) which will automatically show you suggestions of commands you used before that you can complete using the right arrow key.\n\n**More Related Projects** \\\n\n- [tldr](https://github.com/tldr-pages/tldr)\n- [bropages](http://bropages.org/)\n- [eg](https://github.com/srsudar/eg)\n- [cheat](https://github.com/cheat/cheat) \n\nIf you got other suggestions I would love to include them here.\n\n\n## Motivation\n\nThere are two reasons why I created TermCheat. First of all I love using the terminal and lately I have been learning more things like systemd and just could not remember all the commands on the first go. While I use the [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions) plugin and reverse history search (ctrlr) I still had sometimes problems to recall commands. Furthermore both of these options to not give any additional information about the commands. Most modern editors (sublime-text, atom, ...) now have the option to search for commands with ctrl p which I find super helpful. \n\nThe second reason which is even more important for me is that I find text base user interface (tui) very cool. They give you a proper hacker feeling and if done right are beautiful and fast. I wanted to challenge myself and see if I could build such an interface, and voila two weekends later I had the first version of TermCheat running. After working many years on web based interfaces building a tui is a really nice experience because it's pure minimalism.\n\n## License\n\nTermCheat is released under the [MIT License](http://termcheat.mit-license.org/).\n\n\n",
"description_content_type": "text/markdown",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/select/term-cheat",
"keywords": "",
"license": "",
"maintainer": "",
"maintainer_email": "",
"name": "term-cheat",
"package_url": "https://pypi.org/project/term-cheat/",
"platform": "",
"project_url": "https://pypi.org/project/term-cheat/",
"project_urls": {
"Homepage": "https://github.com/select/term-cheat"
},
"release_url": "https://pypi.org/project/term-cheat/0.1.12/",
"requires_dist": [
"urwid",
"fuzzywuzzy",
"pyyaml",
"appdirs",
"python-Levenshtein"
],
"requires_python": "",
"summary": "A text base UI for collecting and finding termial commands.",
"version": "0.1.12"
},
"last_serial": 4813029,
"releases": {
"0.1.12": [
{
"comment_text": "",
"digests": {
"md5": "46a79c1277cd5ca8a0973db7d96824e0",
"sha256": "b37e8e3f99d8c7f10e97a46aae0a3e9ea2b480161fc37dcf2727d00e119fa800"
},
"downloads": -1,
"filename": "term_cheat-0.1.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "46a79c1277cd5ca8a0973db7d96824e0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9585,
"upload_time": "2019-02-12T21:57:20",
"url": "https://files.pythonhosted.org/packages/cd/94/22a969053537708cea0e107db9bc6d0700ae257c46f32ae4c889a7bf6ab6/term_cheat-0.1.12-py3-none-any.whl"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "46a79c1277cd5ca8a0973db7d96824e0",
"sha256": "b37e8e3f99d8c7f10e97a46aae0a3e9ea2b480161fc37dcf2727d00e119fa800"
},
"downloads": -1,
"filename": "term_cheat-0.1.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "46a79c1277cd5ca8a0973db7d96824e0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9585,
"upload_time": "2019-02-12T21:57:20",
"url": "https://files.pythonhosted.org/packages/cd/94/22a969053537708cea0e107db9bc6d0700ae257c46f32ae4c889a7bf6ab6/term_cheat-0.1.12-py3-none-any.whl"
}
]
}