LinuxCommandLibrary

vdirsyncer

TLDR

Discover collections from servers

$ vdirsyncer discover
copy
Synchronize all configured pairs
$ vdirsyncer sync
copy
Synchronize specific pair
$ vdirsyncer sync [pair_name]
copy
Repair item storage
$ vdirsyncer repair [storage_name]
copy
Show version
$ vdirsyncer --version
copy

SYNOPSIS

vdirsyncer [options] command [arguments]

DESCRIPTION

vdirsyncer synchronizes calendars (CalDAV) and contacts (CardDAV) between servers and local storage. It downloads remote data to local directories where tools like khal and khard can access and modify them.
The tool supports bidirectional sync, meaning local changes sync back to servers. It can also synchronize between two servers directly. Configuration defines storage pairs specifying source and destination.
First run requires discover to detect available collections (calendars/addressbooks), then sync downloads the data. Subsequent syncs transfer only changes in both directions.

PARAMETERS

--verbosity level

Set output verbosity (DEBUG, INFO, WARNING, etc.).
--config file
Use alternative config file.
--version
Display version.
--help
Display help.

COMMANDS

discover: Find collections on remote servers.
sync: Synchronize configured pairs.
repair: Fix storage inconsistencies.
metasync: Sync metadata like colors.

CONFIGURATION

Config file: ~/.config/vdirsyncer/config
Defines storages (local or remote) and pairs connecting them. Supports CalDAV, CardDAV, and local filesystem storage types.

CAVEATS

Initial discover is required before sync. Google CardDAV has known issues with data integrity. Always backup before first sync. Conflicts may need manual resolution.

HISTORY

vdirsyncer was created as part of the pimutils project to provide command-line personal information management. It fills the role for calendars and contacts that OfflineIMAP fills for email, enabling offline access and local tooling for CalDAV/CardDAV data.

SEE ALSO

khal(1), khard(1), calcurse(1)

Copied to clipboard