~psic4t/qcard

ref: 88ee3ef359cf46abbc2888317d67c4791c755351 qcard/README.md -rw-r--r-- 2.6 KiB
88ee3ef3psic4t fix README 5 months ago

#qcard

qcard is a CLI addressbook application for CardDAV servers written in Go. In contrast to other tools it does not cache anything. It can fetch multiple servers / addressbooks in parallel which makes it quite fast.

Its main purpose is displaying addressbook data. Nevertheless it supports basic creation and editing of entries.

#Features

  • Easy search for contacts
  • Parallel fetching of multiple addressbooks
  • Easy to use filters
  • Create, modify and delete contacts
  • Import VCF files
  • Display VCF files
  • Easy setup

#Installation / Configuration

  • Have Go installed
  • make && sudo make install (for MacOS: make darwin)
  • copy config-sample.json to ~/.config/qcard/config.json and modify accordingly

#Arch AUR package

  • Here: AUR
  • Copy config-sample.json from /usr/share/qcard/ to ~/.config/qcard/config.json and modify accordingly

#Configuration

  • For additional addressbooks just add a comma and new addressbook credentials in curly brackets.

#Usage

Common options:

qcard -h

#Displaying addressbooks

This simply displays all contacts from all addressbooks:

qcard

This only shows contacts from addressbook 0:

qcard -a 0

This displays all avaliable addressbooks with their numbers and colors:

qcaŕd -l

This searches for contacts containing "doe" in all addressbooks:

qcard -s doe

The DetailThreshold parameter in the configuration file determines when all contact details are shown for a given numer of search results. For instance, on DetailTreshold = 3 you get all details if 3 or less contacts are found for the searchword "doe".

Here's a list of all attributes:

**M:** phoneCell
**P:** phoneHome
**p:** phoneWork
**E:** emailHome
**e:** emailWork
**A:** addressHome
**a:** addressWork
**O:** Organisation
**B:** Birthday
**T:** Title
**n:** Note

#Add new contact

This creates a contact for John Doe with a private mobile phone number and an email address in address book 1:

qcard -a 1 -n "John Doe M:+49 172 123123 E:jdoe@data.haus"

Just combine the parameters from above like you wish.

#Edit a contact

This shows searches for "doe" in addressbook 2 and prints the corresponding filenames ("fobarxyz.vcf"):

qcal -a 2 -s doe -f

This edits the selected vCard object in your $EDITOR (i.e. vim). When you save-quit the modified object is automatically uploaded:

qcal -c 2 -edit foobarxyz.vcf

#About

Questions? Ideas? File bugs and TODOs through the issue tracker or send an email to ~psic4t/qcard@todo.sr.ht