PLAKAR-SOURCE(1)

📦 version 1.1.7, in nixos 26.05, nixpkgs unstable

💅 PLAKAR-SOURCE — manage plakar backup source configuration

okay so bestie, you found plakar-source (that's the general commands manual one, section 1, hiiii 🫶). This is the little tool that handles alllll your source config for Plakar backups, and honestly? iconic. Let's get into it.

✨ SYNOPSIS ✨

plakar source subcommand ...

that's it, that's the whole vibe. you pick a subcommand and go 🎀

🌸 DESCRIPTION 🌸

The plakar source command manages the configuration of data sources for Plakar to backup. literally its whole job, and it does it well 💅

So the config is basically a set of named entries — think of them like little contact cards in your phone 📇 — and each entry describes one source for a backup operation.

A source is defined by at least a location, which tells Plakar which importer to use, plus some importer-specific parameters. so: location = the main character, parameters = the supporting cast ✨

The subcommands are as follows:

  • add name location [option=value ...] — Create a new source entry identified by name with the specified location describing the importer to use. Additional importer options can be set by adding option=value parameters. new source just dropped 👑
  • check name — Check whether the importer for the source identified by name is properly configured. vibe check for your importer, basically 🧚
  • import [-config location] [-overwrite] [-rclone] [sections ...] — Import source configurations from various sources including files, piped input, or rclone configurations. lowkey the most powerful one here, ngl.

By default, reads from stdin, allowing for piped input from other commands. so you can just yeet config at it through a pipe 🍓

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

The -overwrite option allows overwriting existing source configurations with the same names. ⚠️ careful bestie, this one will absolutely replace what's already there.

The -rclone option treats the input as an rclone configuration, useful for importing rclone remotes as Plakar sources. slay, we love a crossover episode 🌈

Specific sections can be imported by listing their names.

Sections can be renamed during import by appending :newname. so like, glow-up the name on the way in 💫

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 open the data source identified by name to make sure it is reachable. just checking in on it, no biggie 💖
  • rm name — Remove the source identified by name from the configuration. it's giving "we don't know her" 💀
  • set name [option=value ...] — Set the option to value for the source identified by name. Multiple option/value pairs can be specified. glow-up time 🔥
  • show [-secrets] [name ...] — Display the current sources configuration. If -secrets is specified, sensitive information such as passwords or tokens will be shown. 👀 be careful where you run this one, fr fr.
  • unset name [option ...] — Remove the option for the source entry identified by name. Marie Kondo that option 🎀

⭐ EXIT STATUS ⭐

The plakar-source utility exits 0 on success, and >0 if an error occurs. so: 0 = we ate, >0 = something went off 😭

🦋 SEE ALSO 🦋

  • plakar(1) — go read the big one too, bestie, it's the whole ecosystem 👑

that's the page!! Debian shipped it, dated September 11, 2025, and it's filed under PLAKAR-SOURCE(1) — ily, go back up your stuff 💜🌸

📦 where this page comes from