BUPSTASH-INIT(1)

💖 bupstash-init(1) — the general commands manual, but make it cute 💖

okay so bestie, this is the bupstash-init page from the General Commands Manual and it's literally the "make a repository" moment. let's get into it ✨

---

✨ SYNOPSIS ✨

Initialize a bupstash repository.

bupstash init [OPTIONS]

---

🎀 DESCRIPTION 🎀

bupstash init initializes a repository. and here's the thing — if REPOSITORY already exists, the command fails. no overwriting, no take-backs, it just says nope 🙈.

Currently it is not recommend using bupstash on a network filesystem. (that's the original's wording and its original typo, i'm just the messenger, do not come for me 💀)

if you wanna know what's actually inside the package store after initialization, go read bupstash-repository(7) — it's giving lore, it's giving documentation. 📚

---

💅 OPTIONS 💅

• -r, --repository REPO — the repository you're connecting to. it can be of the form ssh://$SERVER/$PATH for remote repositories, but only if ssh access is configured. and if you don't specify it at all, it gets set to BUPSTASH_REPOSITORY. 🫶
• --storage SPEC — accepts 'dir' or a json storage specification. the default storage is 'dir' and it stores encrypted data blocks in a repository local data directory. see the storage specs section below for the supported json specifications and examples. 👑

---

🌸 ENVIRONMENT 🌸

• BUPSTASH_REPOSITORY — the repository to connect to. may be of the form ssh://$SERVER/$PATH for remote repositories if ssh access is configured. 🦋
• BUPSTASH_REPOSITORY_COMMAND — a command to run to connect to an instance of bupstash-serve(1). this lets you do more complex connections to the repository for less common use cases. iykyk 💜

---

🍓 EXAMPLES 🍓

$ export BUPSTASH_REPOSITORY=./my-repository
$ bupstash init

$ export BUPSTASH_REPOSITORY=ssh://$SERVER/home/backups/bupstash-backups
$ bupstash init

---

🌈 JSON STORAGE SPECS 🌈

each storage specification consists of a type designator and a set of type specific parameters. no cap ✨

🎀 Dir storage 🎀

dir storage is an alias for --storage dir and is generally not needed.

example:

$ bupstash init --storage '{"Dir" : {}}''

🧚 External storage 🧚

the external storage engine stores data via an external socket, documentation is pending interface stabilization. (so like... the docs are still cooking 🔥)

example:

$ bupstash init --storage '{"External" : {"socket_path" : "/plugin/socket.sock", "path" : "plugin-specific-path"}}''

---

👑 SEE ALSO 👑

bupstash(1), bupstash-repository(7)

---

that's the whole page, bestie — slay, go init your repository, and remember: it fails if REPOSITORY already exists, so no copying your homework twice 💅

mwah 💖 this has been bupstash-init(1) from the General Commands Manual, dated May 2025, BUPSTASH-INIT(1) and all — see you in the next repo 🫶✨