快速开始

从源码运行

克隆仓库后即可运行桌面应用。加 --sample 会打开内置的示例文档《The Open Studio Handbook》，也可以直接传入一个文档路径。 首次构建需要下载并编译全部 crate，耗时较长。

git clone https://github.com/storytold/wordcraft
cd wordcraft
cargo run --release -p wordcraft -- --sample
cargo run --release -p wordcraft -- report.docx

命令行

wordcraft-cli 不需要打开窗口即可完成转换、抽取与自动化操作，适合放进脚本里。

wordcraft-cli convert report.docx report.pdf
wordcraft-cli text report.docx
wordcraft-cli inspect report.docx
wordcraft-cli run --template sample \
  --cmd 'select.text={"text":"Membership"}' --cmd format.bold --save out.docx

wordcraft-cli convert report.docx report.pdf

在 docx、pdf、odt、rtf、html、md、tex、txt、png 之间转换。

wordcraft-cli text report.docx

输出纯文本。

wordcraft-cli inspect report.docx

以 JSON 输出文档结构。

wordcraft-cli run --template sample --cmd '…' --save out.docx

按命令序列驱动文档，可重复执行并保存结果。

浏览器版本

Web 端由 Trunk 提供开发服务器。启动后打开 http://127.0.0.1:8771/?sample 即可在浏览器中运行整个应用。

cd apps/wordcraft-web && trunk serve

面向智能体

既可以注册无界面的命令行工具，也可以让 MCP 服务器连上正在运行的应用，让智能体在看得见界面的情况下操作。

claude mcp add wordcraft -- wordcraft-cli mcp
wordcraft --control 7981 &
claude mcp add wordcraft-app -- wordcraft-cli mcp --connect 127.0.0.1:7981

查看完整的工具清单

日志

桌面应用会把日志写入标准错误，以及其偏好设置旁边的 logs/wordcraft.log。从桌面菜单或 Dock 启动时没有终端，因此这个文件就是要附在缺陷报告里的内容。

• Linux

  $XDG_CONFIG_HOME/wordcraft/logs/

  默认 ~/.config/wordcraft/logs/

• macOS

  ~/Library/Application Support/WordCraft/logs/

• Windows

  %APPDATA%\WordCraft\logs\

• 每次启动会把上一次的日志移到 wordcraft.1.log，再把那份移到 wordcraft.2.log，因此一次崩溃运行的日志会在下次启动后保留。
• 日志增长到 16 MiB 后停止写入。--version 不写文件，以 WORDCRAFT_NO_PREFS 运行只写入标准错误。
• 文档文本永远不会被记录，崩溃信息会省略它所引用的文本。
• 默认情况下 WordCraft 自身的 crate 以 info 级别记录，其余一切以 warn。RUST_LOG 会将其替换为 env_logger 风格的规则，例如 RUST_LOG=warn,wordcraft_docx=trace。