docs: add CLI section to READMEs and restore @moemail/cli package name

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
ty
2026-03-22 16:05:57 +08:00
co-authored by Claude Opus 4.6
parent cb266a03dd
commit f66c3e83a9
4 changed files with 106 additions and 2 deletions
+52
View File
@@ -29,6 +29,7 @@
<a href="#发件功能">发件功能</a> •
<a href="#Webhook 集成">Webhook 集成</a> •
<a href="#OpenAPI">OpenAPI</a> •
<a href="#cli-工具">CLI 工具</a> •
<a href="#环境变量">环境变量</a> •
<a href="#Github OAuth App 配置">Github OAuth App 配置</a> •
<a href="#Google OAuth App 配置">Google OAuth App 配置</a> •
@@ -68,6 +69,7 @@
- 🔔 **Webhook 通知**:支持通过 webhook 接收新邮件通知
- 🛡️ **权限系统**:支持基于角色的权限控制系统
- 🔑 **OpenAPI**:支持通过 API Key 访问 OpenAPI
- 🤖 **Agent CLI**:专为 AI Agent 设计的命令行工具,自动化邮箱工作流
- 🌍 **多语言支持**:支持中文和英文界面,可自由切换
## 技术栈
@@ -785,6 +787,56 @@ const data = await res.json();
console.log('分享链接:', `https://your-domain.com/shared/message/${data.token}`);
```
## CLI 工具
MoeMail 提供了专为 AI Agent 设计的命令行工具,用于自动化邮箱工作流。
### 安装
```bash
npm i -g @moemail/cli
```
### 快速上手
```bash
# 配置 API 地址和密钥
moemail config set api-url https://moemail.app
moemail config set api-key YOUR_API_KEY
# 创建临时邮箱
moemail create --domain moemail.app --expiry 1h --json
# 等待新邮件(轮询)
moemail wait --email-id <id> --timeout 120 --json
# 读取邮件内容
moemail read --email-id <id> --message-id <id> --json
# 删除邮箱
moemail delete --email-id <id>
```
### Agent 工作流
AI Agent 仅需 3 次调用即可完成验证流程:
```bash
# 1. 创建邮箱
EMAIL=$(moemail create --domain moemail.app --expiry 1h --json)
EMAIL_ID=$(echo $EMAIL | jq -r '.id')
ADDRESS=$(echo $EMAIL | jq -r '.address')
# 2. 等待验证邮件
MSG=$(moemail wait --email-id $EMAIL_ID --timeout 120 --json)
MSG_ID=$(echo $MSG | jq -r '.messageId')
# 3. 读取内容,提取验证码
CONTENT=$(moemail read --email-id $EMAIL_ID --message-id $MSG_ID --json)
```
详细文档见 [packages/cli/README.md](packages/cli/README.md)。
## 环境变量
本项目使用以下环境变量: