From bbfc036223c5a7e0c4dcff0001e2bb49a9f4c74b Mon Sep 17 00:00:00 2001 From: Simon Let Date: Tue, 18 Feb 2020 20:41:50 +0100 Subject: [PATCH] Update text showed after installation --- README.md | 26 ++++++++--------- scripts/install.sh | 70 +++++++++++++++------------------------------- 2 files changed, 36 insertions(+), 60 deletions(-) diff --git a/README.md b/README.md index 5fca89b..8fdcb0d 100644 --- a/README.md +++ b/README.md @@ -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`, ... @@ -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 diff --git a/scripts/install.sh b/scripts/install.sh index c58f676..3f3cc1e 100755 --- a/scripts/install.sh +++ b/scripts/install.sh @@ -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 - $ - - 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 @@ -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 " \ No newline at end of file