Giter Club home page Giter Club logo

httm's Introduction

asciicast

httm

The dream of a CLI ZFS Time Machine is still alive with httm.

httm prints the size, date and corresponding locations of available unique versions (deduplicated by modify time and size) of files residing on ZFS snapshots, but can also be used interactively to select and restore such files. httm might change the way you use ZFS snapshots (because ZFS isn't designed for finding for unique file versions) or the Time Machine concept (because httm is very fast!).

httm boasts an array of seductive features, like:

  • Search for and recursively list all deleted files. Even browse files hidden behind deleted directories.
  • List file snapshots from all local pools (httm automatically detects local snapshots as well as locally replicated snapshots)!
  • List file snapshots from remote backup pools (you may designate replicated remote snapshot directories).
  • For use with even rsync-ed non-ZFS local datasets (like ext4, APFS, or NTFS), not just ZFS.
  • Specify multiple files for lookup on different datasets
  • 3 native interactive modes: browse, select and restore
  • ANSI ls colors from your environment
  • Non-blocking recursive directory walking (available in all interactive modes)
  • Select from several formatting styles. Parseable ... or not ... oh my!

Use in combination with you favorite shell (hot keys!) for even more fun.

Inspired by the findoid script, fzf and many zsh key bindings.

Installation

The httm project contains only a few components:

  1. The httm executable. To build and install:

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh 
    cargo install --git https://github.com/kimono-koans/httm.git
  2. The optional zsh hot-key bindings: Use ESC+s to select snapshots filenames to be dropped to your command line (for instance after the cat command), or use ESC+m to browse for all of a file's snapshots. After you install the httm binary, to copy the hot key script to your home directory, and source that script within your .zshrc:

    httm --install-zsh-hot-keys
  3. The optional man page: cargo has no native facilities for man page installation (though it may in the future!). You can use manpath to see the various directories your system uses and decide which directory works best for you. To install, just copy it to a directory in your man path, like so:

    cp ./httm/httm.1 /usr/local/share/man/man1/

Caveats

Right now, you will need to use a Unix-ish-y Rust-supported platform to build and install (that is: Linux, Solaris/illumos, the BSDs, MacOS). Note, your platform does not need to support ZFS to use httm. And there is no fundamental reason a non-interactive Windows version of httm could not be built, as it once did build, but Windows platform support is not a priority for me right now. Contributions from users are, of course, very welcome.

On FreeBSD, after a fresh minimal install, the interactive modes may not render properly, see the linked issue for the fix.

On some Linux distributions, which include old versions of libc, cargo may require building with musl instead, see the linked issue.

Example Usage

Print all unique versions of your history file:

httm ~/.histfile

Print all files on snapshots deleted from your home directory, recursive, newline delimited, piped to a deleted-files.txt file:

httm -d -n -R --no-live ~ > deleted-files.txt

Browse all files in your home directory, recursively, and view unique versions on local snapshots:

httm -i -R ~

Browse all files deleted from your home directory, recursively, and view unique versions on all local and alternative replicated dataset snapshots:

httm -d only -i -a -R ~

Browse all files in your home directory, recursively, and view unique versions on local snapshots, to select and ultimately restore to your working directory:

httm -r -R ~

Create a simple tar archive of all unique versions of your /var/log/syslog:

httm -n /var/log/syslog | tar -zcvf all-versions-syslog.tar.gz -T -

Create a kinda fancy tar archive of all unique versions of your /var/log/syslog:

# a slightly fancier GNU tar folder structure
file="/var/log/syslog"
dir_name="${$(dirname $file)/\//}"
base_dir="$(basename $file)_all_versions"

httm -n "$file" | tar --transform="flags=r;s|$dir_name|$base_dir|" \
--transform="flags=r;s|.zfs/snapshot/||" --show-transformed-names \
-zcvf "all-versions-$(basename $file).tar.gz" -T  -

Create a super fancy git archive of all unique versions of /var/log/syslog:

# create variable for file name
file="/var/log/syslog"
# create git repo
mkdir ./archive-git; cd ./archive-git; git init
# copy each version to repo and commit after each copy
for version in $(httm -n $file); do
    cp "$version" ./
    git add "./$(basename $version)"
    git commit -m "httm commit from ZFS snapshot"
    # amend commit date to match snapshot modify time
    git commit --amend --no-edit --date "$(date -d "$(stat -c %y $version)")"
done
# create git tar.gz archive
tar -zcvf "../all-versions-$(basename $file).tar.gz" "./"
# and to view
git log --stat

I know what you're thinking, but slow your roll.

To be clear, httm is not...

License

httm is licensed under the MPL 2.0 License - see the LICENSE file for more details.

httm's People

Contributors

kimono-koans avatar keltia avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.