mirror of
https://github.com/lllin000/PaperForge.git
synced 2026-07-22 06:50:53 +00:00
chore: bump to v1.4.3, update READMEs with multi-agent and plugin info
This commit is contained in:
parent
f617054d5a
commit
40ee97c0f8
6 changed files with 30 additions and 20 deletions
21
README.md
21
README.md
|
|
@ -96,6 +96,8 @@ PaperForge turns your Zotero library into an **AI-ready literature knowledge bas
|
|||
| **Progress bars** | tqdm with `--no-progress` flag for quiet mode |
|
||||
| **Zotero sync** | Better BibTeX auto-export, bidirectional |
|
||||
| **Obsidian Base** | Literature queue management via Base views |
|
||||
| **Obsidian plugin** | Status panel + command palette integration |
|
||||
| **Multi-agent** | OpenCode, Claude Code, Codex, Cursor, Copilot, Windsurf, Cline, Augment, Trae |
|
||||
| **Pre-commit gates** | ruff lint + format + consistency audit |
|
||||
| **Cross-platform** | Windows / macOS / Linux |
|
||||
|
||||
|
|
@ -126,7 +128,7 @@ paperforge setup
|
|||
|
||||
The interactive wizard handles: agent platform selection, vault directory setup, Zotero data linking, PaddleOCR API key configuration. See [setup-guide.md](docs/setup-guide.md) for a step-by-step walkthrough.
|
||||
|
||||
> For AI agents reading this: use the headless mode — `paperforge setup --headless`. Full instructions in [docs/ai-agent-setup-guide.md](docs/ai-agent-setup-guide.md).
|
||||
> For AI agents reading this: use the headless mode — `paperforge setup --headless --agent <agent_key>`. Supported agents: opencode, claude, codex, cursor, copilot, windsurf, cline, augment, trae. Full instructions in [docs/ai-agent-setup-guide.md](docs/ai-agent-setup-guide.md).
|
||||
|
||||
### Prerequisites
|
||||
|
||||
|
|
@ -154,18 +156,21 @@ The interactive wizard handles: agent platform selection, vault directory setup,
|
|||
| | `paperforge ocr --no-progress` | Quiet mode |
|
||||
| **Reading** | `paperforge deep-reading` | Show deep-reading queue |
|
||||
| **Maintenance** | `paperforge status` | System status |
|
||||
| | `paperforge status --json` | JSON output for tooling |
|
||||
| | `paperforge update` | Auto-update |
|
||||
| | `paperforge --verbose` | DEBUG-level logging |
|
||||
|
||||
### Agent (via OpenCode)
|
||||
### Agent (OpenCode / Claude Code / Codex / Cursor / Copilot)
|
||||
|
||||
| Command | What it does | Required |
|
||||
|---------|-------------|----------|
|
||||
| `/pf-deep <key>` | Full 3-pass deep reading | OCR complete |
|
||||
| `/pf-paper <key>` | Quick summary | Formal note exists |
|
||||
| `/pf-sync` | Sync Zotero | Installed |
|
||||
| `/pf-ocr` | Run OCR | Installed |
|
||||
| `/pf-status` | System status | Installed |
|
||||
| `/<prefix>pf-deep <key>` | Full 3-pass deep reading | OCR complete |
|
||||
| `/<prefix>pf-paper <key>` | Quick Q&A | Formal note exists |
|
||||
| `/pf-sync` | Sync Zotero (OpenCode only) | Installed |
|
||||
| `/pf-ocr` | Run OCR (OpenCode only) | Installed |
|
||||
| `/pf-status` | System status (OpenCode only) | Installed |
|
||||
|
||||
> Prefix: `/` for Claude Code / OpenCode / Copilot, `$` for Codex. CLI-only commands (sync, ocr, status) are available as OpenCode commands or via terminal.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -202,7 +207,7 @@ pip install --upgrade git+https://github.com/LLLin000/PaperForge.git
|
|||
|
||||
```json
|
||||
{
|
||||
"version": "1.4.1",
|
||||
"version": "1.4.3",
|
||||
"system_dir": "99_System",
|
||||
"resources_dir": "03_Resources",
|
||||
"literature_dir": "Literature",
|
||||
|
|
|
|||
|
|
@ -96,6 +96,8 @@ PaperForge 把你的 Zotero 文献库转化为**AI 可直接读取的知识库**
|
|||
| **进度指示** | tqdm 进度条 + `--no-progress` |
|
||||
| **Zotero 同步** | Better BibTeX 自动导出,双工同步 |
|
||||
| **Obsidian Base** | 文献队列管理,Base 视图集成 |
|
||||
| **Obsidian 插件** | 状态面板 + 命令面板集成 |
|
||||
| **多 Agent 平台** | OpenCode, Claude Code, Codex, Cursor, Copilot, Windsurf, Cline, Augment, Trae |
|
||||
| **pre-commit 栅栏** | ruff 检查 + 一致性审计 |
|
||||
| **多平台** | Windows / macOS / Linux |
|
||||
|
||||
|
|
@ -126,7 +128,7 @@ paperforge setup
|
|||
|
||||
安装向导引导你完成:Agent 平台选择、Vault 目录配置、Zotero 数据目录链接、PaddleOCR API Key 配置。详细步骤见 [setup-guide.md](docs/setup-guide.md)。
|
||||
|
||||
> 如果你是 AI Agent 正在读这个:使用 headless 模式 — `paperforge setup --headless`。完整指引见 [docs/ai-agent-setup-guide-zh.md](docs/ai-agent-setup-guide-zh.md)。
|
||||
> 如果你是 AI Agent 正在读这个:使用 headless 模式 — `paperforge setup --headless --agent <agent_key>`。支持的 Agent:opencode, claude, codex, cursor, copilot, windsurf, cline, augment, trae。完整指引见 [docs/ai-agent-setup-guide-zh.md](docs/ai-agent-setup-guide-zh.md)。
|
||||
|
||||
### 前置条件
|
||||
|
||||
|
|
@ -154,18 +156,21 @@ paperforge setup
|
|||
| | `paperforge ocr --no-progress` | 静默模式 |
|
||||
| **精读** | `paperforge deep-reading` | 查看精读队列 |
|
||||
| **维护** | `paperforge status` | 系统状态 |
|
||||
| | `paperforge status --json` | JSON 格式输出 |
|
||||
| | `paperforge update` | 自动更新 |
|
||||
| | `paperforge --verbose` | 全局 DEBUG 日志 |
|
||||
|
||||
### Agent 命令(OpenCode 中使用)
|
||||
### Agent 命令(OpenCode / Claude Code / Codex / Cursor / Copilot)
|
||||
|
||||
| 命令 | 用途 | 前置条件 |
|
||||
|------|------|---------|
|
||||
| `/pf-deep <key>` | 完整三阶段精读 | OCR 完成 |
|
||||
| `/pf-paper <key>` | 快速摘要 | 有正式笔记即可 |
|
||||
| `/pf-sync` | 同步 Zotero | 安装完成 |
|
||||
| `/pf-ocr` | 运行 OCR | 安装完成 |
|
||||
| `/pf-status` | 系统状态 | 安装完成 |
|
||||
| `/<prefix>pf-deep <key>` | 完整三阶段精读 | OCR 完成 |
|
||||
| `/<prefix>pf-paper <key>` | 论文对话问答 | 有正式笔记即可 |
|
||||
| `/pf-sync` | 同步 Zotero(仅 OpenCode) | 安装完成 |
|
||||
| `/pf-ocr` | 运行 OCR(仅 OpenCode) | 安装完成 |
|
||||
| `/pf-status` | 系统状态(仅 OpenCode) | 安装完成 |
|
||||
|
||||
> 调用前缀:Claude Code / OpenCode / Copilot 使用 `/`,Codex 使用 `$`。sync/ocr/status 为 CLI 操作,纯终端命令。
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -202,7 +207,7 @@ pip install --upgrade git+https://github.com/LLLin000/PaperForge.git
|
|||
|
||||
```json
|
||||
{
|
||||
"version": "1.4.1",
|
||||
"version": "1.4.3",
|
||||
"system_dir": "99_System",
|
||||
"resources_dir": "03_Resources",
|
||||
"literature_dir": "Literature",
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"id": "paperforge",
|
||||
"name": "PaperForge",
|
||||
"version": "1.4.2",
|
||||
"version": "1.4.3",
|
||||
"minAppVersion": "1.0.0",
|
||||
"description": "PaperForge — Zotero + Obsidian literature pipeline. Sync, OCR, and deep-reading commands in your command palette.",
|
||||
"author": "PaperForge",
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
{
|
||||
"1.4.2": "1.0.0"
|
||||
"1.4.3": "1.0.0"
|
||||
}
|
||||
|
|
@ -1991,7 +1991,7 @@ PADDLEOCR_MODEL=PaddleOCR-VL-1.5
|
|||
except Exception:
|
||||
existing_config = {}
|
||||
existing_config.update({
|
||||
"version": existing_config.get("version", "1.4.2"),
|
||||
"version": existing_config.get("version", "1.4.3"),
|
||||
"agent_platform": agent_config.get("name", "OpenCode"),
|
||||
"agent_key": agent_key,
|
||||
"skill_dir": skill_dir,
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
|||
|
||||
[project]
|
||||
name = "paperforge"
|
||||
version = "1.4.2"
|
||||
version = "1.4.3"
|
||||
description = "PaperForge — Obsidian + Zotero literature pipeline CLI"
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.10"
|
||||
|
|
|
|||
Loading…
Reference in a new issue