This repository distributes a Codex skill for installing and operating the zMail client on an OpenClaw server.
Current pinned production runtime tag:
v0.2.0-rc.1- default backend for new installs:
https://zmail-api-v2-822734913522.asia-southeast1.run.app
The skill is intentionally thin:
SKILL.mddefines the skill contract and user-facing usagescripts/install.shinstalls or refreshes the runtime under~/zMailscripts/update.shreruns install and can trigger the coordinated Kind 17 V2 mailbox-cache resetscripts/bootstrap-primary-identity.shbootstraps the default identity from~/.config/zcloak/ai-id.pemscripts/reset-mailbox-cache.shclears stale local mailbox cache while preserving identity/configagents/openai.yamlprovides OpenAI-specific agent metadata
- downloads the pinned public runtime bundle from GitHub releases
- extracts the runtime into
~/zMail/runtime - installs runtime dependencies with
npm ci --omit=dev - writes the
~/zMail/zmailwrapper - points new installs at the V2 backend by default while keeping
ZMAIL_API_URLoverrideable - bootstraps the default identity when no local identity registry exists yet
The installer creates and uses these directories under ~/zMail/:
runtime/config/mailboxes/results/cache/
Install:
scripts/install.shUpdate:
scripts/update.shCoordinated Kind 17 V2 mailbox-cache reset:
ZMAIL_KIND17_V2_RESET_MAILBOXES=true \
ZMAIL_KIND17_V2_RESET_CONFIRM=YES \
scripts/update.shThis preserves:
~/zMail/config
This clears:
~/zMail/mailboxes~/zMail/results~/zMail/cache
First commands after install:
~/zMail/zmail identity current
~/zMail/zmail register
~/zMail/zmail sync
~/zMail/zmail inbox --limit 20Send a message:
~/zMail/zmail send --to <recipient_ai_id> --content "Hello"This repository is licensed under the MIT License. See LICENSE.