CLI 指南¶

Hyper-Extract CLI (he) 提供了强大、易用的界面，可直接从终端进行知识提取。

安装¶

uv (推荐)pipx

uv tool install hyperextract

pipx install hyperextract

验证安装：

he --version

快速命令参考¶

命令	用途	常用参数
`he parse`	从文档提取知识	`-t` 模板, `-o` 输出, `-l` 语言
`he show`	可视化知识图谱	—
`he search`	知识库语义搜索	`-n` top-k 结果数
`he talk`	与知识库对话	`-i` 交互模式, `-q` 查询
`he feed`	增量添加文档	—
`he info`	显示知识库统计信息	—
`he build-index`	构建/重建搜索索引	`-f` 强制重建
`he list`	列出模板和方法	`template` 或 `method`
`he config`	管理配置	`init`, `show`, `set`

完整工作流程¶

提取和交互知识的典型工作流程：

flowchart TB
    subgraph Create ["🚀 创建"]
        D[📄 Document] -->|he parse| KA[(💡 Knowledge Abstract)]
    end

    subgraph Enhance ["✨ 增强（可选）"]
        KA -->|he feed| KA
        KA -->|he build-index| IDX[(🔍 Index)]
    end

    subgraph Explore ["🔍 探索"]
        KA -->|he show| VIS[👁️ Visualize]
        IDX -->|he search| SRCH[🔎 Search]
        IDX -->|he talk| CHAT[💬 Chat]
    end

    subgraph Save ["💾 保存"]
        KA -->|he dump| DISK[💾 Disk]
    end

创建 — 从文档提取知识 (he parse)
增强 — 增量添加文档 (he feed)、构建索引 (he build-index)
探索 — 可视化 (he show)、搜索 (he search)、对话 (he talk)
保存 — 持久化到磁盘 (he dump)

→ 详细工作流程指南

快速开始¶

1. 配置 API 密钥¶

he config init -k YOUR_OPENAI_API_KEY

2. 提取知识¶

he parse document.md -t general/biography_graph -o ./output/ -l zh

3. 可视化¶

he show ./output/

详细命令¶

知识提取¶

he parse — 从文档提取知识
he feed — 向现有知识库添加文档

探索¶

he show — 可视化知识图谱
he search — 语义搜索
he talk — 与知识库对话
he info — 查看知识库统计信息

管理¶

he build-index — 构建搜索索引
he list — 列出可用模板/方法
he config — 配置管理

配置¶

CLI 在 ~/.he/config.toml 存储配置。

→ 配置参考

模板 vs 方法¶

Hyper-Extract 提供两种提取知识的方式：

模板（适用于大多数用户）¶

特定领域的开箱即用配置：

he parse doc.md -t general/biography_graph -l zh

方法（高级）¶

底层提取算法：

he parse doc.md -m light_rag

→ 了解何时使用每种方式

语言支持¶

模板支持多种语言：

# 英文
he parse doc.md -t general/biography_graph -l zh

# 中文
he parse doc.md -t general/biography_graph -l zh

方法模板始终使用英文提示。

用例示例¶

研究¶

# 从研究论文提取
he parse paper.md -t general/concept_graph -o ./paper_kb/ -l zh

# 提问
he talk ./paper_kb/ -q "主要贡献是什么？"

传记分析¶

# 从传记提取
he parse biography.md -t general/biography_graph -o ./bio_kb/ -l zh

# 可视化生平事件
he show ./bio_kb/

法律文档分析¶

# 提取合同义务
he parse contract.md -t legal/contract_obligation -o ./contract_kb/ -l zh

# 搜索特定条款
he search ./contract_kb/ "终止条件"

技巧和最佳实践¶

为特定领域任务使用模板 — 针对特定用例进行了优化
构建索引 — 搜索和聊天功能需要索引
增量摄入 — 随着时间添加文档，无需重新处理
选择正确的语言 — 改善非英文文档的提取质量

获取帮助¶

查看任何命令的帮助：he <command> --help
列出所有模板：he list template
列出所有方法：he list method
常见问题
故障排除