hiSHtory: Better Shell History

hishtory is a better shell history. It stores your shell history in context (what directory you ran the command in, whether it succeeded or failed, how long it took, etc). This is all stored locally and end-to-end encrypted for syncing to to all your other computers. All of this is easily queryable via the hishtory CLI. This means from your laptop, you can easily find that complex bash pipeline you wrote on your server, and see the context in which you ran it.

Getting Started

To install hishtory on your first machine:

curl https://hishtory.dev/install.py | python3 -

At this point, hishtory is already managing your shell history (for bash, zsh, and fish!). Give it a try with hishtory query and see below for more details on the advanced query features.

Then to install hishtory on your other computers, you need your secret key. Get this by running hishtory status. Once you have it, you follow similar steps to install hiSHtory on your other computers:

curl https://hishtory.dev/install.py | python3 -
hishtory init $YOUR_HISHTORY_SECRET

Now if you run hishtory query on first computer, you can automatically see the commands you've run on all your other computers!

Features

Querying

There are two ways to interact with hiSHtory.

Via pressing Control+R in your terminal. Search for a command, select it via Enter, and then have it ready to execute in your terminal's buffer.
Via hishtory query if you just want to explore your shell history.

Both support the same query format, see the below annotated queries:

Query	Explanation
`psql`	Find all commands containing `psql`
`psql db.example.com`	Find all commands containing `psql` and `db.example.com`
`docker hostname:my-server`	Find all commands containing `docker` that were run on the computer with hostname `my-server`
`nano user:root`	Find all commands containing `nano` that were run as `root`
`exit_code:127`	Find all commands that exited with code `127`
`service before:2022-02-01`	Find all commands containing `service` run before February 1st 2022
`service after:2022-02-01`	Find all commands containing `service` run after February 1st 2022

For true power users, you can even query in SQLite via sqlite3 ~/.hishtory/.hishtory.db.

Enable/Disable

If you want to temporarily turn on/off hiSHtory recording, you can do so via hishtory disable (to turn off recording) and hishtory enable (to turn on recording). You can check whether or not hishtory is enabled via hishtory status.

Deletion

hishtory redact can be used to delete history entries that you didn't intend to record. It accepts the same search format as hishtory query. For example, to delete all history entries containing psql, run hishtory redact psql.

Updating

To update hishtory to the latest version, just run hishtory update to securely download and apply the latest update.

Advanced Features

Changing the displayed columns

You can customize the columns that are displayed via hishtory config-set displayed-columns. For example, to display only the cwd and command:

hishtory config-set displayed-columns CWD Command

Custom Columns

You can create custom column definitions that are populated from arbitrary commands. For example, if you want to create a new column named git_remote that contains the git remote if the cwd is in a git directory, you can run:

hishtory config-add custom-column git_remote '(git remote -v 2>/dev/null | grep origin 1>/dev/null ) && git remote get-url origin || true'
hishtory config-add displayed-columns git_remote

Disabling Control-R integration

If you'd like to disable the control-R integration in your shell, you can do so by running `hishtory config-set enable-control-r false`.

Uninstalling

If you'd like to uninstall hishtory, just run `hishtory uninstall`. Note that this deletes the SQLite DB storing your history, so consider running a `hishtory export` first.

Design

The hishtory CLI is written in Go. It hooks into the shell in order to track information about all commands that are run. It takes this data and saves it in a local SQLite DB managed via GORM. This data is then encrypted and sent to your other devices through a backend that essentially functions as a one-to-many queue. When you run hishtory query, a SQL query is run to find matching entries in the local SQLite DB.

Syncing Design

See hiSHtory: Cross-device Encrypted Syncing Design to learn how syncing works.

Security

hishtory is a CLI tool written in Go and uses AES-GCM for end-to-end encrypting your history entries while syncing them. The binary is reproducibly built and SLSA Level 3 to make it easy to verify you're getting the code contained in this repository.

This all ensures that the minimalist backend cannot read your shell history, it only sees encrypted data.

If you find any security issues in hiSHtory, please reach out to david@daviddworken.com.

5.3 KiB Raw Blame History