You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Lucas Hoffmann dcfaa0e4ee Merge branch 'release/v0.16.1' 2 months ago
doc Fix rst formatting in the docs 3 months ago
khard Do not clean up search query to find more matches 2 months ago
misc Add new -F option to zsh completion 3 months ago
test Do not clean up search query to find more matches 2 months ago
.gitignore Add coverage cache file to gitignore 3 months ago
.readthedocs.yml Configure building on readthedocs.org 3 months ago
.travis.yml Require python >= 3.6 3 months ago
CHANGES Update changelog for version v0.16 3 months ago
CONTRIBUTING.rst Fix link to api docs 3 months ago
LICENSE Initial commit 5 years ago
MANIFEST.in Version 0.7.1 4 years ago
README.md Works fine on macOS and the *BSDs 5 months ago
setup.py Require python >= 3.6 3 months ago
todo.txt Accept formatted_name with --sort and --display 10 months ago

README.md

khard

Khard is an address book for the Unix console. It creates, reads, modifies and removes carddav address book entries at your local machine. Khard is also compatible to the email clients mutt and alot and the SIP client twinkle. You can find more information about khard and the whole synchronization process here.

Warning: If you want to create or modify contacts with khard, beware that the vcard standard is very inconsistent and lacks interoperability. Different actors in that sector have defined their own extensions and even produce non-standard output. A good example is the type value, which is tied to phone numbers, email and post addresses. Khard tries to avoid such incompatibilities but if you sync your contacts with an Android or iOS device, expect problems. You are on the safe side, if you only use khard to read contacts. For further information about the vcard compatibility issues have a look into this blog post.

Installation

Packaging status

Khard is already packaged for quite some distributions. Chances are you can install it with your default package manager. Releases are also published on PyPi and can be installed with pip. Further instructions can be found in the documentation.

Usage

Documentation Status

There is an example config file which you can copy to the default config file location: ~/.config/khard/khard.conf. khard has several subcommands which are all documented by their --help option. The docs also have a chapter on command line usage and configuration.

In order to build the documentation locally you need Sphinx. It can be build from the Makefile in the doc directory.

Development

Build Status

Khard is developed on GitHub where you are welcome to post bug reports and feature requests. Also see the notes for contributors.

Authors

Khard was started by Eric Scheibler and is currently maintained by @lucc. Several people have contributed over the years.

If you need a console based calendar too, try out khal.