KHARD-SUBCOMMANDS(1)

🦋 KHARD-SUBCOMMANDS 💅

(that's khard-subcommands(1) from the khard manual, bestie — welcome to the group chat)

✨ NAME ✨

khard-subcommands — literally all the subcommands of khard

These are every single subcommand and every accepted argument of khard(1), no gatekeeping, all of it:

usage: khard [-h] [-c CONFIG] [--debug] [--skip-unparsable] [-v]
             SUBCOMMAND ...

---

🎀 POSITIONAL ARGUMENTS 🎀

• SUBCOMMAND — the actual thing you want to do. Possible choices, and yes this is the whole guest list: list, ls, show, details, template, birthdays, bdays, email, phone, postaddress, post, postaddr, new, add, add-email, merge, edit, modify, ed, copy, cp, move, mv, remove, delete, del, rm, addressbooks, abooks, filename, file

🌸 NAMED ARGUMENTS 🌸

• -c, --config — the config file to use
• --debug — turn on debug output (for when the vibes are off and you need to know why)
• --skip-unparsable — skip the vcard files it can't parse, like, just don't look at them
• -v, --version — show the program's version number and dip

---

💖 SUB-COMMANDS 💖

⭐ list (ls)

list all the (selected) contacts, aka the main character of this whole operation

khard list [-h] [-a ADDRESSBOOK] [-f]
           [-d {first_name,last_name,formatted_name}] [-g] [-r]
           [-s {first_name,last_name,formatted_name}] [-p] [-F FIELDS]
           [search terms ...]

Positional Arguments

• search terms — search in the specified fields, or in all of them, to find a matching contact
  • Default: []

Named Arguments

• -a, --addressbook — specify one or several comma separated address book names to narrow down the list of contacts
  • Default: []
• -f, --search-in-source-files — look into the source vcf files to speed up search queries in large address books. ⚠️ Beware, bestie: this option could lead to incomplete results.
• -d, --display — display names in the contact table by first or last name
  • Possible choices: first_name, last_name, formatted_name
• -g, --group-by-addressbook — group the contact table by address book
• -r, --reverse — reverse the order of the contact table
• -s, --sort — sort the contact table by first or last name
  • Possible choices: first_name, last_name, formatted_name
• -p, --parsable — machine readable format: uidtcontact_nametaddress_book_name
  • Default: False
• -F, --fields — comma separated list of fields to show (use -F help for a list of top level fields)
  • Default: []

---

⭐ show (details)

display detailed information about one contact — the deep dive, the full lore

khard show [-h] [-a ADDRESSBOOK] [-f]
           [-d {first_name,last_name,formatted_name}] [-g] [-r]
           [-s {first_name,last_name,formatted_name}]
           [--format {pretty,yaml,vcard}] [-o OUTPUT_FILE]
           [search terms ...]

Positional Arguments

• search terms — search in the specified fields, or in all of them, to find a matching contact
  • Default: []

Named Arguments

• -a, --addressbook — specify one or several comma separated address book names to narrow down the list of contacts
  • Default: []
• -f, --search-in-source-files — look into the source vcf files to speed up search queries in large address books. ⚠️ Beware that this option could lead to incomplete results.
• -d, --display — display names in the contact table by first or last name
  • Possible choices: first_name, last_name, formatted_name
• -g, --group-by-addressbook — group the contact table by address book
• -r, --reverse — reverse the order of the contact table
• -s, --sort — sort the contact table by first or last name
  • Possible choices: first_name, last_name, formatted_name
• --format — select the output format
  • Possible choices: pretty, yaml, vcard
  • Default: 'pretty'
• -o, --output-file — specify the output template file name, or use stdout by default
  • Default: <_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>

---

⭐ template

print an empty yaml template — a blank canvas, a fresh start, main character energy 🫶

khard template [-h]

---

⭐ birthdays (bdays)

list birthdays (sorted by month and day) so you never miss a "hbd" text again 😭

khard birthdays [-h] [-a ADDRESSBOOK] [-f]
                [-d {first_name,last_name,formatted_name}] [-p]
                [search terms ...]

Positional Arguments

• search terms — search in the specified fields, or in all of them, to find a matching contact
  • Default: []

Named Arguments

• -a, --addressbook — specify one or several comma separated address book names to narrow down the list of contacts
  • Default: []
• -f, --search-in-source-files — look into the source vcf files to speed up search queries in large address books. ⚠️ Beware that this option could lead to incomplete results.
• -d, --display — display names in the birthdays table by first or last name
  • Possible choices: first_name, last_name, formatted_name
• -p, --parsable — machine readable format: nametdate
  • Default: False

---

⭐ email

list email addresses — the contact info speedrun

khard email [-h] [-a ADDRESSBOOK] [-f]
            [-d {first_name,last_name,formatted_name}] [-g] [-r]
            [-s {first_name,last_name,formatted_name}] [-p]
            [--remove-first-line]
            [search terms ...]

Positional Arguments

• search terms — search in the specified fields, or in all of them, to find a matching contact
  • Default: []

Named Arguments

• -a, --addressbook — specify one or several comma separated address book names to narrow down the list of contacts
  • Default: []
• -f, --search-in-source-files — look into the source vcf files to speed up search queries in large address books. ⚠️ Beware that this option could lead to incomplete results.
• -d, --display — display names in the contact table by first or last name
  • Possible choices: first_name, last_name, formatted_name
• -g, --group-by-addressbook — group the contact table by address book
• -r, --reverse — reverse the order of the contact table
• -s, --sort — sort the contact table by first or last name
  • Possible choices: first_name, last_name, formatted_name
• -p, --parsable — machine readable format: addresstnamettype
  • Default: False
• --remove-first-line — remove the "searching for '' ..." line from the parsable output (that line is required by mutt, so like, mutt needs it, keep that in mind)
  • Default: False

---

⭐ phone

list phone numbers 📞

khard phone [-h] [-a ADDRESSBOOK] [-f]
            [-d {first_name,last_name,formatted_name}] [-g] [-r]
            [-s {first_name,last_name,formatted_name}] [-p]
            [search terms ...]

Positional Arguments

• search terms — search in the specified fields, or in all of them, to find a matching contact
  • Default: []

Named Arguments

• -a, --addressbook — specify one or several comma separated address book names to narrow down the list of contacts
  • Default: []
• -f, --search-in-source-files — look into the source vcf files to speed up search queries in large address books. ⚠️ Beware that this option could lead to incomplete results.
• -d, --display — display names in the contact table by first or last name
  • Possible choices: first_name, last_name, formatted_name
• -g, --group-by-addressbook — group the contact table by address book
• -r, --reverse — reverse the order of the contact table
• -s, --sort — sort the contact table by first or last name
  • Possible choices: first_name, last_name, formatted_name
• -p, --parsable — machine readable format: numbertnamettype
  • Default: False

---

⭐ postaddress (post, postaddr)

list postal addresses — the snail mail situation 💌

khard postaddress [-h] [-a ADDRESSBOOK] [-f]
                  [-d {first_name,last_name,formatted_name}] [-g] [-r]
                  [-s {first_name,last_name,formatted_name}] [-p]
                  [search terms ...]

Positional Arguments

• search terms — search in the specified fields, or in all of them, to find a matching contact
  • Default: []

Named Arguments

• -a, --addressbook — specify one or several comma separated address book names to narrow down the list of contacts
  • Default: []
• -f, --search-in-source-files — look into the source vcf files to speed up search queries in large address books. ⚠️ Beware that this option could lead to incomplete results.
• -d, --display — display names in the contact table by first or last name
  • Possible choices: first_name, last_name, formatted_name
• -g, --group-by-addressbook — group the contact table by address book
• -r, --reverse — reverse the order of the contact table
• -s, --sort — sort the contact table by first or last name
  • Possible choices: first_name, last_name, formatted_name
• -p, --parsable — machine readable format: addresstnamettype
  • Default: False

---

⭐ new (add)

create a new contact, fresh out of the box, new contact smell ✨

khard new [-h] [-a ADDRESSBOOK] [-i INPUT_FILE] [--open-editor]
          [--vcard-version {3.0,4.0}]

Named Arguments

• -a, --addressbook — specify the address book in which to create the new contact
  • Default: []
• -i, --input-file — specify the input template file name, or use stdin by default
  • Default: '-'
• --open-editor, --edit — open the default text editor after successfully creating the new contact
  • Default: False
• --vcard-version — select the preferred vcard version for the new contact
  • Possible choices: 3.0, 4.0

---

⭐ add-email

extract the email address from the "From:" field of an email header and add it to an existing contact, or create a new one — iykyk, this one's a lifesaver

khard add-email [-h] [-a ADDRESSBOOK] [-i INPUT_FILE] [-f]
                [-d {first_name,last_name,formatted_name}] [-g] [-r]
                [-s {first_name,last_name,formatted_name}]
                [--vcard-version {3.0,4.0}] [-H HEADERS]
                [--skip-already-added]
                [search terms ...]

Positional Arguments

• search terms — search in the specified fields, or in all of them, to find a matching contact
  • Default: []

Named Arguments

• -a, --addressbook — specify one or several comma separated address book names to narrow down the list of contacts
  • Default: []
• -i, --input-file — specify the input email header file name, or use stdin by default
  • Default: '-'
• -f, --search-in-source-files — look into the source vcf files to speed up search queries in large address books. ⚠️ Beware that this option could lead to incomplete results.
• -d, --display — display names in the contact table by first or last name
  • Possible choices: first_name, last_name, formatted_name
• -g, --group-by-addressbook — group the contact table by address book
• -r, --reverse — flips the contact table order, no cap. Reverse it, bestie. 🔄
• -s, --sort — Possible choices: first_name, last_name, formatted_name. Sort contact table by first or last name. Iconic sorting behavior. ✨
• --vcard-version — Possible choices: 3.0, 4.0. Select preferred vcard version for new contact. Choose your fighter. 🎀
• -H, --headers — Extract contacts from the given comma separated header fields. all searches all headers. Default: ['from']. Literally pulling contacts out of your headers. 💌
• --skip-already-added — Skip already added email addresses. Default: False. No duplicates, we don't do that here. 🙅‍♀️

🫶 merge

merge two contacts — two become one, main character energy.

          khard merge [-h] [-a ADDRESSBOOK] [-A TARGET_ADDRESSBOOK] [-f]
                      [-t TARGET_CONTACT] [-d {first_name,last_name,formatted_name}]
                      [-g] [-r] [-s {first_name,last_name,formatted_name}]
                      [source ...]

📍 Positional Arguments

• source — search in specified or all fields to find matching source contact. Default: []

🏷️ Named Arguments

• -a, --addressbook — Specify one or several comma separated address book names to narrow the list of source contacts. Default: []
• -A, --target-addressbook — Specify one or several comma separated address book names to narrow the list of target contacts. Default: []
• -f, --search-in-source-files — Look into source vcf files to speed up search queries in large address books. Beware that this option could lead to incomplete results. ⚠️
• -t, --target-contact, --target — search for a matching target contact. Finding the one. 🎯
• -d, --display — Possible choices: first_name, last_name, formatted_name. Display names in contact table by first or last name.
• -g, --group-by-addressbook — Group contact table by address book. Organize the chaos. 🗂️
• -r, --reverse — Reverse order of contact table.
• -s, --sort — Possible choices: first_name, last_name, formatted_name. Sort contact table by first or last name.

💅 edit (modify, ed)

edit the data of a contact — glow-up time for your contact info.

          khard edit [-h] [-a ADDRESSBOOK] [-i INPUT_FILE] [--open-editor] [-f]
                     [-d {first_name,last_name,formatted_name}] [-g] [-r]
                     [-s {first_name,last_name,formatted_name}] [--format {yaml,vcard}]
                     [search terms ...]

📍 Positional Arguments

• search terms — search in specified or all fields to find matching contact. Default: []

🏷️ Named Arguments

• -a, --addressbook — Specify one or several comma separated address book names to narrow the list of contacts. Default: []
• -i, --input-file — Specify input template file name or use stdin by default. Default: '-'
• --open-editor, --edit — Open the default text editor after successful creation of new contact. Default: False. Editor girlies rise. 📝
• -f, --search-in-source-files — Look into source vcf files to speed up search queries in large address books. Beware that this option could lead to incomplete results. ⚠️
• -d, --display — Possible choices: first_name, last_name, formatted_name. Display names in contact table by first or last name.
• -g, --group-by-addressbook — Group contact table by address book.
• -r, --reverse — Reverse order of contact table.
• -s, --sort — Possible choices: first_name, last_name, formatted_name. Sort contact table by first or last name.
• --format — Possible choices: yaml, vcard. specify the file format to use when editing. Default: 'yaml'. Pick your format, bestie. 🦋

🧚 copy (cp)

copy a contact to a different addressbook — dupe it, but make it cute.

          khard copy [-h] [-a ADDRESSBOOK] [-A TARGET_ADDRESSBOOK] [-f]
                     [-d {first_name,last_name,formatted_name}] [-g] [-r]
                     [-s {first_name,last_name,formatted_name}]
                     [search terms ...]

📍 Positional Arguments

• search terms — search in specified or all fields to find matching contact. Default: []

🏷️ Named Arguments

• -a, --addressbook — Specify one or several comma separated address book names to narrow the list of contacts. Default: []
• -A, --target-addressbook — Specify target address book in which to copy / move the selected contact. Default: []
• -f, --search-in-source-files — Look into source vcf files to speed up search queries in large address books. Beware that this option could lead to incomplete results. ⚠️
• -d, --display — Possible choices: first_name, last_name, formatted_name. Display names in contact table by first or last name.
• -g, --group-by-addressbook — Group contact table by address book.
• -r, --reverse — Reverse order of contact table.
• -s, --sort — Possible choices: first_name, last_name, formatted_name. Sort contact table by first or last name.

🦋 move (mv)

move a contact to a different addressbook — same energy as copy but it ghosts the original addressbook.

          khard move [-h] [-a ADDRESSBOOK] [-A TARGET_ADDRESSBOOK] [-f]
                     [-d {first_name,last_name,formatted_name}] [-g] [-r]
                     [-s {first_name,last_name,formatted_name}]
                     [search terms ...]

📍 Positional Arguments

• search terms — search in specified or all fields to find matching contact. Default: []

🏷️ Named Arguments

• -a, --addressbook — Specify one or several comma separated address book names to narrow the list of contacts. Default: []
• -A, --target-addressbook — Specify target address book in which to copy / move the selected contact. Default: []
• -f, --search-in-source-files — Look into source vcf files to speed up search queries in large address books. Beware that this option could lead to incomplete results. ⚠️
• -d, --display — Possible choices: first_name, last_name, formatted_name. Display names in contact table by first or last name.
• -g, --group-by-addressbook — Group contact table by address book.
• -r, --reverse — Reverse order of contact table.
• -s, --sort — Possible choices: first_name, last_name, formatted_name. Sort contact table by first or last name.

💀 remove (delete, del, rm)

remove a contact — goodbye, farewell, delete that entry.

          khard remove [-h] [-a ADDRESSBOOK] [-f]
                       [-d {first_name,last_name,formatted_name}] [-g] [-r]
                       [-s {first_name,last_name,formatted_name}] [--force]
                       [search terms ...]

📍 Positional Arguments

• search terms — search in specified or all fields to find matching contact. Default: []

🏷️ Named Arguments

• -a, --addressbook — Specify one or several comma separated address book names to narrow the list of contacts. Default: []
• -f, --search-in-source-files — Look into source vcf files to speed up search queries in large address books. Beware that this option could lead to incomplete results. ⚠️
• -d, --display — Possible choices: first_name, last_name, formatted_name. Display names in contact table by first or last name.
• -g, --group-by-addressbook — Group contact table by address book.
• -r, --reverse — Reverse order of contact table.
• -s, --sort — Possible choices: first_name, last_name, formatted_name. Sort contact table by first or last name.
• --force — Remove contact without confirmation. Default: False. No take-backs, bestie. 😭

🌈 addressbooks (abooks)

list addressbooks — literally just showing you the addressbook menu.

          khard addressbooks [-h]

That's it. That's the whole vibe. 💅

🍓 filename (file)

list filenames of all matching contacts — showing you where each contact file lives.

          khard filename [-h] [-a ADDRESSBOOK] [-f]
                         [-d {first_name,last_name,formatted_name}] [-g] [-r]
                         [-s {first_name,last_name,formatted_name}]
                         [search terms ...]

📍 Positional Arguments

• search terms — search in specified or all fields to find matching contact. Default: []

🏷️ Named Arguments

• -a, --addressbook — Specify one or several comma separated address book names to narrow the list of contacts. Default: []
• -f, --search-in-source-files — Look into source vcf files to speed up search queries in large address books. Beware that this option could lead to incomplete results. ⚠️
• -d, --display — Possible choices: first_name, last_name, formatted_name. Display names in contact table by first or last name.
• -g, --group-by-addressbook — Group contact table by address book.
• -r, --reverse — Reverse order of contact table.
• -s, --sort — Possible choices: first_name, last_name, formatted_name. Sort contact table by first or last name.

👀 SEE ALSO

khard(1).

©️ Copyright

2020, Eric Scheibler

---

💖 That's the whole page, bestie. This iconic manual is KHARD-SUBCOMMANDS(1) from khard version 0.22, dated Jan 02, 1980 — periodt. 🎀✨