Skip to content

导出 Tool 摘要 ​

用途 ​

读取 NAME:VERSION 的 Markdown 摘要,可选择一个标题路径。

语法 ​

bash
fkit tool summary export [OPTIONS] <TOOL_VERSION_NAME>

参数与选项 ​

  • --output <PATH> — 可选;写入新文件,拒绝覆盖。
  • --json — 输出包含版本标识、摘要和 section 的 JSON。
  • --section <HEADING/PATH> — 按精确标题路径提取该标题及其后代内容。

影响范围 ​

只读取平台或项目数据,不提交远端修改。

安全使用 ​

默认把 Markdown 写到 stdout。使用 --output 写新文件;已存在的目标不会被覆盖。--section 按大小写敏感的 ATX 标题路径精确选择,重复或缺失路径会报错。

输出 ​

支持 --json 输出 {toolId, toolVersionId, name, version, summary, section};与 --output 同用时 JSON 写入文件,状态写入 stderr。

读取本页 ​

添加 --docs 可在解析业务必填参数、登录或执行命令前从 BioLine 官方 AI 文档服务读取本页。使用 --docs-lang zh|en 选择语言,使用 --docs-json 返回文档 JSON。索引与 Markdown 均从同一官方 AI 服务读取;索引固定为 https://www.bioline.cloud/ai/commandLineAndFkit/。

bash
fkit tool summary export --docs --docs-json --docs-lang zh