kontaktdb

Store, retrieve, and edit basic contact information in plain text.
git clone https://git.sr.ht/~jbauer/kontaktdb
Log | Files | Refs | README | LICENSE

README.md (1921B)


      1 # Kontaktdb
      2 
      3 Store, retrieve, and edit basic contact information in plain text.
      4 
      5 ## Why Does This Exist?
      6 
      7 I didn't like the existing options for managing contacts on the command line.
      8 Programs like abook and khard are nice, but I wanted something much, much
      9 simpler since I didn't need the complexity offered by the other options.
     10 
     11 The goals for this program are:
     12 
     13 * Contact database entirely in plain text with tab-delimited fields.
     14 * Support for contact names and emails (possibly more later, but not much more).
     15 * Really simple set of commands to interact with the database.
     16 
     17 ## What Works?
     18 
     19 So far, you can add a contact to the database, delete a contact from the
     20 database, retrieve a contact's information, and change a contact's information
     21 (though you must change both the name and email at the same time).
     22 
     23 ## Compatibility
     24 
     25 The script should work across all *nix environments. The only non-POSIX feature
     26 I use is `sed -i` which is usually available on most BSDs and Linux
     27 distributions.
     28 
     29 ## Installing
     30 
     31 `kontaktdb` is just a POSIX shell script. You can put it anywhere in your `$PATH`
     32 or type `make install` to have it automatically copied to `/usr/local/bin/`.
     33 
     34 ## Configuring
     35 
     36 Set the `KONTAKT_DB` environment variable to specify the location of the contact
     37 database file.
     38 
     39 If this variable is unset, kontaktdb will check if `XDG_DATA_HOME` is defined and
     40 will put the database file there.
     41 
     42 If neither of the above environment variables are defined, kontaktdb will fall
     43 back to storing the database at `$HOME/.kontaktdb`.
     44 
     45 ## Using
     46 
     47 See the output of `kontaktdb -h`.
     48 
     49 ## Contributing
     50 
     51 Send patches and questions to
     52 [~jbauer/kontaktdb@lists.sr.ht](mailto:~jbauer/kontaktdb@lists.sr.ht)
     53 
     54 Subscribe to [the RSS feed](https://git.sr.ht/~jbauer/kontaktdb/refs/rss.xml)
     55 for new version announcements.
     56 
     57 Please be kind and courteous when communicating on the mailing list. If not,
     58 don't expect your work to be merged.