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 1e41ec0f13 Merge branch 'hotfix/readme' 2 weeks ago
doc Describe all config options in the man page 4 weeks ago
khard Make the build reproducible 3 weeks ago
misc Update contact template for new version 4 weeks ago
test Make the build reproducible 3 weeks ago
.gitignore Add autogenerated api docs 5 months ago
.travis.yml Xenial is the default on travis already 1 month ago
AUTHORS Release v0.2 5 years ago
CHANGES Update changelog for version v0.15 4 weeks ago
CONTRIBUTING.rst Add contributing section and file 5 months ago
LICENSE Initial commit 5 years ago
MANIFEST.in Version 0.7.1 3 years ago
README.md Revert README to markdown 2 weeks ago
setup.py Revert README to markdown 2 weeks ago
todo.txt Accept formatted_name with --sort and --display 3 months ago

README.md

khard

Khard is an address book for the Linux 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

<img src="https://repology.org/badge/tiny-repos/khard.svg"
    alt="Packaging status" align="right">

Khard is already packaged for quite some distributions. Chances are you can install it with your default package manager. Further instructions can be found in the documentation.

Usage

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.

Development

<img src="https://travis-ci.org/scheibler/khard.svg?branch=develop"
    alt="Build status" align="right">

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

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