Cardamum

https://docs.rs/cardamum
Admin
Cardamum is a command-line interface tool for managing contacts with support for CardDAV and Vdir...
Tokens:1,669
Snippets:27
Trust Score:9.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Cardamum CLI from Git

Source: https://docs.rs/cardamum

Install the Cardamum CLI directly from its Git repository using Cargo. Ensure you have Rust and Cargo installed.

```bash
cargo install --locked --git https://github.com/pimalaya/cardamum.git

```

--------------------------------

### vCard Content Example

Source: https://docs.rs/cardamum

This is an example of the vCard content that will be opened in your text editor when using the 'cardamum card update' command.

```vcard
BEGIN:VCARD
VERSION:3.0
N:Gump;Forrest
FN:Forrest Gump
ORG:Bubba Gump Shrimp Co.
TITLE:Shrimp Man
PHOTO;VALUE=URL;TYPE=GIF:http://www.example.com/dir_photos/my_photo.gif
TEL;TYPE=WORK;VOICE:(111) 555-1212
TEL;TYPE=HOME;VOICE:(404) 555-1212
ADR;TYPE=WORK:;;100 Waters Edge;Baytown;LA;30314;United States of America
LABEL;TYPE=WORK:100 Waters Edge\nBaytown, LA 30314\nUnited States of America
ADR;TYPE=HOME:;;42 Plantation St.;Baytown;LA;30314;United States of America
LABEL;TYPE=HOME:42 Plantation St.\nBaytown, LA 30314\nUnited States of America
EMAIL;TYPE=PREF,INTERNET:forrestgump@example.com
REV:20080424T195243Z
END:VCARD

```

--------------------------------

### Configure Posteo Discovery

Source: https://docs.rs/cardamum

Uses discovery service with basic authentication for Posteo accounts.

```properties
carddav.discover.host = "posteo.de"
carddav.auth.basic.username = "your.email"
carddav.auth.basic.password.raw = "p@$$w0rd"
```

--------------------------------

### List Addressbooks with Cardamum

Source: https://docs.rs/cardamum

Use this command to list available addressbooks. It displays a table with ID, NAME, DESC, and COLOR.

```bash
$ cardamum addressbooks list

| ID      | NAME                | DESC | COLOR |
|---------|---------------------|------|-------|
| default | default addressbook |      |       |

```

--------------------------------

### List vCards with Cardamum

Source: https://docs.rs/cardamum

This command lists vCards within a specified addressbook. The output is a table showing ID, VERSION, FN (Full Name), EMAIL, and TEL.

```bash
$ cardamum card list default

| ID                                              | VERSION   | FN           | EMAIL                   | TEL             |
|-------------------------------------------------|-----------|--------------|-------------------------|-----------------|
| pimp_X3Xwu-58rVRwlbUeiptAUMyVK3HkJ45jJt3PjZaE7g | 3.0       | Forrest Gump | forrestgump@example.com | (404) 555-1212  |
| 62196d36-65cb-4a6b-b107-f3d8dc8d8b62            | 3.0       | Jean Dupont  | jean.dupont@example.com | +1234 56789     |


```

--------------------------------

### Set Apple Contacts Home URI

Source: https://docs.rs/cardamum

Optional override for the home URI to improve performance, retrieved from trace logs.

```properties
carddav.home-uri = "https://p156-contacts.icloud.com:443/17170244959/carddavhome/"
```

--------------------------------

### Configure Google Contacts OAuth 2.0

Source: https://docs.rs/cardamum

Uses Ortie for token management and enables discovery for Google Contacts.

```properties
carddav.auth.bearer.command = ["ortie", "token", "show"]
carddav.discover.host = "www.googleapis.com"
carddav.discover.method = "PROPFIND"
```

--------------------------------

### Override Posteo URIs

Source: https://docs.rs/cardamum

Hardcodes server and home URIs for faster Posteo connection calls.

```properties
carddav.server-uri = "https://posteo.de:8843"
carddav.home-uri = "https://posteo.de:8843/addressbooks/your.email/"
```

--------------------------------

### Configure Apple Contacts Authentication

Source: https://docs.rs/cardamum

Uses basic authentication with the iCloud server URI.

```properties
carddav.server-uri = "https://contacts.icloud.com"
carddav.auth.basic.username = "your.email@example.com"
carddav.auth.basic.password.raw = "p@$$w0rd"
```

--------------------------------

### Override Google Contacts URIs

Source: https://docs.rs/cardamum

Hardcodes server and home URIs to bypass slow discovery processes.

```properties
carddav.server-uri = "https://www.googleapis.com/carddav/v1/principals"
carddav.home-uri = "https://www.googleapis.com/carddav/v1/principals/your.email@gmail.com/lists"
```

--------------------------------

### Update vCard with Cardamum

Source: https://docs.rs/cardamum

Initiates an interactive session to update a specific vCard within an addressbook. Your default text editor will open with the vCard's content for editing.

```bash
$ cardamum card update default 62196d36-65cb-4a6b-b107-f3d8dc8d8b62

```

--------------------------------

### vCard Update Confirmation

Source: https://docs.rs/cardamum

This message is displayed upon successful update of a vCard using the Cardamum CLI.

```bash
Card successfully updated

```
Tokens:
Raw