Peter Steinberger be315dd311

docs: add clawdex.sh feature pages and Rolodex-themed site

Adds 14 per-feature docs pages under docs/ covering install, quickstart,
people, notes, timeline, search, avatars, imports, vCard export, git
sync, markdown storage, doctor, and config. Replaces the placeholder
landing page with a single-page Rolodex/index-card site that fetches and
renders the docs client-side via marked + highlight.js, with code syntax
highlighting and dark-mode support. .nojekyll keeps GitHub Pages serving
the markdown files raw to the SPA.

2026-05-08 16:50:41 +01:00

2.6 KiB

Raw Permalink Blame History

People

A person is the unit of clawdex. On disk, each person is a folder under people/ containing a person.md file, an optional avatars/ folder, and an optional notes/ folder. The folder slug is derived from the person's name — for example Sally O'Malley becomes sally-o-malley.

Add

clawdex person add "Sally O'Malley" \
  --email sally@example.com -e sally.alt@example.com \
  --phone "+1 555 0100" \
  --tag friend --tag dinner-club

Flags:

--email, -e — repeatable
--phone, -p — repeatable
--tag, -t — repeatable

--dry-run previews the planned slug without writing anything.

List

clawdex person list
clawdex person list --query sally
clawdex person list --json | jq '.[].name'

--query filters by substring match against name, ID, and tags. The default output is a TSV of id<TAB>name<TAB>first-email.

Show

clawdex person show sally
clawdex person show sally@example.com
clawdex person show "+15550100"
clawdex person show sally-o-malley   # exact ID

show accepts an ID, a substring of the name, an email, or a phone number. The first unambiguous match wins. If multiple people share a key, the command errors and asks you to be more specific.

Edit

clawdex person edit sally
EDITOR=nvim clawdex person edit sally

Opens the person's person.md in $EDITOR, falling back to code (Visual Studio Code) if EDITOR is unset. Clawdex re-reads the file on the next command — your edits are the source of truth.

You can also edit person.md directly in your shell, in another editor, or in a pull request review. The file is plain markdown:

---
id: sally-o-malley
name: Sally O'Malley
emails:
  - value: sally@example.com
phones:
  - value: "+15550100"
tags: [friend, dinner-club]
created_at: 2026-05-08T09:15:00Z
updated_at: 2026-05-08T09:15:00Z
---

# Sally O'Malley

Met at the dinner club in 2024. Loves Negronis.

If frontmatter gets damaged — a stray quote, a truncated YAML block — clawdex doctor --repair salvages what it can and preserves the body.

Avatars

Avatars are managed under clawdex person avatar. They're a feature on their own: see Avatars.

Bulk import

To populate clawdex from Apple Contacts, Google Contacts, X DMs, or Discord DMs in one shot, use Imports. Imports project into the same markdown shape — they don't bypass any of the rules above.

2.6 KiB Raw Permalink Blame History