ARTICLE DETAIL

资讯详情

深耕郑州网站建设与运营推广的一线实战洞察。

如何用 OpenClaude 的 report 命令从会话 transcript 生成结构化任务报告?

如何用 OpenClaude 的 report 命令从会话 transcript 生成结构化任务报告? 如何用 OpenClaude 的 report 命令从会话 transcript 生成结构化任务报告【免费下载链接】openclauderuns anywhere. uses anything项目地址: https://gitcode.com/GitHub_Trending/op/openclaude在 OpenClaude 中完成一次较长的会话后你通常需要向他人说明这次会话做了什么调用了哪些工具、执行了哪些命令、改了哪些文件、有没有观察到验证步骤。openclaude report命令直接读取会话的 JSONL transcript生成一份确定性的任务报告可以输出为 JSON--json或人可读的 Markdown--markdown。命令参数、transcript 位置和报告的覆盖范围见 docs/advanced-setup.md 的 Runtime Hardening 一节命令定义在 src/cli/commands/taskReport.ts。前提条件已经安装并可以使用openclaude命令。手头有一个会话 transcript。OpenClaude 的会话记录以 JSONL 形式存储文档示例路径形如~/.openclaude/projects/-path-to-project/session-id.jsonl其中目录名对应项目路径、文件名是 session id。命令需要--json或--markdown二者之一指定输出格式两者互斥命令实现中如果两者都没传会直接报错Pass either --json or --markdown for task report output.见 src/cli/commands/taskReport.ts。生成 JSON 任务报告主路径文档给出的标准用法是显式指定 transcript 文件并写出到文件openclaude report --json \ --transcript ~/.openclaude/projects/-path-to-project/session-id.jsonl \ --out task-report.json其中--transcript file接一个 JSONL transcript 路径相对路径按当前工作目录解析--out file把报告写入指定文件。写入时若目标目录不存在会先创建stderr 会输出一行Task report written to path作为完成提示见 src/cli/handlers/taskReport.ts。不带--out时报告内容直接打印到 stdout可以重定向或交给脚本处理。--transcript与--session不能同时使用同时给出会报错Pass either --transcript file or --session id, not both.。从已存储会话或最新会话生成报告如果不想手动拼 transcript 路径还有两个替代入口文档在 Notes 中明确说明--session id报告当前项目中某个已存储的 session两者都不传报告当前项目里最新的一次会话。找不到任何 transcript 时会报错No session transcripts found for the current project. Pass --transcript file or --session id.人可读版本的典型命令# 当前项目最新会话的 Markdown 任务报告 openclaude report --markdown--markdown输出的是一份以# Task Report开头的文档包含 Summary、Session、Branching / Worktree、Changes、Files changed、Commands run、Validation、Errors / Warnings、Risks / Follow-ups 等章节渲染逻辑见 src/utils/taskReport.ts。报告会包含什么文档对报告内容的定义是汇总会话中观察到的事实包括 tool uses、Bash 命令、validation 命令、changed files、分支元数据、warnings 以及关联的 issue/PR 引用。JSON 结构对应 src/utils/taskReport.ts 中的TaskReport类型关键字段有sourcetranscript 路径、被跳过的畸形行数sessionid、名称/标签、cwd、起止时间、初始请求、使用过的模型branch/gittranscript 分支、worktree、PR 链接以及 git 状态分支、head、changed files、是否 dirtytoolUses/commands/validations/errors/warnings/linkedReferences。两个需要注意的行为文档都明确写了大的预览内容会被截断credential 形态的字符串会被脱敏报告自带redaction字段标注脱敏模式与最大预览长度。如果会话中没观察到验证命令报告会把validations保持为空并附一条 warning而不是宣称检查已通过。哪些命令会被归入validations源码里定义了匹配模式src/utils/taskReport.tsbun|npm|pnpm|yarn的test、typecheck、lint、build、check、smoke等脚本以及bun test、git diff --check、pytest、tsc。会话里跑过这类命令它们才会出现在 Validation 一节。验证结果与常见报错判断命令是否成功看输出即可不带--outstdout 上是完整 JSON 或 Markdown 报告带--outstderr 上是Task report written to path随后检查该文件内容失败时 stderr 输出Failed to generate task report: 原因进程以非零状态退出见 src/cli/handlers/taskReport.ts。常见的两类报错都来自参数与输入现象原因Pass either --json or --markdown for task report output.缺少格式参数或两个都传了Session transcript not found: id--session id在当前项目的已存储会话中不存在另外transcript 中解析不了的行不会让命令失败而是计入source.malformedLineCount并在warnings中记录Skipped N malformed transcript lines.文件里没有任何可用条目时warnings 会包含No transcript entries were available for this report.。与 doctor report 的区别openclaude doctor report是面向 GitHub issue 的脱敏环境报告汇总 provider/runtime/build/settings 状态不包含 prompts、transcripts、API keys 等而openclaude report面向单次会话的任务事实。两者不要混用要说明这次会话做了什么用openclaude report要上报环境问题用openclaude doctor report--markdown或--json --out用法见 docs/advanced-setup.md 与 docs/non-technical-setup.md。【免费下载链接】openclauderuns anywhere. uses anything项目地址: https://gitcode.com/GitHub_Trending/op/openclaude创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表