BUPSTASH(1)                      User Commands                     BUPSTASH(1)

<?><?><?> (NAME)
       bupstash - <?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?><?><?> <?> <?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?><?><?><?>

<?><?><?><?><?> <?><?><?><?><?> (SYNOPSIS)
       <?><?><?><?><?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?><?><?><?> <?> <?><?><?><?>
       <?><?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?> Bupstash.

       <?><?><?> <?><?> <?><?><?><?><?><?><?><?><?><?><?> <?><?><?> <?><?>
       bupstash <?><?> <?><?><?><?> <?><?><?><?>:

       bupstash init ...
       bupstash new-key ...
       bupstash new-sub-key ...
       bupstash put ...
       bupstash list ...
       bupstash list-contents ...
       bupstash diff ...
       bupstash get ...
       bupstash restore ...
       bupstash rm ...
       bupstash recover-removed ...
       bupstash gc ...
       bupstash sync ...
       bupstash exec-with-locks ...
       bupstash serve ...
       bupstash help ...
       bupstash version ...

<?><?><?><?><?><?><?> (DESCRIPTION)
       <?><?><?><?><?> bupstash <?><?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?><?><?><?><?> (<?> <?><?><?><?><?><?><?>)
       <?><?><?><?><?><?><?> <?> <?><?><?><?><?><?><?> <?><?> <?><?>
       bupstash-repository(7) <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?>.

       <?><?><?><?> <?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?>
       bupstash <?><?><?><?><?><?><?> <?><?>:

       o   <?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
           <?><?><?><?><?><?> (Deduplication) <?><?><?><?><?><?><?><?><?>.

       o   <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?>
           <?><?><?><?><?><?> (Client-side).

       o   <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?> (Incremental)
           <?><?><?><?><?><?><?>.

       o   <?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?>
           <?><?><?><?><?><?><?><?> (Tag-based).

       o   <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
           <?><?><?><?><?><?><?><?> <?> <?><?><?><?><?><?><?><?> <?><?>
           <?><?><?><?> <?><?><?><?><?><?>.

       o   <?><?><?><?><?> <?><?><?><?><?><?> <?><?> <?><?><?><?>
           <?><?><?><?><?><?> SSH.

       o   <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?>
           <?><?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?> <?><?><?><?>
           <?><?> <?><?><?><?> SSH.

       o   <?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?><?>.




       <?><?><?><?><?> bupstash <?><?><?> <?><?>
       <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?>
       <?><?><?> <?><?> <?><?> <?><?> <?><?><?><?><?><?><?> <?><?><?><?>
       <?><?><?> <?><?> <?><?><?><?><?>.

<?><?><?><?><?><?><?><?><?><?> (SUBCOMMANDS)
       bupstash-init(1)
              <?><?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?> bupstash.

       bupstash-new-key(1)
              <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?>
              <?><?><?><?> <?><?><?><?><?>/<?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?>.

       bupstash-new-sub-key(1)
              <?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?><?><?>
              <?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?><?> <?><?>
              <?><?><?><?><?><?><?><?><?>.

       bupstash-put(1)
              <?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?> <?><?><?><?>
              bupstash.

       bupstash-get(1)
              <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?>
              <?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?> bupstash.

       bupstash-restore(1)
              <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?> <?><?>
              <?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?>.

       bupstash-list(1)
              <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?> <?><?><?><?><?> <?><?> <?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?>.

       bupstash-list-contents(1)
              <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?>.

       bupstash-diff(1)
              <?><?><?><?><?><?> <?> <?><?><?><?><?><?><?><?><?><?> <?><?>
              <?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?>.

       bupstash-rm(1)
              <?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>
              <?><?> <?><?> <?><?><?><?><?><?><?><?> <?><?><?><?>.

       bupstash-recover-removed(1)
              <?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?><?> (Garbage Collection)
              <?><?><?><?><?>.

       bupstash-gc(1)
              <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?> <?><?>
              <?><?><?><?>.

       bupstash-sync(1)
              <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
              <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>.

       bupstash-exec-with-locks(1)
              <?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?> <?><?><?><?>
              <?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?>
              <?><?><?><?> <?><?><?><?><?><?> <?><?><?>.

       bupstash-serve(1)
              <?><?><?><?><?> <?><?> <?><?><?><?> <?><?> <?><?><?><?>
              stdin/stdout <?><?> <?><?><?><?><?><?><?> <?><?>
              bupstash-protocol(7).

<?><?><?><?><?><?><?> (EXAMPLES)
   <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?> <?> <?><?><?><?><?>
       <?><?><?><?><?><?>
       $ bupstash init -r ssh://$SERVER/home/me/backups
       $ bupstash new-key -o backups.key

   <?><?><?><?><?> <?><?><?><?> <?> <?><?><?><?> <?><?><?><?><?><?><?>
       <?><?><?><?> bupstash
       $ export BUPSTASH_REPOSITORY=ssh://$SERVER/home/me/backups
       $ export BUPSTASH_KEY=backups.key

   <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?>
       $ bupstash put ./some-data
       ebb66f3baa5d432e9f9a28934888a23d

       $ bupstash list-contents id=ebb66f3baa5d432e9f9a28934888a23d
       drwxr-xr-x 0    2020/11/05 10:42:48 .
       -rw-r--r-- 177B 2020/07/12 17:13:42 data.txt

   <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?> <?><?> <?><?><?><?><?><?><?>
       $ bupstash list hostname=$(hostname)
       id="bcb8684e6bf5cb453e77486decf61685" name="some-file.txt" hostname="my-server" timestamp="2020-07-27 11:26:16"
       ...

   <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
       $ bupstash put --send-log /var/backup.sendlog ./some-data
       ebb66f3baa5d432e9f9a28934888a23d

       # <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>.
       $ bupstash put --send-log /var/backup.sendlog ./some-data
       ebb66f3baa5d432e9f9a28934888a23d

   <?><?><?> <?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>
       # <?><?><?><?><?> <?><?><?><?><?> <?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?>.
       $ bupstash put --exec name=database.sql pgdump mydatabase
       14ebd2073b258b1f55c5bbc889c49db4

   <?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?> <?><?>
       <?><?><?><?><?><?><?>
       $ bupstash get id=bcb8684e6bf5cb453e77486decf61685
       some data.

   <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?><?> <?><?> <?><?>
       <?><?><?><?><?><?><?><?> <?><?><?><?>
       $ bupstash restore --to ./dir name=dir.tar

   <?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?> <?><?>
       <?><?><?><?><?><?><?>
       $ bupstash rm name=some-data.txt

   <?><?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?>
       $ bupstash rm --allow-many id=*

   <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?>
       $ bupstash gc

   <?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?><?>
       # <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?>-<?><?><?><?><?> (put)<?> <?> <?><?> <?><?><?><?> <?><?><?><?><?><?><?> (<?><?><?> list/rm).
       $ bupstash new-key -o backups.key
       $ bupstash new-sub-key --put -k backups.key -o backups-put.key
       $ bupstash new-sub-key --list -k backups.key -o backups-metadata.key

       ... <?><?><?> <?><?><?><?> backups.key <?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?> <?> <?><?><?> ...

       # <?><?><?> <?><?><?><?> <?><?><?><?>
       $ shred backups.key

       $ bupstash put -k backups-put.key ./data
       14ebd2073b258b1f55c5bbc889c49db4

       ... <?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?> ...

       $ bupstash list -k backups-metadata.key
       ...
       $ bupstash rm -k backups-metadata.key

       ... <?><?> <?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?> ...

       # <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?> <?><?> <?><?><?><?> <?> <?><?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>.
       $ bupstash get -k backups.key id=14ebd2073b258b1f55c5bbc889c49db4 | tar -C ./restore -xf -

<?><?><?><?><?><?> <?><?><?><?><?><?> (SEE ALSO)
       bupstash-repository(7), bupstash-keyfiles(7)

bupstash                          2026-09-01                       BUPSTASH(1)