Skip to content

Commit

Permalink
Update text showed after installation
Browse files Browse the repository at this point in the history
  • Loading branch information
curusarn committed Feb 18, 2020
1 parent 61018e1 commit bbfc036
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 60 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,19 +73,6 @@ Imagine being able to search your shell history based on both the command itself

- :heavy_check_mark: Provide a tool to sanitize the recorded history

## Data sanitization and analysis

In order to be able to develop a good history tool I will need to get some insight into real life shell and shell history usage patterns.

This project is also my Master thesis so I need to be a bit scientific and base my design decisions on evidence/data.

Running `reshctl sanitize` creates a sanitized version of recorded history.
In sanitized history, all sensitive information is replaced with its SHA1 hashes.

If you tried sanitizing your history and you think the result is not sanitized enough then please create an issue or message me.

If you would consider supporting my research/thesis by sending me a sanitized version of your history then please give me some contact info using this form: https://forms.gle/227SoyJ5c2iteKt98

## Prereqisities

Standard stuff: `bash`, `curl`, `tar`, ...
Expand All @@ -109,6 +96,19 @@ curl -fsSL https://raw.githubusercontent.com/curusarn/resh/master/scripts/rawins
1. Run `git clone https://github.com/curusarn/resh.git && cd resh`
2. Run `scripts/rawinstall.sh`

## Data sanitization and analysis

In order to be able to develop a good history tool I will need to get some insight into real life shell and shell history usage patterns.

This project is also my Master thesis so I need to be a bit scientific and base my design decisions on evidence/data.

Running `reshctl sanitize` creates a sanitized version of recorded history.
In sanitized history, all sensitive information is replaced with its SHA1 hashes.

If you tried sanitizing your history and you think the result is not sanitized enough then please create an issue or message me.

If you would consider supporting my research/thesis by sending me a sanitized version of your history then please give me some contact info using this form: https://forms.gle/227SoyJ5c2iteKt98

## Examples

### Update
Expand Down
70 changes: 23 additions & 47 deletions scripts/install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -179,63 +179,36 @@ echo "
# #
##########################################################
WARNING
It's recommended to RESTART all open terminal windows
HISTORY
Your resh history will be recorded to '~/.resh_history.json'
Look at it using e.g. following command (you might need to install jq)
$ tail -f ~/.resh_history.json | jq
Your resh history will be recorded to '~/.resh_history.json'
Look at it using e.g. following command (you might need to install jq)
$ tail -f ~/.resh_history.json | jq
Your default shell history will stay intact.
Your default shell history will stay intact.
SANITIZATION
In sanitized history, all sensitive information is replaced with its SHA1 hashes
$ reshctl sanitize
In sanitized history, all sensitive information is replaced with its SHA256 hashes.
To get a sanitized version of your shell history run:
$ reshctl sanitize
If you would consider supporting my research/thesis by giving me a sanitized version of your history then
please give me some contact info using this form: https://forms.gle/227SoyJ5c2iteKt98
If you would consider supporting my research/thesis by giving me a sanitized version of your history then
please give me some contact info using this form: https://forms.gle/227SoyJ5c2iteKt98
ARROW KEY BINDINGS
Resh provides arrow key bindings.
These bindings do regular stepping through history and prefix search.
They allow resh to record bindings usage metadata.
* Enabled by default in zsh
* Disabled by default in bash
Enable/disable for THIS shell session
$ reshctl enable arrow_key_bindings
$ reshctl disable arrow_key_bindings
Enable/disable for FUTURE shell sessions
$ reshctl enable arrow_key_bindings_global
$ reshctl disable arrow_key_bindings_global
See what your current setting is
$ reshctl status
COMPLETIONS
Zsh and bash completions for 'reshctl' command were installed and should be working.
GRAPHS
You can get some graphs of your history by running
$ <coming soon>
CHECK FOR UPDATES
$ reshctl update
Regular stepping through history and prefix search. There might be more features in the future.
They are enabled by default in zsh (and disabled in bash).
Enable/disable them using reshctl command:
$ reshctl enable ... / reshctl disable ...
RESH CLI - SEARCH THE RECORDED HISTORY
RESH CLI searches your history by commands and directories.
Directories are not in regular shell history. Because of that RESH CLI will only search shell history recorded by this project.
This means that you should keep this project and try out RESH CLI in a month or so.
This means that you can enable RESH CLI now and use it as your history grows or you can wait for a little bit.
Please remember that RESH CLI is still an early prototype.
RESH CLI tool can be bound to ctrl+R or executed directly.
* RESH CLI is not bound to ctrl+R by default
RESH CLI tool can be bound to ctrl+R (recommended) or executed directly.
Enable/disable ctrl+R binding for THIS shell session:
$ reshctl enable ctrl_r_binding
Expand All @@ -247,11 +220,14 @@ echo "
Run the RESH CLI tool as a one-off:
$ resh
CHECK FOR UPDATES
To check for (and install) updates use:
$ reshctl update
WARNING
It's recommended to RESTART all open terminal windows
ISSUES
Please report issues to: https://github.com/curusarn/resh/issues
UNINSTALL
You can uninstall resh at any time by running
$ rm -rf ~/.resh/
Please report issues to: https://github.com/curusarn/resh/issues
"

0 comments on commit bbfc036

Please sign in to comment.