Skip to content

Hypergraph is more powerful. Transform unstructured text into structured knowledge with LLMs. Graphs, hypergraphs, and spatio-temporal extractions — with one command.

docs: 更新文档和CLI界面样式

yifanfeng9767ea84635540
diff --git a/README.md b/README.md
index 2f1a0a8..92dfb17 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,8 @@
## ⚡ One-Line Knowledge Extraction
+![CLI Welcome Screen](./docs/assets/cli.png)
+
```bash
# Install
uv pip install hyperextract
@@ -31,21 +33,9 @@ he show kb # Visualize
### 💻 CLI Commands
-| Command | Description |
-|---------|-------------|
-| `he parse` | Extract knowledge from text/file |
-| `he talk` | Interactive Q&A with knowledge base |
-| `he search` | Semantic search |
-| `he show` | Visualize knowledge graph |
-| `he list` | List available templates/methods |
-| `he config` | Configure LLM/Embedder |
-| `he info` | Show knowledge base info |
-| `he feed` | Append knowledge to existing KB |
-| `he build-index` | Build vector index |
-
---
-## "Chat solved. What's next is CLI + Knowledge Structures."
+## "Chat solved. What's next is Structured Knowledge."
Transform LLM output from scattered text into **searchable, queryable, and reasoning-enabled** structured knowledge.
diff --git a/README_ZH.md b/README_ZH.md
index 7789f2a..2397711 100644
--- a/README_ZH.md
+++ b/README_ZH.md
@@ -18,6 +18,8 @@
## ⚡ 一行命令提取知识
+![CLI 欢迎界面](./docs/assets/cli.png)
+
```bash
# 安装
uv pip install hyperextract
@@ -31,21 +33,9 @@ he show kb # 可视化
### 💻 CLI 命令
-| 命令 | 说明 |
-|---------|-------------|
-| `he parse` | 从文本/文件提取知识 |
-| `he talk` | 与知识库交互问答 |
-| `he search` | 语义搜索 |
-| `he show` | 可视化知识图谱 |
-| `he list` | 列出可用模板/方法 |
-| `he config` | 配置 LLM/Embedding |
-| `he info` | 查看知识库信息 |
-| `he feed` | 向现有知识库追加内容 |
-| `he build-index` | 构建向量索引 |
-
---
-## "Chat 已解决,下一步是 CLI + 知识结构"
+## "Chat 已解决,下一步是 结构化知识"
将 LLM 输出的文本转化为**可搜索、可查询、可推理**的结构化知识。
diff --git a/docs/assets/cli.png b/docs/assets/cli.png
new file mode 100644
index 0000000..339b971
Binary files /dev/null and b/docs/assets/cli.png differ
diff --git a/hyperextract/cli/cli.py b/hyperextract/cli/cli.py
index aad739a..9709806 100644
--- a/hyperextract/cli/cli.py
+++ b/hyperextract/cli/cli.py
@@ -81,7 +81,6 @@ def main(
console.print(Rule(style="cyan dim"))
console.print()
- from rich.columns import Columns
from rich.panel import Panel
def make_section(title: str, commands: list[tuple[str, str]]) -> Panel:
@@ -95,6 +94,8 @@ def main(
title=f"[bold cyan]{title}[/]",
border_style="cyan dim",
padding=(0, 1),
+ title_align="center",
+ width=70,
)
sections = [
@@ -104,19 +105,20 @@ def main(
("he config --help", "Manage LLM/Embedder config"),
]),
make_section("✨ Create KB", [
- ("he parse <input> -o <kb>", "Extract knowledge from file"),
- ("he feed <kb> <input>", "Add knowledge to existing KB"),
- ("he build-index <kb>", "Build semantic search index"),
+ ("he parse <input> -o <kb_path>", "Extract knowledge from file"),
+ ("he feed <kb_path> <input>", "Add knowledge to existing KB"),
+ ("he build-index <kb_path>", "Build semantic search index"),
]),
make_section("🔍 Explore KB", [
- ("he info <kb>", "View KB info & stats"),
- ("he talk <kb> [-i]", "Chat with knowledge base"),
- ("he search <kb> <query>", "Semantic search"),
- ("he show <kb>", "Visualize knowledge graph"),
+ ("he info <kb_path>", "View knowledge base info & stats"),
+ ("he talk <kb_path> [-i]", "Chat with knowledge base"),
+ ("he search <kb_path> <query>", "Semantic search"),
+ ("he show <kb_path>", "Visualize knowledge graph"),
]),
]
- console.print(Columns(sections, equal=True, expand=True))
+ for section in sections:
+ console.print(section)
console.print()
console.print(Rule(style="cyan dim"))
console.print()