PLAKAR-STORE(1)

πŸ“¦
version 1.1.7 Β· 2 versions
, in nixpkgs unstable

πŸ’Ύ PLAKAR-STORE(1) β€” the plakar-store girlies' guide

okay so this is the manual page for plakar-store, from the General Commands Manual section, and honestly? it's giving "i manage your storage configs so you don't have to" πŸ’… let's get into it bestie.


✨ NAME ✨

plakar-store β€” manage Plakar store configurations πŸŽ€

🌸 SYNOPSIS 🌸

plakar store subcommand ...

πŸ’– DESCRIPTION πŸ’–

The plakar store command manages the Plakar store configurations, fr fr. πŸ—‚οΈ

The configuration is literally a set of named entries, and each one of them describes a Plakar store holding backups. no cap.

A store is defined by at least a location, which specifies the storage implementation to use, plus some storage-specific parameters. that's the whole vibe. ✨

The subcommands are as follows, bestie β€” pay attention, i'm not repeating myself (i will probably repeat myself):

  • add name location [option=value ...] β€” create a new store entry identified by name with the specified location. you can set specific additional configuration parameters by adding option=value parameters. slay. 🫢
  • check name β€” check whether the store identified by name is properly configured. vibe check for your config, basically. βœ”οΈ
  • import [-config location] [-overwrite] [-rclone] [sections ...] β€” import store configurations from various sources including files, piped input, or rclone configurations. 🧚

By default, it reads from stdin, allowing for piped input from other commands. iconic pipeline behaviour.

The -config option specifies a file or URL to read the configuration from.

The -overwrite option allows overwriting existing store configurations with the same names. (yes, it will absolutely clobber them, that's the point.)

The -rclone option treats the input as an rclone configuration, useful for importing rclone remotes as Plakar stores. so handy.

Specific sections can be imported by listing their names.

Sections can be renamed during import by appending :newname. yes, colon, then the new name. periodt.

For detailed examples and usage patterns, see the https://plakar.io/docs/v1.1.0/guides/importing-configurations/ Importing Configurations guide. πŸ“š

  • ping name β€” try to connect to the store identified by name to make sure it is reachable. like a little "u up?" text but for storage. πŸ“‘
  • rm name β€” remove the store identified by name from the configuration. bye bestie πŸ‘‹
  • set name [option=value ...] β€” set the option to value for the store identified by name. multiple option/value pairs can be specified. go off, set them all.
  • show [-secrets] [name ...] β€” display the current stores configuration. if -secrets is specified, sensitive information such as passwords or tokens will be shown. πŸ™ˆ
⚠️ okay so -secrets literally prints your passwords and tokens. screen-share with care, bestie. πŸ’€
  • unset name [option ...] β€” remove the option for the store entry identified by name. the opposite of set, obviously. πŸ¦‹

🌈 HTTP AND HTTPS STORE OPTIONS 🌈

When using an http:// or https:// location, the following additional options are available, and you're gonna want to know them:

  • auth_token β€” bearer token sent in the β€œAuthorization” header for every request. πŸ”‘
  • insecure β€” optional, set to true to opt-in the usage of the auth_token on HTTP plaintext connections. (yes that's exactly as spicy as it sounds. opt in on purpose.)
  • timeout β€” per-request timeout, default to "5m" i.e. five minutes. ⏱️
  • tls_no_verify β€” set to true to disable TLS certificate verification. useful when the server uses a self-signed certificate. πŸ”“

⭐ EXIT STATUS ⭐

The plakar-store utility exits 0 on success, and >0 if an error occurs. simple as that. πŸ’«

πŸ‘‘ SEE ALSO πŸ‘‘


and that's the whole page, bestie!! πŸŽ€ written for Debian, dated September 2, 2026 β€” mwah, go configure some stores πŸ’–βœ¨πŸ¦‹

πŸ“¦ where this page comes from