mirror of https://github.com/ddworken/hishtory.git synced 2024-11-22 16:24:00 +01:00

Your shell history: synced, queryable, and in context

Go to file

David Dworken b92087fc1d Try again to fix timezone test		2022-04-09 12:57:58 -07:00
.github/workflows	fix hardcoded username in tests + another attempt at enabling bash job control + test that building docker containers works	2022-04-09 12:19:01 -07:00
backend	Try again to fix timezone test	2022-04-09 12:57:58 -07:00
client	Try again to fix timezone test	2022-04-09 12:57:58 -07:00
scripts	another attempt at ldflags	2022-04-08 22:45:49 -07:00
server	Moved all backend code into the backend/ directory	2022-04-08 23:56:02 -07:00
shared	change tests to not hardcode the local path to source on my laptop	2022-04-09 11:55:00 -07:00
.dockerignore	Website landing page, install instructions, update command, status command, set up postgres, and fixing broken tests	2022-03-29 21:56:28 -07:00
.errcheck_excludes.txt	pre-commit + stricter formatting + pre-commit fixes	2022-04-07 21:40:22 -07:00
.gitignore	moved client/client.go to hishtory.go to support slsa l3 border	2022-04-08 21:17:11 -07:00
.pre-commit-config.yaml	Mention SLSA on the landing page	2022-04-09 00:25:09 -07:00
.slsa-goreleaser.yml	Added SLSA builder	2022-04-08 20:59:24 -07:00
go.mod	Website landing page, install instructions, update command, status command, set up postgres, and fixing broken tests	2022-03-29 21:56:28 -07:00
go.sum	Website landing page, install instructions, update command, status command, set up postgres, and fixing broken tests	2022-03-29 21:56:28 -07:00
hishtory.go	trying again with ldflags + fixed update url	2022-04-08 22:56:44 -07:00
Makefile	Moved all backend code into the backend/ directory	2022-04-08 23:56:02 -07:00
README.md	Starting on the readme + replace bash with shell in website	2022-04-09 11:40:15 -07:00
VERSION	Bump hishtory version	2022-04-08 23:09:00 -07:00

README.md

hishtory: Better Shell Hishtory

hishtory is a CLI tool to better manage your shell history. It hooks into your shell to store the commands you run along with metadata about those commands (what directory you ran it in, whether it succeeded or failed, how long it took, etc). This is all stored in a local SQLite DB, and then e2e encrypted while synced to local SQLite DBs running on 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.

hishtory is written in Go and uses AES-GCM for end-to-end encrypting your hishtory 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.

Getting Started

To install hishtory on your first machine:

curl -L -o hishtory https://api.hishtory.dev/download/hishtory-linux-amd64
# Optional: Verify the binarie's SLSA L3 attestations from https://api.hishtory.dev/download/hishtory-linux-amd64.intoto.jsonl
chmod +x hishtory
./hishtory install

At this point, hishtory is already persisting your shell history. 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 -L -o hishtory https://api.hishtory.dev/download/hishtory-linux-amd64
# Optional: Verify the binarie's SLSA L3 attestations from https://api.hishtory.dev/download/hishtory-linux-amd64.intoto.jsonl
chmod +x hishtory
./hishtory install $SECRET_KEY

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

README.md

hishtory: Better Shell Hishtory

Getting Started

Features

Advanced Queries

Export

Enable/Disable

update

Design

CLI

Syncing

Security

Pending Features