https://github.com/mrusme/addrb
addrb: A lightweight CLI / TUI address book that supports CardDAV
https://github.com/mrusme/addrb
address-book carddav carddav-client cli command-line command-line-tool tui webdav webdav-client
Last synced: 7 months ago
JSON representation
addrb: A lightweight CLI / TUI address book that supports CardDAV
- Host: GitHub
- URL: https://github.com/mrusme/addrb
- Owner: mrusme
- License: gpl-3.0
- Created: 2022-05-30T00:22:17.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-07T14:30:42.000Z (over 1 year ago)
- Last Synced: 2024-10-18T06:36:20.419Z (about 1 year ago)
- Topics: address-book, carddav, carddav-client, cli, command-line, command-line-tool, tui, webdav, webdav-client
- Language: Go
- Homepage: https://xn--gckvb8fzb.com
- Size: 854 KB
- Stars: 32
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-cli-apps-in-a-csv - addrb - A lightweight CLI / TUI address book that supports CardDAV. (<a name="organizers"></a>Organizers and calendars)
README
addrb
-----
`addrb`, the command line **addr**ess **b**ook. It's super lightweight, yet it
supports CardDAV sync!
## Build
```sh
go build .
```
## Usage
Either export all necessary variables to your ENV or set them as command line
flags:
```sh
export CARDDAV_USERNAME='...'
export CARDDAV_PASSWORD='...'
export CARDDAV_ENDPOINT='...'
export ADDRB_DB='...'
```
If you're using [Baïkal](https://github.com/sabre-io/Baikal) for example, you
would export something like this as `CARDDAV_ENDPOINT`:
```sh
export CARDDAV_ENDPOINT='https://my.baik.al/dav.php/'
```
The `ADDRB_DB` is the local contacts database in order to not need to contact
the CardDAV for every lookup. You might set it to something like this:
```sh
export ADDRB_DB=~/.cache/addrb.db
```
When `addrb` is launched for the first time, it requires the `-r` flag to
refresh the contacts and sync them locally:
```sh
addrb -r john doe
```
This command will connect to the CardDAV server, sync all address books/contacts
locally and perform a lookup for *john doe*. It will display you the contact(s)
if any was found.
You can also refresh without querying:
```sh
addrb -r
```
This way you could create a cron job that refreshes `addrb` in the background,
e.g. every three hours:
```sh
crontab -e
```
```crontab
0 */3 * * * sh -c 'addrb -r'
```
You can also output contacts as JSON format using the `-j` flag:
```sh
addrb -j john doe
```
Find more flags and info with `addrb --help`.
## Templating
You can customize the regular output using templating. The template can either
be passed using the `--template ` flag or by exporting `ADDRB_TEMPLATE`
in the in the environment.
The templating format is the [Go standard `text/template`][1] format. The
following special functions are available:
- `RenderPhoto` for rendering a base64 string as image (usually the contact
`PHOTO`)
- `RenderAddress` for rendering a contact address
Available property names that are available can be found by displaying a
contact as JSON (using the `-j` flag). E.g. "FN" is the full name, which can be
retrieved using e.g. the `.PreferredValue` method:
```tmpl
{{ .PreferredValue "FN" }}
```
Other methods that are available can be found [here][3], with the most useful
ones probably being `.PreferredValue`, `.Value`, and `.Values` (for arrays).
An example template can be found [here][2]. To make use of the template, you can
copy it to e.g. `~/.config/addrb.tmpl` and have
`ADDRB_TEMPLATE=~/.config/addrb.tmpl` exported in your `.zshrc`/`.bashrc`/etc.
## FAQ
- Q: Does `addrb` write/modify any contact information?
A: Nope, so far it's read-only and does not support updating vCards, hence it
won't mess with your data.
- Q: Can I use it with my local address book?
A: Nope, as of right now `addrb` only supports CardDAV servers to sync with.
- Q: Does it support HTTP Digest auth?
A: Nope, only HTTP Basic auth.
- Q: The `text/template` stuff doesn't work for me, can I make `addrb` output
contact data differently?
A: Yes, you can use the `-j` flag and have it output pure JSON, which you can
then process using e.g. [`jq`][4].
[1]: https://pkg.go.dev/text/template
[2]: example.tmpl
[3]: https://pkg.go.dev/github.com/emersion/go-vcard#Card
[4]: https://stedolan.github.io/jq/