Repository files navigation

Khal is a standards based CLI and terminal calendar program, able to synchronizewithCalDAV servers throughvdirsyncer.

(or rather: limitations)

• khal can read and write events/icalendars tovdir, sovdirsyncer can beused tosynchronize calendars with a variety of other programs, forexampleCalDAV servers.
• fast and easy way to add new events
• ikhal (interactive khal) lets you browse and edit calendars and events
• no support for editing the timezones of events yet
• works with python 3.8+
• khal should run on all major operating systems[1]

Please do provide feedback ifkhal works for you or even more importantly ifit doesn't. The preferred way to get in contact (especially if something isn'tworking) is via github or via IRC (#pimutils on Libera.Chat).

For khal's documentation have a look atreadthedocs.

khal is packaged for mostoperating systems and should be installable withyour standard package manager.

For some exemplary OS you can find installation instructions below. Otherwisesee thedocumentation for more information.

apt install khal

nix-env -i khal

pacman -S khal

brew install khal

dnf install khal

pkg install py-khal

pip install git+https://github.com/pimutils/khal

Projects with similar aims you might want to check out arecalendar-cli (nooffline storage and a bit different scope) andgcalcli (only works withgoogle's calendar).

You want to contribute tokhal? Awesome!

The most appreciated way of contributing is by supplying code or documentation,reporting bugs, creating packages for your favorite operating system, makingkhal better known by telling your friends about it, etc.

khal is released under the Expat/MIT License:

Copyright (c) 2013-2022 khal contributorsPermission is hereby granted, free of charge, to any person obtaining a copy ofthis software and associated documentation files (the "Software"), to deal inthe Software without restriction, including without limitation the rights touse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies ofthe Software, and to permit persons to whom the Software is furnished to do so,subject to the following conditions:The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESSFOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS ORCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHERIN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR INCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.