This script generates a report against your command-line history and suggests workflow improvements.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
img fix screenshot Jan 12, 2019
test add a few more commands to example histories Jan 26, 2019
.gitignore Added gitignore for python and macos Jan 13, 2019
.travis.yml add simple unit tests Jan 26, 2019
LICENSE Initial commit Dec 28, 2018
Makefile add simple unit tests Jan 26, 2019
README.org run travis against "real" examples; upd README Jan 19, 2019
command_line_lint.py ignore pylint re: distutils Jan 19, 2019

README.org

Command-Line Lint

https://travis-ci.org/riscy/command_line_lint.svg?branch=master

img/report_card.png

Description

This script generates a report against your command-line history and suggests workflow improvements. Its opinion is that most commands should be simple and require minimal typing. The report contains:

  • comprehensive lists of commands you use, with and without arguments
  • suggestions for ways to shorten commands (aliases, alternative syntax)
  • a subset of lints from Shellcheck, if installed; many of these can warn against dangerous habits

The script does not use the network, and it doesn’t move or store your command history anywhere. It should be fairly portable, running on Python 2.7 or 3.4+ and requiring “only” the standard library.

This is an early prototype and primarily supports bash, sh, and zsh.

img/screenshot.png

Run

Download command_line_lint.py and run it:

python command_line_lint.py <history_file>  # python 2 or 3 is fine

The <history_file> argument is optional. If omitted, a determination is made based on the value of the SHELL environment variable:

  • bash uses .bash_history
  • csh and tcsh use .history
  • zsh uses the value of HISTFILE

Not all shells have support for saving a history file (fish, dash, etc.)

Configure

Command-Line Lint gives better results when the following hold (it will tell you about these, too):

  • The HISTSIZE environment variable should be large enough to produce useful usage summaries. The defaults tend to be too small – try 5000.
  • Retaining duplicate entries is important for being able to determine what you do the most, so variables/options like bash’s HISTCONTROL or zsh’s histignorealldups should be set appropriately.
  • If you use bash, shopt histappend should be set so that multiple concurrent shell sessions can all add to your .bash_history. If you use zsh, setopt appendhistory should be set likewise.

If you’re linting a history file that comes from a different shell than the one you’re using, you can let the script know. For example, .history comes from a zsh session but you’re using bash, you can write:

SHELL=zsh python command_line_lint.py /path/to/.zsh_history

This script supports the use of NO_COLOR to disable color output:

NO_COLOR=1 python command_line_lint.py

Future

Because those who do not learn from history are doomed to !!, additional reporting around some of the following would be useful:

  • Command fingerprinting to sort out common typos (shopt dirspell, if it exists, can be used to fix typos in cd)
  • Security checks in addition to readability of history file (for example warnings about plaintext passwords, etc.)
  • Analyzing sequences of commands for improvements (e.g., sometimes dry-running a command like rm -rf ./* with ls ./* is a good idea; switching back and forth between directories can use cd - and switching back and forth between git branches can use git checkout -; etc.)