xontrib-log-all-history 1.0.0

History logger for xonsh

xontrib log_all_history

xonsh history logger

log_all_history persists all shell history in $HOME/.logs while also supporting both the JsonHistory and SqliteHistory backends.

• xontrib log_all_history
  • Install
  • Architecture
  • Searching History
    • hgrep -- "H"istory "Grep"
    • hgrep -- "H"istory in this "D"irectory "Grep"
  • Optional Configuration

Install

Install using pip

pip install xontrib-log_all_history

Add to your .xonshrc as follows:

xontrib load log_all_history

:warning: If you using SqliteHistory backend, you must include $XONSH_HISTORY_BACKEND = 'sqlite' before loading. For example:

$XONSH_HISTORY_BACKEND = 'sqlite'
xontrib load 'log-all-history'

Architecture

This plugin intercepts history before sending to the JsonHistory or SqliteHistory backend. In short:

• Take the current command line and append to a history named: $HOME/.logs/$PWD/xonsh-history-{DateTime}.log
• For example:

 ~/P/P/x/xontrib-log-all-history  cat README.md > /dev/null
 ~/P/P/x/xontrib-log-all-history  tail $LOG_ALL_HISTORY_FILE
2022-03-11.21.17.01 cat README.md > /dev/null
 ~/P/P/x/xontrib-log-all-history 

I've been using this method since October in 2019 (both in bash and now xonsh). Here's stats on my logs directory:

 ~/P/P/x/xontrib-log-all-history  du -sh ~/.logs
16M     /home/mcrowe/.logs
 ~/P/P/x/xontrib-log-all-history  egrep '^201' ~/.logs -Rh | cut -b -7 | sort | uniq | head -n 1
2019-10
 ~/P/P/x/xontrib-log-all-history  find ~/.logs | wc -l
3645
 ~/P/P/x/xontrib-log-all-history 

Searching History

Two helper aliases are enabled to assist in searching your accumulated history:

hgrep -- "H"istory "Grep"

This command is simply grep -ERh {SEARCH_STRING} $HOME/.logs -- it searches all folders.

hgrep -- "H"istory in this "D"irectory "Grep"

This command is simply grep -ERh {SEARCH_STRING} $HOME/.logs/$PWD -- it searches all logs you've done in this specific directory. The use-case for this is:

• You use the python command frequently
• You remember using a python command in the past for the current project with a lot of parameters you figured out, but you didn't save it.
  • If you did hgrep python, you'd find many entries.
  • By using hdgrep python, you find the specific command.

Example:

 ~/P/P/x/xontrib-log-all-history  hgrep cat | wc -l
1427
 ~/P/P/x/xontrib-log-all-history  hdgrep cat | wc -l
10
 ~/P/P/x/xontrib-log-all-history 

(yes, I did several cats testing for the readme...)

Optional Configuration

If you want to place to the logs in a different folder, set:

$LOG_ALL_HISTORY_DIR = f"{$HOME}/.all-logs"
xontrib load 'log-all-history'