@yizhuan-cli/cli

易撰命令行工具，用于通过 API Key 查询易撰真实数据。

安装

需要 Node.js 22 或更高版本。

npm install -g @yizhuan-cli/cli@latest

如果发布在私有 npm registry，请加上对应 registry：

npm install -g @yizhuan-cli/cli@latest --registry=https://your-private-registry.example

配置

创建 ~/.config/yizhuan/config.json：

{
  "apiBaseUrl": "https://yizhuan-api.yizhuan5.com",
  "apiKey": "yz_cli_xxx"
}

使用

yizhuan --help
yizhuan --version
yizhuan config path
yizhuan config show
yizhuan execute --ability membership
yizhuan execute --ability works --query "百家号昨天新增了哪些作品"
yizhuan execute --ability works --params '{"mode":"comments","platform":"douyin","workId":"123456","count":20}'
yizhuan execute --ability works --params '{"mode":"comments","platform":"douyin","title":"作品标题","count":20}'
yizhuan execute --ability hot_topics --platform douyin
yizhuan execute --ability hot_topics --params '{"platform":"douyin"}'
yizhuan execute --ability accounts --params '{"mode":"public_search","platform":"toutiao","keyword":"张三"}'
yizhuan execute --ability radar --params '{"mode":"following"}'
yizhuan execute --ability radar --mode timeline --timeRange 7d
yizhuan execute --ability radar --params '{"mode":"unfollow","articleId":"205169870"}'
yizhuan execute --ability radar --json-file params.json

PowerShell 参数说明

PowerShell 对 JSON 双引号转义不友好。推荐以下写法：

# Agent 和跨 Shell 最稳妥：参数文件是唯一输入源
yizhuan execute --ability hot_topics --json-file params.json

# 单引号包 JSON
yizhuan execute --ability hot_topics --params '{"platform":"douyin"}'

# key=value
yizhuan execute --ability hot_topics --params platform=douyin

execute --json-file 不能与 --params、--query 或独立参数混用。CLI 会拒绝未知参数和游离的 key=value，避免参数丢失后执行默认能力。

请避免 bash 风格的：

# 在 PowerShell 中容易失败
yizhuan execute --ability hot_topics --params "{\"platform\":\"douyin\"}"

支持的典型能力

• 作品查询：yizhuan execute --ability works --query "AI 相关的热门作品有哪些"
• 作品评论：yizhuan execute --ability works --params '{"mode":"comments","platform":"douyin","workId":"123456","count":20}'
• 按标题查询评论：yizhuan execute --ability works --params '{"mode":"comments","platform":"douyin","title":"作品标题"}'；标题必须唯一匹配，多个候选时 CLI 会要求补充条件。
• 微信公众号/视频号评论：yizhuan execute --ability works --params '{"mode":"comments","platform":"weixin","workId":"https://mp.weixin.qq.com/s/文章链接","count":20}'；这两个平台的 workId 使用作品链接。
• 作者查询：yizhuan execute --ability accounts --query "查询张三这个作者"
• 作者指标筛选：yizhuan execute --ability author_query --params '{"platform_id":2,"min_follower":500000,"min_total_likes":100000}'
• 作者全网搜索：yizhuan execute --ability accounts --params '{"mode":"public_search","platform":"toutiao","keyword":"张三"}'
• 关注全网作者：yizhuan execute --ability accounts --params '{"mode":"follow_public_author","platform":"toutiao","keyword":"张三","extAuthorId":"author-1"}'
• 热点查询：yizhuan execute --ability hot_topics --platform douyin
• 雷达查询：yizhuan execute --ability radar --params '{"mode":"following"}'
• 竞品动态：yizhuan execute --ability radar --mode timeline --timeRange 7d
• 竞品动态筛选：yizhuan execute --ability radar --params '{"mode":"timeline","timeRange":"7d","platform":"baijiahao","keyword":"AI"}'
• 取消关注雷达作者：先查询关注列表拿到 articleId，再执行 yizhuan execute --ability radar --params '{"mode":"unfollow","articleId":"205169870"}'
• 会员查询：yizhuan execute --ability membership --query "我的会员什么时候到期"
• 内容提取：yizhuan execute --ability content_extract --url "https://example.com/article"
• 易撰作品内容提取：yizhuan execute --ability content_extract --params '{"contentId":12345}'

如果你是通过 Codex、Cursor、Claude Code 这类 Agent 使用 CLI，也可以直接用自然语言提问，例如：

• 在头条号全网搜索张三这个作者
• 查询我关注账号近7天的竞品动态
• 查询 AI 相关的热门文章
• 取消关注陈某某先生
• 我的会员什么时候到期

纯创作请求（例如“写一篇中秋文章”）由当前 Agent 完成，不调用 content_extract；CLI 只提供真实内容素材，不负责生成、改写或发布。

使用统计

仅采集业务调用元数据，不采集问题、关键词、URL、正文或返回内容。 调用方可设置 YIZHUAN_TRIGGER=user_initiated 表示用户当前提问或手动触发（含 AI 代执行），设置 YIZHUAN_TRIGGER=automated 表示定时或无人值守任务。 未设置时归为 unknown，不会猜测来源。检测轮询不计活跃。通过 YIZHUAN_TELEMETRY=0 可关闭使用埋点。