curusarn / resh

RESH ❯❯ Contextual shell history for zsh and bash

RESH

Context-based replacement for zsh and bash shell history.

Full-text search your shell history.
Relevant results are displayed first based on current directory, git repo, and exit status.

Install

Install RESH with one command:

curl -fsSL https://raw.githubusercontent.com/curusarn/resh/master/scripts/rawinstall.sh | bash

ℹ️ You will need to have bash, curl, and tar installed.

More options on Installation page ⇗

Search your history

Press Ctrl + R to search:

In-app key bindings

• Type to search
• Up / Down or Ctrl + P / Ctrl + N to select results
• Enter to execute selected command
• Right to paste selected command onto the command line so you can edit it before execution
• Ctrl + C or Ctrl + D to quit
• Ctrl + G to abort and paste the current query onto the command line
• Ctrl + R to search without context (toggle)

Issues & ideas

Find help on Troubleshooting page ⇗

Problem persists? Create an issue ⇗

resh's Issues

Check for updates automatically at the start of the first terminal session

• Oh-my-zsh does it like this

• This will lead to higher reliability because daemon is not running yet (no restart needed etc...)

Can we assume: "daemon is not running" => "first session of the day"

This could cause problems -> we should have a ~/.resh/last_update_check.touch AND a checking interval (CheckForUpdatesEveryNDays) in settings.

When I recall very fast in the first terminal I open it breaks recalling until I run a command

I trigger a recall which fails and breaks the state of the terminal session until running a command and redrawing the prompt resets the state which fixes the temporary issue

auto-backup history file

recall actions sanitization

recall actions contain parts of commands - potentially whole commandlines

Man pages

https://github.com/spf13/cobra/blob/master/doc/man_docs.md

Add "How to install" to readme

go version 2>/dev/null || echo please install go

if go version >= 1.11: build & install

else:
please install go-dep; then do dep init, build & install

make resh-daemon launch silent in zsh

like this:
https://superuser.com/questions/1228411/silent-background-jobs-in-zsh

Control+C creates another record for previous command

exitcode is 130

.resh/util.sh: line 64: syntax error in conditional expression: unexpected token `('

It looks like there is a small issue in the final step of the installation on MacOS.

curl -fsSL https://raw.githubusercontent.com/curusarn/resh/master/scripts/rawinstall.sh | bash

Please report any issues you encounter to: https://github.com/curusarn/resh/issues

Looking for the latest release ...
 * Latest version: 2.4.10 (git tag: v2.4.10)

Downloading files ...
 * resh_2.4.10_checksums.txt
######################################################################### 100.0%
 * resh_2.4.10_darwin_amd64.tar.gz
######################################################################### 100.0%

Checking integrity ...
 * OK

Extracting downloaded files ...
 * OK

Checking your system ...
 * Login shell: zsh - OK
 * Bash version: 3.2.57(1)-release - OK
 * Zsh version: 5.7.1 - OK
 * Nohup installed: OK

Creating directories ...
Copying files ...
Generating completions ...
Copying more files ...
Finishing up ...
/Users/vit.listik/.resh/util.sh: line 64: syntax error in conditional expression: unexpected token `('

INSTALLATION FAILED!
I'm sorry for the inconvenience.

Please create an issue: https://github.com/curusarn/resh/issues

You can rerun the installation by executing: (this will skip downloading)

cd /tmp/resh-rawinstall-Kwh && scripts/install.sh

RESH INFO: New RESH shellrc script was loaded - if you encounter any issues please restart this terminal session.

Update readme

write about new features, about sanitization, about reshctl

Load regular history when there is no ~/.resh_history

The way we check bash version during installation might not work in older bash versions

Investigate

Use `sh` for installation?

switch from sha1 to something better

https://sha-mbles.github.io/

Use flock to create the lock file

Inspiration for resh cli

This issue serves as a collection of other tools that provide advanced search capabilities and do so in ways that can be used as an inspiration for resh cli.

Resulting design deciosions: #66

remove $WINDOWID

• is set by xterm, termite, ... ?
• we don't want to rely on terminal specific stuff
• I can just generate my own session id

Add a timeout for command-line hooks

If resh-collect or resh-postcollect hangs you are not going to have a good time.
We need to have a timeout for anything we run.

Handle signals

I'm thinking:

1. trap SIGTERM
2. go die after a certain timeout
3. broadcast shutdown request via special shutdown channels
4. every component:
   1. gets the message
   2. does cleanup
   3. sends back message using the shutdown channel
5. wait for a message from each component using shutdown channels
6. die

use standard bash library for rawinstall

https://install.goreleaser.com/github.com/goreleaser/goreleaser.sh

Check if people have bash completion because not having it can produce errors

Linux: /usr/share/bash-completion/bash_completion

macOS: ?

Add update to reshctl

Updates are currently done by running make install in the cloned repository.

Use reshctl update instead.

No license information

Hey. I wonder if your project is free software. What license is it distributed under?

Does sesswatch watch *all* the sessions?

Is there a way to init a session in some part of the app without it being watched by sesswatch?
This could lead to increased memory use over time.

separate user config and default config

vim mode bindings

Usage data sanitization

My idea is to replace sensitive info with placeholders.

It's important to make sure that the same piece of information is always replaced with the same placeholder.

Replace sensitive info with hashes.

Test without the bash option that squashes multi-line commands to a single history record

This might break some of the metadata or even the recording of the "command" to history

Use unix domain socket

Problem is that http.ListenAndServe doesn't support unix sockets.

Add custom widgets for arrow-{up,down}

• Track which commands are actually being recalled from history
• Offer better recall strategy

Use https://github.com/curusarn/bash-zsh-compat-widgets

bash-preexec and `bind -x` widgets don't like each other

bind -x causes bash-preexec to run when it's not supposed to.

I added some nasty hack to work around it but I would like to solve it properly.

That said I'm really not sure if it's even possible. Bash is being super difficult to work with.

setsid is not available on macOS

temporary solution: use nohup instead

future solution: compile and bundle setsid with resh

Tests

• Zsh compatibility test
• Installation test

installation doesn't work on macOS

A: You have to add [ -f ~/.bashrc ] && . ~/.bashrc to your ~/.bash_profile.

Long Answer: Under macOS bash shell only loads ~/.bash_profile because every shell runs as login shell. I will definitely work around this in the future but since this doesn't affect many people I decided to not solve this issue at the moment.

GNU date is required

Check for GNU date during installation

check if the history loading works properly, fix deduplication

• history file gets loaded into histfile
• histfile appends commands as they are written to history file
• histsess initializes itself using commands from histfile

In the end sesshist contains a sequence of persisted commands, recent commands, and session commands.

I just hacked it together so I never really checked if it really works as it's supposed to.

Also deduplication doesn't work across the 3 sections mentioned above.

Is `&>` a "new" bash feature?

replace JSON with some other format for requests

JSON (un)marshaling takes too long

use another format - most likely binary one

Add a screenshot of sanitized history to readme

Create a hstr-like tool

See if you can fork this: https://github.com/knqyf263/pet

OS X support

GNU vs BSD

• I tried to avoid GNU specific stuff
• It should be fine

os release

• There is no /etc/os-release on OS X
• sw_vers https://ss64.com/osx/sw_vers.html

% sw_vers
ProductName:	Mac OS X
ProductVersion:	10.12.6
BuildVersion:	16G1815

• use uname to get Linux or Darwin

Empty commands are interpreted as errors

There should be no empty commands but when they somehow appear they break recall

Use exit status as an indication of error

Bash completions

Bash completions are a prerequisite

Old versions of dependencies

What are the oldest versions of our dependencies are being shipped with popular OS's?

OS	golang	bash	zsh
macOS (Mojave)	N/A	3.2.57	5.3
macOS (Catalina)	N/A	3.2.57	5.7.1
Ubuntu LTS 16.04 (Xenial)	1.6.2 (1.10 via backports)	4.3	5.1.1
Ubuntu LTS 18.04 (Bionic)	1.10.1	4.4	5.4.2
Debian Stretch (oldstable)	1.7.4	4.4	5.3.1
Debian Buster (stable)	1.11.6	5.0	5.7.1

Oldest golang: 1.10 (Xenial)
Oldest bash: 3.2.57 (macOS)
Oldest zsh: 5.1.1 (Xenial)

go dependencies

• go modules only work for go>1.11
• ???

Commented out commands are not being recorded

reshctl status shows ugly errors when daemon is not running

histno lag fix blocks more terminal queries when used with prefixes

reset the histno block every time the prefix changes

Add a kill-switch keybinding

kills & restarts daemon

Update example section in readme