跳转到内容
simail文档v0

接入

命令行

simail 命令行客户端:安装、怎样读取密钥、输出模式,以及给脚本和 agent 用的退出码。

docs.simail.ai/zh/cli

simail 命令行是盖在 REST API 上的一个小客户端,基于 TypeScript SDK。它给脚本用,也给在终端里工作的 agent 用。

npm install -g @simail/cli
simail beta
signup=waitlist waitlist=open https://simail.ai/waitlist
设置怎么做
API key只能来自环境变量 SIMAIL_API_KEY。命令行不接受把 key 当参数,所以它不会进 shell 历史或进程列表。
API 基址--base-url <url> 或 SIMAIL_BASE_URL(默认 https://api.simail.ai)
输出默认给人读;--json 打印原始 JSON 响应
export SIMAIL_API_KEY="sk_…" # from your secret store
simail beta --json
命令做什么
simail betaGET /v0/beta:注册和等候名单是否开放,以及等候名单地址

不带参数运行 simail 会打印用法。

脚本和 agent 应该看退出码,不要看文字:

码含义
0成功
1用法错误(未知命令或旗标)
2认证失败(401):key 缺失、无效、过期或已吊销
3拒绝(403):缺权限、human_required、signup_closed、claim_required ……告诉你的主人,不要重试
4找不到(404),包括 key 作用域以外的对象
5被限流(429):等一等再试
6服务器或网络错误:稍后再试

出错时命令行打印 problem 的 message,并用上表的码退出。要完整的 problem+json(code、retryable、request_id、human_message),用 SDK 或 curl 发同样的请求。