hstr/README.md

# HSTR
[![Travis CI](https://travis-ci.org/dvorka/hstr.svg?branch=master)](https://travis-ci.org/dvorka/hstr)
<!--
[![Current release](https://img.shields.io/github/release/dvorka/hstr.svg)](https://github.com/dvorka/hstr/releases)
[![GitHub issues](https://img.shields.io/github/issues/dvorka/hstr.svg?maxAge=360)](https://github.com/dvorka/hstr/issues)
[![All releases downloads](https://img.shields.io/github/downloads/dvorka/hstr/total.svg)](https://github.com/dvorka/hstr/releases)
-->

Easily view, navigate and search your **command history** with shell history suggest box for Bash and
[zsh](CONFIGURATION.md#zsh-history-settings).

[![Shell History Suggest Box](doc/hstr-v2.gif "Shell History Suggest Box @ YouTube")](http://www.youtube.com/watch?v=sPF29NyXe2U)

## Description
Are you looking for a command that you used **recently**? Do you
want to  avoid the need to write **long commands** over and over
again? Are you looking for a tool that is able to manage your 
**favorite** commands?

HSTR (**H**i**ST**o**R**y) is a command line utility that brings improved Bash/zsh command completion
from the history. It aims to make completion **easier** and more **efficient**
than <kbd>Ctrl</kbd><kbd>r</kbd>.

HSTR can also **manage** your command history (for instance you can remove
commands that are obsolete or contain a piece of sensitive information) 
or **bookmark** your favorite commands.

Check [video](http://www.youtube.com/watch?v=sPF29NyXe2U) tutorial.


## Installation
Install:

* [Ubuntu](INSTALLATION.md#ubuntu)
* [Fedora](INSTALLATION.md#fedorarhelcentos)
* [Gentoo](INSTALLATION.md#gentoo)
* [CentOS](INSTALLATION.md#fedorarhelcentos)
* [openSUSE](INSTALLATION.md#opensuse)
* [RHEL](INSTALLATION.md#fedorarhelcentos)
* [Debian](INSTALLATION.md#debianmint)
* [Mint](INSTALLATION.md#debianmint)
* [Arch Linux](INSTALLATION.md#arch-linux)
* [Scientific Linux](INSTALLATION.md#fedorarhelcentos)
* [macOS](INSTALLATION.md#macos)

Build:

* [build on any Linux distro](INSTALLATION.md#build-on-any-linux-distro)
* [build snap](INSTALLATION.md#snap)
* [build on Ubuntu](INSTALLATION.md#build-on-ubuntu)
* [build on Debian](INSTALLATION.md#build-on-debian)
* [build on Fedora](INSTALLATION.md#build-on-fedora)
* [build on Windows Subsystem for Linux (WSL)](INSTALLATION.md#build-on-wsl)
* [build on Cygwin](INSTALLATION.md#build-on-cygwin)
* [build on macOS](INSTALLATION.md#build-on-macos)

Tarball:

* [build and install tarball](INSTALLATION.md#build-and-install-tarball)

## Upgrade
If you are HSTR 1.x user, please read about [HSTR 2.x changes](https://github.com/dvorka/hstr/releases/tag/2.0).
## Configuration
Configure HSTR just by running:

```bash
hstr --show-configuration >> ~/.bashrc
```
For detailed HSTR configuration documentation please refer to [Configuration](CONFIGURATION.md).


## Documentation
Check man page:

```bash
man hstr
```

## In the News
Read about HSTR in [LinuxMagazine](http://www.linux-magazine.com/Issues/2014/164/Bash-History-on-Steroids), [UbuntuGeek](http://www.ubuntugeek.com/tag/hstr-bash-history), [DebianAdmin](http://www.debianadmin.com/hstr-easily-view-navigate-search-and-use-your-command-history-with-shell-history.html), [Tuxdiary](https://tuxdiary.com/2015/02/17/hstr/), [Softpedia](http://linux.softpedia.com/get/Terminals/BASH-Command-History-Completion-103155.shtml) and [OSTechNix](https://www.ostechnix.com/hstr-easily-view-navigate-search-manage-commandline-history/).


## Bugs
https://github.com/dvorka/hstr/issues
Significant documentation improvements, fixes and rewrites. 2018-08-12 02:14:46 +08:00			`# HSTR`
Travis CI badge. 2018-08-11 20:42:52 +08:00			`[![Travis CI](https://travis-ci.org/dvorka/hstr.svg?branch=master)](https://travis-ci.org/dvorka/hstr)`
GitHub icons caching on web doesn't work. 2018-07-17 16:59:38 +08:00			`<!--`
Adding badges. 2018-04-27 15:30:08 +08:00			`[![Current release](https://img.shields.io/github/release/dvorka/hstr.svg)](https://github.com/dvorka/hstr/releases)`
			`[![GitHub issues](https://img.shields.io/github/issues/dvorka/hstr.svg?maxAge=360)](https://github.com/dvorka/hstr/issues)`
			`[![All releases downloads](https://img.shields.io/github/downloads/dvorka/hstr/total.svg)](https://github.com/dvorka/hstr/releases)`
GitHub icons caching on web doesn't work. 2018-07-17 16:59:38 +08:00			`-->`
Adding badges. 2018-04-27 15:30:08 +08:00
Update README.md 2018-03-18 01:03:16 +08:00			`Easily view, navigate and search your command history with shell history suggest box for Bash and`
Polishing title page shell names. 2018-08-13 23:24:18 +08:00			`[zsh](CONFIGURATION.md#zsh-history-settings).`
Initial commit 2013-12-03 06:47:51 +08:00
Adding new animated gif w/ scripts which resolves #157 2018-08-27 23:23:10 +08:00			`[![Shell History Suggest Box](doc/hstr-v2.gif "Shell History Suggest Box @ YouTube")](http://www.youtube.com/watch?v=sPF29NyXe2U)`
Source code 2013-12-03 06:55:33 +08:00
Significant documentation improvements, fixes and rewrites. 2018-08-12 02:14:46 +08:00			`## Description`
Highlighting important information in readme. 2014-12-20 17:43:36 +08:00			`Are you looking for a command that you used recently? Do you`
			`want to avoid the need to write long commands over and over`
Update README.md 2018-03-18 01:03:16 +08:00			`again? Are you looking for a tool that is able to manage your`
			`favorite commands?`
Motivation why to use hh added to MD. 2014-04-20 14:00:16 +08:00
HH > HSTR rollback. 2018-08-21 23:31:37 +08:00			`HSTR (HiSToRy) is a command line utility that brings improved Bash/zsh command completion`
Highlighting important information in readme. 2014-12-20 17:43:36 +08:00			`from the history. It aims to make completion easier and more efficient`
Fixing doc keyboard shortcuts description which resolves #288. 2018-08-13 05:37:33 +08:00			`than <kbd>Ctrl</kbd><kbd>r</kbd>.`
Source code 2013-12-03 06:55:33 +08:00
Update README.md 2018-03-18 01:03:16 +08:00			`HSTR can also manage your command history (for instance you can remove`
hh2hstr fixing documentation and manual page #309 2018-08-25 15:40:01 +08:00			`commands that are obsolete or contain a piece of sensitive information)`
			`or bookmark your favorite commands.`
Fixed #62 by merging 'favorites' branch. 2014-04-13 16:02:25 +08:00
Update README.md 2018-03-18 01:03:16 +08:00			`Check [video](http://www.youtube.com/watch?v=sPF29NyXe2U) tutorial.`
Adding screenshot to .md 2013-12-16 15:15:11 +08:00
MD 2014-01-10 08:21:21 +08:00
Significant documentation improvements, fixes and rewrites. 2018-08-12 02:14:46 +08:00			`## Installation`
			`Install:`
Polishing documentation. 2018-08-11 14:37:17 +08:00
Polishing readme. 2015-02-18 13:38:27 +08:00			`* [Ubuntu](INSTALLATION.md#ubuntu)`
Fixing links from the readme to installation MD. 2015-08-31 04:34:51 +08:00			`* [Fedora](INSTALLATION.md#fedorarhelcentos)`
			`* [Gentoo](INSTALLATION.md#gentoo)`
			`* [CentOS](INSTALLATION.md#fedorarhelcentos)`
Update README.md Added openSUSE instalation method (README.md) 2016-01-15 00:21:46 +08:00			`* [openSUSE](INSTALLATION.md#opensuse)`
Fixing links from the readme to installation MD. 2015-08-31 04:34:51 +08:00			`* [RHEL](INSTALLATION.md#fedorarhelcentos)`
Fixed #129 - deletion of history entries - entries are deleted both from system and hh's raw history (in the right order). 2015-02-23 05:03:51 +08:00			`* [Debian](INSTALLATION.md#debianmint)`
			`* [Mint](INSTALLATION.md#debianmint)`
Polishing readme. 2015-02-18 13:38:27 +08:00			`* [Arch Linux](INSTALLATION.md#arch-linux)`
Fixing links from the readme to installation MD. 2015-08-31 04:34:51 +08:00			`* [Scientific Linux](INSTALLATION.md#fedorarhelcentos)`
Making title conventions consistent. 2018-08-11 14:48:25 +08:00			`* [macOS](INSTALLATION.md#macos)`
MD and man 2014-01-17 11:46:12 +08:00
Significant documentation improvements, fixes and rewrites. 2018-08-12 02:14:46 +08:00			`Build:`
MD and man 2014-01-17 11:46:12 +08:00
Significant documentation improvements, fixes and rewrites. 2018-08-12 02:14:46 +08:00			`* [build on any Linux distro](INSTALLATION.md#build-on-any-linux-distro)`
Adding snap to documentation and improving build scripts. 2018-08-13 06:09:10 +08:00			`* [build snap](INSTALLATION.md#snap)`
Significant documentation improvements, fixes and rewrites. 2018-08-12 02:14:46 +08:00			`* [build on Ubuntu](INSTALLATION.md#build-on-ubuntu)`
			`* [build on Debian](INSTALLATION.md#build-on-debian)`
			`* [build on Fedora](INSTALLATION.md#build-on-fedora)`
Update README.md 2018-08-12 05:36:07 +08:00			`* [build on Windows Subsystem for Linux (WSL)](INSTALLATION.md#build-on-wsl)`
Significant documentation improvements, fixes and rewrites. 2018-08-12 02:14:46 +08:00			`* [build on Cygwin](INSTALLATION.md#build-on-cygwin)`
hh2hstr fixing documentation and manual page #309 2018-08-25 15:40:01 +08:00			`* [build on macOS](INSTALLATION.md#build-on-macos)`
Significant documentation improvements, fixes and rewrites. 2018-08-12 02:14:46 +08:00
			`Tarball:`

			`* [build and install tarball](INSTALLATION.md#build-and-install-tarball)`

Adding 1.x to 2.x info. 2018-08-26 23:53:25 +08:00			`## Upgrade`
			`If you are HSTR 1.x user, please read about [HSTR 2.x changes](https://github.com/dvorka/hstr/releases/tag/2.0).`
Significant documentation improvements, fixes and rewrites. 2018-08-12 02:14:46 +08:00			`## Configuration`
It's better to configure HSTR rather than not and asking... 2018-08-14 12:41:34 +08:00			`Configure HSTR just by running:`
hh2hstr fixing documentation and manual page #309 2018-08-25 15:40:01 +08:00
MD Shell > bash highlighting 2014-01-27 02:30:09 +08:00			```bash
hh2hstr fixing documentation and manual page #309 2018-08-25 15:40:01 +08:00			`hstr --show-configuration >> ~/.bashrc`
MD 2014-01-27 01:27:28 +08:00			```
hh2hstr fixing documentation and manual page #309 2018-08-25 15:40:01 +08:00			`For detailed HSTR configuration documentation please refer to [Configuration](CONFIGURATION.md).`
Adding Mac howto to MD (credits goess to Alex) 2014-01-13 14:23:02 +08:00

Significant documentation improvements, fixes and rewrites. 2018-08-12 02:14:46 +08:00			`## Documentation`
hh2hstr fixing documentation and manual page #309 2018-08-25 15:40:01 +08:00			`Check man page:`
Significant documentation improvements, fixes and rewrites. 2018-08-12 02:14:46 +08:00
Improving man page and MD (env var options). 2014-02-01 02:46:18 +08:00			```bash
hh2hstr fixing documentation and manual page #309 2018-08-25 15:40:01 +08:00			`man hstr`
MD 2014-01-27 01:27:28 +08:00			```
MD 2014-01-27 01:14:47 +08:00
Significant documentation improvements, fixes and rewrites. 2018-08-12 02:14:46 +08:00			`## In the News`
hh2hstr fixing documentation and manual page #309 2018-08-25 15:40:01 +08:00			Read about HSTR in [LinuxMagazine](http://www.linux-magazine.com/Issues/2014/164/Bash-History-on-Steroids), [UbuntuGeek](http://www.ubuntugeek.com/tag/hstr-bash-history), [DebianAdmin](http://www.debianadmin.com/hstr-easily-view-navigate-search-and-use-your-command-history-with-shell-history.html), [Tuxdiary](https://tuxdiary.com/2015/02/17/hstr/), [Softpedia](http://linux.softpedia.com/get/Terminals/BASH-Command-History-Completion-103155.shtml) and [OSTechNix](https://www.ostechnix.com/hstr-easily-view-navigate-search-manage-commandline-history/).
Update README.md 2016-11-01 16:30:00 +08:00
MD 2014-01-27 01:14:47 +08:00
Significant documentation improvements, fixes and rewrites. 2018-08-12 02:14:46 +08:00			`## Bugs`
Changing download address. 2013-12-03 15:54:19 +08:00			`https://github.com/dvorka/hstr/issues`