2 stable releases

2.1.0 Jul 4, 2022
2.0.1 Oct 5, 2021

#872 in Database interfaces

Download history 5/week @ 2023-11-05 5/week @ 2023-11-12 1/week @ 2023-11-19 11/week @ 2023-11-26 2/week @ 2023-12-03 2/week @ 2023-12-17 5/week @ 2023-12-24 2/week @ 2023-12-31 5/week @ 2024-01-07 2/week @ 2024-01-14 2/week @ 2024-01-21 5/week @ 2024-01-28 3/week @ 2024-02-04 9/week @ 2024-02-11 41/week @ 2024-02-18

58 downloads per month

MIT license

73KB
2K SLoC

hstdb

Build Status crates.io

Better history management for zsh. Based on ideas from https://github.com/larkery/zsh-histdb.

Licensed under MIT.

It was mainly written because the sqlite merging broke a few to many times for me and using a sqlite database seemed overkill.

The tool is just writing CSV files for each host which makes syncing them via git pretty painless.

Has pretty much the same feature set as zsh-histdb:

  • Start and stop time of the command
  • Working directory in which the command was run
  • Hostname of the machine the command was run in
  • Unique session ids based on UUIDs
  • Exit status of the command
  • Import from zsh histfile and zsh-histdb sqlite database

Installation

You can either install the right binary from the releases page or run:

cargo install hstdb

Archlinux

Install from the aur: https://aur.archlinux.org/packages/hstdb/

First Start

After you installed hstdb you need to start the server:

hstdb server

By default the server will run in the foreground.

To stop the server you can run the following:

hstdb stop

Or send SIGTERM/SIGINT (Ctrl+C) to stop the server.

You can also use the systemd unit file in hstdb.service which you can copy to "$HOME/.config/systemd and enable/start with the following:

systemctl --user daemon-reload
systemctl --user enable hstdb.service
systemctl --user start hstdb.service

After that you can add the following to your .zshrc to enable hstdb for you shell.

eval "$(hstdb init)"

You can run that in your current shell to enable hstdb or restart your shell.

Usage

Help output of default command:

hstdb 2.0.0

USAGE:
    hstdb [FLAGS] [OPTIONS] [SUBCOMMAND]

FLAGS:
        --all-hosts
            Print all hosts

        --disable-formatting
            Disable fancy formatting

        --filter-failed
            Filter out failed commands (return code not 0)

    -h, --help
            Prints help information

        --hide-header
            Disable printing of header

    -i, --in
            Only print entries that have been executed in the current directory

        --no-subdirs
            Exclude subdirectories when filtering by folder

        --show-duration
            Show how long the command ran

        --show-host
            Print host column

        --show-pwd
            Show directory in which the command was run

        --show-session
            Show session id for command

        --show-status
            Print returncode of command

    -V, --version
            Prints version information


OPTIONS:
    -c, --command <command>
            Only print entries beginning with the given command

    -t, --text <command-text>
            Only print entries containing the given regex

        --config-path <config-path>
            Path to the socket for communication with the server [env: HISTDBRS_CONFIG_PATH=]  [default:
            /home/athaller/.config/hstdb/config.toml]
    -d, --data-dir <data-dir>
            Path to folder in which to store the history files [default: /home/athaller/.local/share/hstdb]

    -e, --entries-count <entries-count>
            How many entries to print [default: 25]

        --find-status <find-status>
            Find commands with the given return code

    -f, --folder <folder>
            Only print entries that have been executed in the given directory

        --hostname <hostname>
            Filter by given hostname

        --session <session>
            Filter by given session


SUBCOMMANDS:
    bench
            Run benchmark against server

    disable
            Disable history recording for current session

    enable
            Enable history recording for current session

    help
            Prints this message or the help of the given subcommand(s)

    import
            Import entries from existing histdb sqlite or zsh histfile

    init
            Print out shell functions needed by histdb and set current session id

    precmd
            Finish command for current session

    server
            Start the server

    session_id
            Get new session id

    stop
            Stop the server

    zshaddhistory
            Add new command for current session

The most basic command ist just running hstdb without any arguments:

» hstdb
 tmn    cmd
 14:28  cargo +nightly install --path .

That will print the history for the current machine. By default only the last 25 entries will be printed.

Git

hstdb was written to easily sync the history between multiple machines. For that hstdb will write separate history files for each machine.

If you want to sync between machines go to the datadir (default is $HOME/.local/share/hstdb) and run the following commands:

git init
git add :/
git commit -m "Initial commit"

After that you can configure origins and start syncing the files between machines. There is no autocommit/autosync implemented as we don't want to have commits for each command run. This could be changed in the future.

Configuration

There is also a way to configure hstdb. By default the configuration is stored under $HOME/.config/hstdb/config.toml. A different path can be specified using the --config-path option.

The default configuration looks like this:

# When true will not save commands that start with a space.
# Default: true
ignore_space = true

# The log level to run under.
# Default: Warn
log_level = "Warn"

Import

zsh-histdb

» histdb import histdb -h
hstdb-import-histdb 0.1.0
Import entries from existing histdb sqlite file

USAGE:
    hstdb import histdb [OPTIONS]

FLAGS:
    -h, --help
            Prints help information


OPTIONS:
    -d, --data-dir <data-dir>
            Path to folder in which to store the history files [default: $HOME/.local/share/hstdb]

    -i, --import-file <import-file>
            Path to the existing histdb sqlite file [default: $HOME/.histdb/zsh-history.db]

If the defaults for the data-dir and the import-file are fine you can just run the following command:

histdb import histdb

This will create CSV files for each hostname found in the sqlite database. It will create a UUID for each unique session found in sqlite so command run in the same session should still be grouped together.

zsh histfile

» histdb import histfile -h
hstdb-import-histfile 0.1.0
Import entries from existing zsh histfile

USAGE:
    hstdb import histfile [OPTIONS]

FLAGS:
    -h, --help
            Prints help information


OPTIONS:
    -d, --data-dir <data-dir>
            Path to folder in which to store the history files [default: $HOME/.local/share/hstdb]

    -i, --import-file <import-file>
            Path to the existing zsh histfile file [default: $HOME/.histfile]

If the defaults for the data-dir and the import-file are fine you can just run the following command:

histdb import histfile

As the information stored in the histfile is pretty limited the following information will be stored:

  • time_finished will be parsed from the histfile
  • result (exit code) will be parsed from the histfile
  • command will be parsed from the histfile
  • time_start will be copied over from time_finished
  • hostname will use the current machines hostname
  • pwd will be set to the current users home directory
  • session_id will be generated and used for all commands imported from the histfile
  • user will use the current user thats running the import

Contribution

I'm happy with how the tool works for me so I won't expand it further but contributions for features and fixes are always welcome!

Alternatives

Dependencies

~10–25MB
~323K SLoC