Clay
/install clay
Clay
Use clay to search, create, update, and manage your personal contact network from the command line.
Requirements
- A Clay account (clay.earth)
- Authenticate before using any commands:
clay login
Authentication
Log in (opens browser for OAuth):
clay login
Check authentication status:
clay status
Log out:
clay logout
Credentials are stored in ~/.config/clay.json.
Output Formats
All data commands support --format to control output:
json(default) — Pretty-printed JSONcsv— Comma-separated valuestsv— Tab-separated values
clay contacts:search --name "Alice" --format csv
clay emails:recent --format tsv
Contacts
Get a contact by ID:
clay contact --contact-id 12345
Search contacts:
clay contacts:search --name "Jane Smith"
clay contacts:search --work-history-company "Acme" --work-history-active true
clay contacts:search --education-history-school "MIT"
clay contacts:search --location-latitude 37.7749 --location-longitude -122.4194 --location-distance 50
clay contacts:search --last-email-date-gte "2025-01-01" --sort-field "last_email_date" --sort-direction "desc"
clay contacts:search --group-ids "starred" --limit 10
clay contacts:search --keywords "investor" --include-fields "name,email,title"
Create a contact:
clay contacts:create --first-name "Jane" --last-name "Doe" --email "[email protected]"
clay contacts:create --first-name "Bob" --title "CEO" --organization "Acme Inc" --birthday "1990-05-15"
Update a contact:
clay contacts:update --contact-id 12345 --title "CTO" --organization "NewCo"
clay contacts:update --contact-id 12345 --email "[email protected]" --phone "+1234567890"
Archive / restore contacts:
clay contacts:archive --contact-ids 12345
clay contacts:restore --contact-ids 12345
Merge duplicate contacts:
clay contacts:merge --contact-ids 12345 --contact-ids 67890
Notes
List notes in a date range:
clay notes --start "2025-01-01" --end "2025-12-31"
clay notes --contact-ids 12345
Create a note on a contact:
clay notes:create --contact-id 12345 --content "Met at the conference, very interested in partnerships."
clay notes:create --contact-id 12345 --content "Follow up next week" --reminder-date "2026-03-01T09:00:00Z"
Notes support contact references in content: [contact:123:John Doe].
Groups
List all groups:
clay groups
clay groups --limit 50
Create a group:
clay groups:create --title "Investors"
Update a group (rename, add/remove members):
clay groups:update --group-id 42 --title "Angel Investors"
clay groups:update --group-id 42 --add-contact-ids 12345 --add-contact-ids 67890
clay groups:update --group-id 42 --remove-contact-ids 11111
Events
List events in a date range:
clay events --start "2025-01-01" --end "2025-03-01"
clay events --contact-ids 12345
List upcoming events:
clay events:upcoming
clay events:upcoming --limit 20 --page 2
Emails
List emails in a date range:
clay emails --start "2025-01-01" --end "2025-02-01"
clay emails --contact-ids 12345
List recent emails:
clay emails:recent
clay emails:recent --limit 25 --contact-ids 12345
Reminders
List recent reminders:
clay reminders:recent
clay reminders:recent --limit 5
List upcoming reminders:
clay reminders:upcoming
clay reminders:upcoming --limit 20 --page 2
Search Options Reference
The contacts:search command supports filters for:
- Name:
--name - Work:
--work-history-company,--work-history-position,--work-history-active - Education:
--education-history-school,--education-history-degree,--education-history-active - Location:
--location-latitude,--location-longitude,--location-distance - Age:
--age-gte,--age-lte - Birthday:
--upcoming-birthday-gte/lte,--previous-birthday-gte/lte - Contact info:
--information-type(filter by type of info available) - Interaction dates:
--first-email-date-gte/lte,--last-email-date-gte/lte,--first-event-date-gte/lte,--last-event-date-gte/lte,--first-text-message-date-gte/lte,--last-text-message-date-gte/lte,--first-interaction-date-gte/lte,--last-interaction-date-gte/lte - Interaction counts:
--email-count-gte/lte,--event-count-gte/lte,--text-message-count-gte/lte - Notes:
--note-content,--note-date-gte/lte - Groups:
--group-ids(group ID or"starred") - Integration:
--integration - Sorting:
--sort-field,--sort-direction - Pagination:
--limit,--exclude-contact-ids - Fields:
--include-fields(select which fields to return)
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install clay - 安装完成后,直接呼叫该 Skill 的名称或使用
/clay触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
Clay 是什么?
Search, manage, and organize your contact network via the Clay CLI. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 226 次。
如何安装 Clay?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install clay」即可一键安装,无需额外配置。
Clay 是免费的吗?
是的,Clay 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。
Clay 支持哪些平台?
Clay 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(darwin, linux)。
谁开发了 Clay?
由 Keith Harrison(@khrrsn)开发并维护,当前版本 v1.0.0。