be315dd311
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.
2.5 KiB
2.5 KiB
Clawdex
clawdex is a local-first, markdown-first personal contact index. The CLI
lives in this repo. Your contacts live in a separate private Git-backed
markdown repository that you own.
The whole thing is a Rolodex you can grep — every person is a folder, every
note is a timestamped markdown file, every change is a commit.
Try it
After installing and pointing clawdex at a data repo:
clawdex person add "Sally O'Malley" --email sally@example.com --tag friend
clawdex note add sally --kind dm --source whatsapp --text "Follow up about dinner"
clawdex timeline sally
clawdex search dinner
clawdex export vcard --all --include-avatars -o contacts.vcf
--json produces a stable JSON envelope on stdout. --plain produces TSV.
Human messages go to stderr, so pipes stay parseable.
What clawdex does
- Markdown is canonical. People are folders under
people/. Notes are timestamped files. Indexes underindex/are derived and rebuildable. - Git is the sync layer. No proprietary daemon, no opaque database.
clawdex git pushpushes to your private remote. - Imports are local-only. Apple, Google, Birdclaw (X DMs), and Discrawl (Discord DMs) all project into the same markdown shape. Address-book writes are still preview-only — see Imports.
- Avatars are real files. Stored next to each person;
vcardexport can embed them; manual avatars are never overwritten by imports. - Notes are local-only. They are never written to Apple or Google.
Pick your path
- Trying it. Install → Quickstart. Five
minutes from
brew installto your first commit. - Importing the network you already have. Imports covers Apple Contacts, Google Contacts, X DMs (birdclaw), and Discord DMs (discrawl).
- Daily use. People, Notes, Timeline, Search.
- Sharing back. vCard Export for round-tripping into Apple/Google/anything-else, Git Sync for the private backup remote.
- Repair and storage. Markdown Storage, Doctor, Config.
Project
Source: openclaw/clawdex. Changelog tracks what shipped recently. Released under the MIT license. Not affiliated with Apple, Google, X, or Discord.