crtxcr/hs9001
1
0
Fork 0
mirror of https://github.com/quitesimpleorg/hs9001.git synced 2024-11-22 09:47:51 +01:00
Code Issues Projects Releases Wiki Activity

Improve README.md

Browse Source
This commit is contained in:
Albert S. 2021-08-08 13:22:08 +02:00
parent bb2450b8ec
commit 1a6c75cea9
2 changed files with 34 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -2,15 +2,33 @@
hs9001 (history search 9001) is an easy, quite simple bash history enhancement. It simply writes all hs9001 (history search 9001) is an easy, quite simple bash history enhancement. It simply writes all
your bash commands into an sqlite database. You can then search this database. your bash commands into an sqlite database. You can then search this database.
It improves over bash's built-in history mechanism as it'll aggregate the shell history of all open shells,
timestamp them and also record additional information such as the directory a command was executed in.
## Usage / Examples
### Search
```
hs [search terms]
```
You can further filter with options like `-cwd`, `-after` and so on...
For a full list, see `-help`.
```
hs -cwd .
```
Lists all commands ever entered in this directory
```
hs -after yesterday -cwd . git
```
Lists all git commands in the current directory which have been entered today.
Also, it (by default) replaces bash's built-in CTRL-R mechanism, so hs9001's database will be used instead
of bash's limited history files.
## Install ## Install
### From source
```
go build
#move hs9001 to a PATH location
```
### Debian / Ubuntu ### Debian / Ubuntu
Latest release can be installed using apt Latest release can be installed using apt
``` ```
@ -28,31 +46,26 @@ apk update
apk add hs9001 apk add hs9001
``` ```
### From source
```
go build
#move hs9001 to a PATH location
```
### Setup / Config ## Setup / Config
Add this to .bashrc Add this to .bashrc
``` ```
eval "$(hs9001 bash-enable)" eval "$(hs9001 bash-enable)"
``` ```
This will also create a `hs`alias so you have to type less in everyday usage.
By default, every system user gets his own database. You can override this by setting the environment variable By default, every system user gets his own database. You can override this by setting the environment variable
for all users that should write to your unified database. for all users that should write to your unified database.
``` ```
export HS9001_DB_PATH="/home/db/history.sqlite" export HS9001_DB_PATH="/home/db/history.sqlite"
``` ```
## Usage
### Search
```
hs9001 search [search terms]
```
It is recommended to create an alias for search to make life easier, e. g.:
```
alias searchh='hs9001 search'
```

1
main.go
View File

@ -309,6 +309,7 @@ func main() {
PROMPT_COMMAND='hs9001 add -ret $? "$(history 1)"' PROMPT_COMMAND='hs9001 add -ret $? "$(history 1)"'
bind -x '"\C-r": " READLINE_LINE=$(hs9001 bash-ctrlr 3>&1 1>&2 2>&3) READLINE_POINT=0"' bind -x '"\C-r": " READLINE_LINE=$(hs9001 bash-ctrlr 3>&1 1>&2 2>&3) READLINE_POINT=0"'
fi fi
alias hs='hs9001 search'
`) `)
case "bash-disable": case "bash-disable":
fmt.Printf("unset PROMPT_COMMAND\n") fmt.Printf("unset PROMPT_COMMAND\n")