@hackage hash-addressed-cli1.0.0.0

Hash-addressed file storage

The hash-addressed executable is a command-line interface for maintaining a directory wherein each file's name is a hash of its content.

Initialization

In this demonstration, we initialize a SHA-256 hash-addressed directory at /tmp/demo.

$ hash-addressed initialize --directory /tmp/demo --hash-function sha256

This created a configuration file:

$ cat /tmp/demo/.hash-addressed/config
version: 1
hash function: sha256

Writing

We can now use the hash-addressed write command to write files into this directory. In the output we see the path to which the content was written.

$ echo "Test file 1" | hash-addressed write --target-directory /tmp/demo
/tmp/demo/ad7a409054a68314812ba3ad0e523a66593ab3404c81700d6f5c3601f0da830e
$ echo "Test file 2" | hash-addressed write --target-directory /tmp/demo
/tmp/demo/20b39ca6ca85b53be73920532fd6f9cc164317646995839e2e54a6871dc13bf7

We can verify that the file was written and that indeed its name matches its SHA-256 checksum:

$ cat /tmp/demo/20b39ca6ca85b53be73920532fd6f9cc164317646995839e2e54a6871dc13bf7
Test file 2
$ sha256sum /tmp/demo/20b39ca6ca85b53be73920532fd6f9cc164317646995839e2e54a6871dc13bf7
20b39ca6ca85b53be73920532fd6f9cc164317646995839e2e54a6871dc13bf7

Verbosity

With the --verbose flag we get some additional information, including whether the content was added or already present.

$ echo "Test file 3" | hash-addressed write --target-directory /tmp/demo --verbose
The hash function is sha256
One new file was added to the store.
/tmp/demo/efdbe264574c7440b80a2c4aaf15c18787a125b6223d05300841f32f46361e7f
$ echo "Test file 3" | hash-addressed write --target-directory /tmp/demo --verbose
The hash function is sha256
The file was already present in the store; no change was made.
/tmp/demo/efdbe264574c7440b80a2c4aaf15c18787a125b6223d05300841f32f46361e7f

File copying

Instead of reading from the standard input stream, hash-addressed can also copy a file into the store using the --source-file option.

$ echo "file content" > /tmp/demo-file
$ hash-addressed write --source-file /tmp/demo-file --target-directory /tmp/demo
/tmp/demo/694b27f021c4861b3373cd5ddbc42695c056d0a4297d2d85e2dae040a84e61df
$ cat /tmp/demo/694b27f021c4861b3373cd5ddbc42695c056d0a4297d2d85e2dae040a84e61df
file content