Welcome to the Plakar commands reference! Here you’ll find detailed documentation for every available command in Plakar.
You can browse the documentation here, or access it directly from your terminal using the plakar help command. This makes it easy to get help and usage information whether you’re online or working locally.
Below, you’ll find the full list of commands. Click any command to view its documentation.
agent
Run the Plakar agent
archive
Create an archive from a Plakar snapshot
backup
Create a new snapshot in a Kloset store
cat
Display file contents from a Plakar snapshot
check
Check data integrity in a Plakar repository
clone
Clone a Plakar repository to a new location
create
Create a new Plakar repository
destination
Manage Plakar restore destination configuration
diag
Display detailed information about Plakar internal structures
diff
Show differences between files in a Plakar snapshots
digest
Compute digests for files in a Plakar snapshot
dup
Duplicates an existing snapshot with a different ID
info
Display detailed information about internal structures
locate
Find filenames in a Plakar snapshot
login
Authenticate to Plakar services
logout
Log out from Plakar services
ls
List snapshots and their contents in a Plakar repository
maintenance
Remove unused data from a Plakar repository
mount
Mount Plakar snapshots as read-only filesystem
pkg-add
Install Plakar plugins
pkg-build
Build Plakar plugins from source
pkg-create
Package a plugin
pkg-manifest.yaml
Manifest for plugin assemblation
pkg-recipe.yaml
Recipe to build Plakar plugins from source
pkg-rm
Uninstall Plakar plugins
pkg-show
Show installed Plakar plugins
plakar
effortless backups
policy
Manage Plakar retention policies
prune
Prune snapshots according to a policy
ptar
generate a self-contained Kloset archive (.ptar)
query
query flags shared among many Plakar subcommands
restore
Restore files from a Plakar snapshot
rm
Remove snapshots from a Plakar repository
scheduler
Run the Plakar scheduler
server
Start a Plakar server
service
Manage optional Plakar-connected services
source
Manage Plakar backup source configuration
store
Manage Plakar store configurations
sync
Synchronize snapshots between Plakar repositories
token
Manage Plakar tokens
ui
Serve the Plakar web user interface
version
Display the current Plakar version