Skip to main content

A console address book manager

Project description

khard

Khard is an address book for the Unix console. It creates, reads, modifies and removes vCard 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

ci-badge

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.

Related projects

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

khard-0.20.1.tar.gz (611.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

khard-0.20.1-py3-none-any.whl (68.2 kB view details)

Uploaded Python 3

File details

Details for the file khard-0.20.1.tar.gz.

File metadata

  • Download URL: khard-0.20.1.tar.gz
  • Upload date:
  • Size: 611.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.11

File hashes

Hashes for khard-0.20.1.tar.gz
Algorithm Hash digest
SHA256 b3e5bfadf6b5d7e8f168d0c320c74b954e4d0ef4194b28791140fe577a48f948
MD5 6dc97049fa86f460c116bca7990e856a
BLAKE2b-256 7d1001f3f4d875d3908d0d34fa32bb55d5015f68bc391257cfa1ceac27da763e

See more details on using hashes here.

File details

Details for the file khard-0.20.1-py3-none-any.whl.

File metadata

  • Download URL: khard-0.20.1-py3-none-any.whl
  • Upload date:
  • Size: 68.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.11

File hashes

Hashes for khard-0.20.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e28133fc28dad9f1402ee763999c32a3d79664cf3c4ed3dbdfd6016c3ca0b42e
MD5 7931f89434ac7a0ea3e3b9e190965445
BLAKE2b-256 9a70fdc18a993faeeae3fb7060629175cc44f40e9eb3eb5da26da03f450978e1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page