IronProse CLI — 小说写作助手

IronProse 针对削弱叙事效果的写作层面问题分析小说文本： 重复、弱动词、被动语态、陈词滥调、副词滥用、“展示而非讲述”原则违规，以及 100 多项专为创意写作调优的其他规则。

安装

# 通过 npm 安装（推荐）
npx ironprose --help

# 或通过 cargo 安装
cargo install ironprose-cli

常用工作流

分析文本（始终使用 JSON 输出）

# 全面分析 — JSON 是唯一稳定的输出格式
ironprose analyze --file chapter-07.md --output json

# 从 stdin 管道输入
cat draft.md | ironprose analyze --output json

# 原始 JSON 直通模式 — 零翻译损失，完全掌控 API
ironprose analyze 
  --json '{"text":"The dark night was very dark."}' 
  --output json

# 仅输出评分 — 最小化输出 token 数量
ironprose analyze --file chapter-07.md --output json --score-only

Schema 自省 — 调用前先探查

ironprose schema analyze   # 查看请求/响应结构
ironprose schema rate      # 查看评分载荷（rating payload）schema
ironprose schema           # 导出完整 OpenAPI 规范

对比草稿

# 重写是否提升了文本质量？
ironprose compare 
  --original-file draft_v1.md 
  --revised-file draft_v2.md 
  --output json

从编辑器 / stdin 管道输入

pbpaste | ironprose analyze --output json

对存疑诊断结果进行评分

完成文本分析后，可对任何您认为不准确的诊断结果进行评分。该操作将直接优化引擎的校准能力。

# JSON 直通模式 — 推荐用于 agent 场景
ironprose rate 
  --json '{"rule":"repetition","rating":"false_positive","diagnostic_id":"d-001","context":"Intentional repetition"}'

# 便捷参数模式 — 更适合人工操作或简单评分
ironprose rate 
  --rule repetition 
  --rating false_positive 
  --diagnostic-id d-001 
  --context "Intentional repetition for emphasis"

# 首先自省 rate 的 schema
ironprose schema rate

评分规则：

• 若分析响应中提供了 --diagnostic-id，请务必包含该参数
• 当被标记的问题实际并不存在时，使用 false_positive
• 当问题确实存在但不值得标记时，使用 not_helpful
• 当诊断结果准确且有价值时，使用 helpful 表示确认

CLI 参考手册

Agent 应使用 ironprose --help 获取特定命令的精确参数与标志列表，而不应仅依赖本文档。

ironprose

IronProse CLI — 作家专用文本分析工具

用法: ironprose [OPTIONS] 

命令:
  analyze     分析文本在风格、语法及写作技巧方面的潜在问题
  compare     对比原始文本与修订后文本
  list-rules  列出所有可用的分析规则
  schema      导出某端点的 API schema（供 agent 自省使用）
  rate        将某条诊断结果标记为 helpful、not_helpful 或 false_positive
  help        打印本帮助信息，或指定子命令的帮助信息

选项:
      --api-url   IronProse API 基础 URL [env: IRONPROSE_API_URL=] [默认值: https://prose-mcp.fly.dev]
      --api-key   用于认证访问的 API 密钥（可选，提供免费层级）[env: IRONPROSE_API_KEY=]
  -h, --help               打印帮助信息
  -V, --version            打印版本号

环境变量