IronProse CLI — Fiction Writing Assistant
IronProse analyzes fiction prose for craft-level issues that weaken storytelling:
repetition, weak verbs, passive voice, clichés, adverb overuse, show-don't-tell
violations, and 100+ other rules tuned for creative writing.
Installation
CODEBLOCK0
Common Workflows
Analyze prose (always use JSON output)
CODEBLOCK1
Schema introspection — discover before you call
CODEBLOCK2
Compare drafts
CODEBLOCK3
Pipe from editor / stdin
CODEBLOCK4
Rate diagnostics you disagree with
After analyzing text, rate any diagnostics that seem off. This directly
improves the engine's calibration.
CODEBLOCK5
Rules for rating:
- - Always include
--diagnostic-id when available (from the analyze response) - Use
false_positive when the flagged issue isn't actually present - Use
not_helpful when the issue exists but isn't worth flagging - Use
helpful to confirm good diagnostics
CLI Reference
Agents should use ironprose <command> --help to introspect exact arguments and flags for a specific command instead of relying purely on this document.
ironprose
CODEBLOCK6
Environment Variables
| Variable | Description | Default |
|---|
| INLINECODE6 | API base URL | INLINECODE7 |
| INLINECODE8 |
API key for authenticated access | free tier (5000 words) |
IronProse CLI — 小说写作助手
IronProse 分析小说文本中削弱叙事效果的技巧层面问题:重复、弱动词、被动语态、陈词滥调、副词滥用、展示而非告知违规,以及100多条针对创意写作优化的规则。
安装
bash
通过 npm 安装(推荐)
npx ironprose --help
或通过 cargo 安装
cargo install ironprose-cli
常见工作流
分析文本(始终使用 JSON 输出)
bash
完整分析 — JSON 是唯一稳定的输出格式
ironprose analyze --file chapter-07.md --output json
从标准输入管道输入
cat draft.md | ironprose analyze --output json
原始 JSON 透传 — 零翻译损失,完整 API 控制
ironprose analyze \
--json {text:The dark night was very dark.} \
--output json
仅评分 — 最小化输出标记
ironprose analyze --file chapter-07.md --output json --score-only
模式自省 — 调用前先探索
bash
ironprose schema analyze # 查看请求/响应结构
ironprose schema rate # 查看评分负载模式
ironprose schema # 导出完整 OpenAPI 规范
比较草稿
bash
改写是否提升了文本质量?
ironprose compare \
--original-file draft_v1.md \
--revised-file draft_v2.md \
--output json
从编辑器/标准输入管道输入
bash
pbpaste | ironprose analyze --output json
对不认同的诊断进行评分
分析文本后,对任何看起来不准确的诊断进行评分。这能直接改进引擎的校准。
bash
JSON 透传 — 适合智能体使用
ironprose rate \
--json {rule:repetition,rating:false
positive,diagnosticid:d-001,context:Intentional repetition}
便捷标志 — 适合人类或简单评分
ironprose rate \
--rule repetition \
--rating false_positive \
--diagnostic-id d-001 \
--context Intentional repetition for emphasis
先自省评分模式
ironprose schema rate
评分规则:
- - 始终在可用时包含 --diagnostic-id(来自分析响应)
- 当标记的问题实际上不存在时使用 falsepositive
- 当问题存在但不值得标记时使用 nothelpful
- 使用 helpful 确认良好的诊断
CLI 参考
智能体应使用 ironprose --help 自省特定命令的确切参数和标志,而非仅依赖本文档。
ironprose
IronProse CLI — 面向写作者的文本分析工具
用法:ironprose [选项] <命令>
命令:
analyze 分析文本的风格、语法和技巧问题
compare 比较原始文本和修改后文本
list-rules 列出所有可用的分析规则
schema 导出端点的 API 模式(智能体自省)
rate 将诊断评为 helpful、nothelpful 或 falsepositive
help 打印此消息或给定子命令的帮助信息
选项:
--api-url URL> IronProse API 基础 URL [环境变量:IRONPROSEAPI_URL=] [默认值:https://prose-mcp.fly.dev]
--api-key KEY> 用于认证访问的 API 密钥(可选,提供免费层级)[环境变量:IRONPROSEAPI_KEY=]
-h, --help 打印帮助信息
-V, --version 打印版本信息
环境变量
| 变量 | 描述 | 默认值 |
|---|
| IRONPROSEAPIURL | API 基础 URL | https://prose-mcp.fly.dev |
| IRONPROSEAPIKEY |
用于认证访问的 API 密钥 | 免费层级(5000词) |