Frenchie

@lab94/frenchie

Frenchie — 您的 Agent 好伙伴。

只需一条命令，即可在编码 Agent 中安装 Frenchie。Frenchie Kit 为 Agent 提供文件和多模态能力：读取 PDF 和图像、转录音频和视频、将 Office/CSV 文件提取为 Markdown，以及根据文本提示词生成图像。Frenchie Method 为团队提供从需求到发布的结构化工作流。

从 0.1.x 或 0.2.x 升级？ 请参阅 MIGRATION.md，了解 0.3.0 中的破坏性变更（stdio 仅返回元数据的响应、绝对路径 MCP 配置、新增 mcp --help / --selftest 标志）。

此软件包包含：

• Frenchie Kit（/ocr、/transcribe、/extract、/generate-image、/frenchie-status 命令 + HTTP/stdio MCP 使用指南）
• Frenchie Method（/frenchie-method、/requirement、/qa-analysis、/implement、/run-test、/pr-review、/release-check 及相关工作流命令）
• 随 npx 一同打包的 Frenchie stdio MCP 服务（lab94-frenchie mcp）
• 一个可将技能和 MCP 配置接入 Agent 的安装程序

快速开始

1. 安装技能

在项目根目录中：

npx @lab94/frenchie install

这会安装 Frenchie Kit 和 Frenchie Method 技能。Method 仅使用文本，无需 API 密钥即可运行。

可选的 Method 配置：

npx @lab94/frenchie install --init-method

这会创建 .frenchie/method.config.json 和 .frenchie/.gitignore；不会修改根目录下的 .gitignore。

2. 需要文件或图像能力时，登录以使用 Kit MCP 工具

在 getfrenchie.dev 创建账户。首次注册可获得 100 个免费点数，每个邮箱限领一次。无需银行卡。

然后连接本地 Agent：

npx @lab94/frenchie login

登录命令会打开浏览器设备码流程，然后将 FRENCHIE_API_KEY 写入安装程序创建的 MCP 配置。完整密钥不会被打印出来。

如果你已有从控制面板获取的密钥，可使用以下备用方式：

npx @lab94/frenchie install --api-key fr_your_key_here

若要指定某个 Agent：

npx @lab94/frenchie login --agent claude
npx @lab94/frenchie login --agent cursor
npx @lab94/frenchie login --agent codex
npx @lab94/frenchie login --agent vscode
npx @lab94/frenchie login --agent gemini

Antigravity、Windsurf、Zed、Claude Desktop 的用户级安装需要使用 --global 标志——自动检测绝不会写入 $HOME 目录：

npx @lab94/frenchie login --agent antigravity   --global
npx @lab94/frenchie login --agent windsurf       --global
npx @lab94/frenchie login --agent zed            --global
npx @lab94/frenchie login --agent claude-desktop --global

使用现有密钥的备用方式：

npx @lab94/frenchie install --agent claude        --api-key fr_…
npx @lab94/frenchie install --agent codex         --api-key fr_…
npx @lab94/frenchie install --agent antigravity   --global --api-key fr_…
npx @lab94/frenchie install --agent claude-desktop --global --api-key fr_…

登录后，Agent 可以调用 ocr_to_markdown、transcribe_to_markdown、extract_to_markdown 或 generate_image。OCR/转录/提取结果会自动保存到 .frenchie/<name>/result.md；生成的图像会保存到 .frenchie/<slug>/generated.<ext>。

后续升级

发布新版 Frenchie 后，每个 MCP 配置中固定的软件包版本（@lab94/[email protected]）都需要更新为新版本，这样 npx 才不会继续提供缓存的旧版程序包。以下两个升级命令即可完成所有操作：

# Project-scoped configs in this directory (.mcp.json, .cursor/mcp.json, .codex/config.toml, etc.)
npx @lab94/frenchie@latest install

# Every $HOME config that already has a frenchie entry — Antigravity, Claude Desktop, Windsurf, Zed,
# and any global Claude Code / Cursor / Codex / Gemini configs you set up. cwd doesn't matter.
npx @lab94/frenchie@latest install --global

install --global 是升级模式：它只会重写现有的 frenchie 条目，不会在 $HOME 下擅自安装任何新内容。首次全局安装仍需使用 install --agent <name> --global。

3. 重启 Agent

安装程序会输出适用于你的 Agent 的重启提示。重启后，提出以下请求：

OCR ./report.pdf with Frenchie

……Frenchie 就会接手处理。

如需编排工作流，请提出以下请求：

/frenchie-method

对于使用单个 Frenchie 命令的 Agent，/frenchie 仍是 Kit 的入口命令。它不是 Method 的别名。

托管 Agent（Lovable、Manus、Claude.ai、ChatGPT.com、Le Chat）

这些 Agent 无法运行本地 npm 二进制文件。请改用托管 MCP 端点：

URL:    https://mcp.getfrenchie.dev
Header: Authorization: Bearer fr_your_key_here

相同的 @lab94/frenchie 技能文件也适用于 HTTP 模式——使用 install --agent <name> 安装一次即可，随附的 SKILL.md 会告诉 Agent 在调用 OCR/转录/提取之前，通过 upload_file 上传文件。在 HTTP 模式下，图像生成无需上传步骤；它会返回一个短期有效的 imageUrl，Agent 应下载该图像并提供给用户。

你将获得的功能

Frenchie Kit

命令	作用
/ocr <file>	将 PDF 或图像解析为 Markdown
/transcribe <file>	将音频或视频解析为 Markdown 转录文本
/extract <file>	将 DOCX、XLSX、CSV、TSV 或 PPTX 解析为 Markdown
/generate-image <prompt>	根据文本提示词生成单张图像
/frenchie-status	查看额度和近期任务

在底层，Frenchie 会提供以下 MCP 工具：

• ocr_to_markdown
• transcribe_to_markdown
• extract_to_markdown
• generate_image
• get_job_result
• upload_file（仅限 HTTP 模式）
• fetch_result_file（仅限 HTTP 模式）

Frenchie Method

斜杠记法是规范的 Method 命令名称。Claude Code 会直接读取命令文件。Codex Desktop 可通过 requirement 和 qa-analysis 等包装技能获取相同条目；安装后，请先重启 Codex，再尝试 /requirement。不支持斜杠命令的宿主可使用自然语言，例如 Frenchie Method requirement ...。

命令	作用
/frenchie-method	通过 Method 将任务从需求推进到发布
/method-check	验证 Method 配置、产物、关卡和下一步操作
/requirement	将请求转化为范围明确的需求
/qa-analysis / /test-case	在制定实现计划前设计验证方案
/sa-analysis / /implementation-plan	分析架构和实现方案
/implement	使用当前 Agent 根据 Method 产物执行任务
/run-test	运行仓库声明的验证，并撰写测试报告
/pr-review / /review-pr	审查结果、测试、安全性和产物偏差
/release-check	只读发布就绪检查关卡

Method 会将可选工作流产物存储在 .frenchie/docs/feature/ 下。install --init-method 还会在 .frenchie/method.config.json 中写入可见的 skillTriggers 框架；命令键为空槽位，团队可以填入已安装的 Agent 技能，例如 "requirement": ["brainstorming"]。团队可自行决定是否提交或忽略 Method 配置和产物。

调用方式 — 如何在各类 Agent 中调用 Frenchie

每种 Agent 处理 MCP 的方式都略有不同。/ocr 是仅限 Claude Code 的斜杠命令；Method 斜杠命令取决于宿主，在 Claude Code 以外的平台上需使用 Codex 包装技能。其他 Agent 则使用自然语言、@ 提及或服务器名称斜杠命令。以下所有信息均已通过 dogfood 验证。

Agent	调用方式	完整指南
Claude Code	/ocr TOR.pdf	文档
Cursor	Use Frenchie to OCR TOR.pdf	文档
Codex（桌面版 / CLI / IDE）	Kit：/frenchie TOR.pdf · @frenchie ocr TOR.pdf；Method：重启后使用 /requirement，或使用 Frenchie Method requirement ...	文档
Antigravity	/frenchie TOR.pdf（按服务器名称调用）	文档
VS Code Copilot	/frenchie TOR.pdf	文档
Claude Desktop	Use Frenchie to OCR TOR.pdf	文档
Windsurf	OCR TOR.pdf via Frenchie	文档
Gemini CLI	OCR TOR.pdf with Frenchie	文档
Zed	OCR TOR.pdf via Frenchie	文档

遇到问题？请查看按症状查找的故障排除指南——dogfood 测试中遇到的每种错误都有对应的规范条目。

定价

价格清晰，无订阅费用。

文件提取定价：DOCX 每页 0.5 个额度，XLSX 每个工作表 0.5 个额度，CSV/TSV 每个文件 0.5 个额度，PPTX 每张幻灯片 1 个额度。

操作	费用
OCR	每页 1 个额度
转录	每分钟 2 个额度
DOCX 提取	每页 0.5 个额度
XLSX 提取	每个工作表 0.5 个额度
CSV/TSV 提取	每个文件 0.5 个额度
PPTX 提取	每张幻灯片 1 个额度
图像生成	每张图像 20 个额度

1 美元 = 100 个额度。 额度永不过期。

隐私

文件处理后会被删除。结果会在首次交付约 30 分钟后过期。如果需要永久保存，请在收到 Markdown 后保存。

支持的格式

OCR： PDF、PNG、JPG、JPEG、WebP

转录： MP3、M4A、WAV、MP4、MOV、WebM

文件提取： DOCX、XLSX、CSV、TSV、PPTX

图像生成： 根据文本提示词生成 PNG、JPEG、WebP 格式的图像

需要帮助？

• 文档
• 控制面板
• LAB94
• [email protected]