mirror of https://github.com/lllin000/PaperForge.git synced 2026-07-22 06:50:53 +00:00

Research Assistant 1548de2f21 docs(47-library-records): purge library-records from all 10 command file copies

- command/pf-sync.md: removed two-phase workflow, library-records output references
- command/pf-ocr.md: replaced library-records with formal-notes workflow references
- command/pf-status.md: removed library-records path and count from output
- command/pf-paper.md: removed library-record prerequisite reference
- command/pf-deep.md: replaced library-record with formal-note frontmatter references
- paperforge/command_files/*: identical changes to mirror copies

2026-05-07 19:21:19 +08:00

2.8 KiB

Raw Blame History

/pf-status

Purpose

查看 PaperForge 当前安装与运行状态。

paperforge status 会检查：

安装完整性（Python 包、依赖）
配置文件（paperforge.json、.env）
路径连通性（exports、ocr、literature 目录）
Zotero 数据目录链接状态
Better BibTeX 导出文件状态

CLI Equivalent

paperforge status

如需使用 Python 直接调用（备选方式）：

python -m paperforge status --vault .

更简单的方式是直接使用 paperforge status（见上方）。

Prerequisites

无特殊前置条件。此命令用于诊断安装问题，即使在配置不完整时也会尽量输出可用信息。

Arguments

参数	必需	说明
`--vault <PATH>`	否	指定 Vault 根目录（默认当前目录）

Example

# 检查当前目录的 Vault 状态
paperforge status

# 检查指定 Vault 的状态
paperforge status --vault /path/to/vault

Output

典型输出示例：

PaperForge Lite v1.2
====================

[安装检查]
✓ Python 包: paperforge v1.2.0
✓ 依赖: requests, pymupdf, pillow

[配置检查]
✓ paperforge.json: 存在且有效
✓ .env: 存在
✓ PADDLEOCR_API_TOKEN: 已设置

[路径检查]
✓ exports: <system_dir>/PaperForge/exports/
✓ ocr: <system_dir>/PaperForge/ocr/
✓ literature: <resources_dir>/<literature_dir>/
✓ Zotero: <system_dir>/Zotero/

[数据检查]
✓ library.json: 存在，包含 150 条文献
✓ 正式笔记: 150 篇

状态: 一切正常 ✅

Error Handling

配置缺失

表现：✗ paperforge.json: 未找到
解决：运行 paperforge doctor 或重新执行安装步骤

路径错误

表现：✗ Zotero: 目录不存在或不是有效链接
解决：创建 junction/symlink 到 Zotero 数据目录（见 AGENTS.md 安装指南）

依赖缺失

表现：✗ 依赖: requests 未安装
解决：pip install requests pymupdf pillow

API Key 未设置

表现：✗ PADDLEOCR_API_TOKEN: 未设置
解决：在 .env 文件中添加 API token

Platform Notes

OpenCode

/pf-status 是 CLI 命令，Agent 层不直接提供 /pf-status 聊天命令。

用户可以在终端运行 paperforge status 检查安装状态。 Agent 可以在对话中指导用户执行诊断，或通过 Bash tool 代为执行并解析输出。

Codex

Future：计划支持。预计通过 API 调用实现类似功能。

Claude Code

Future：计划支持。预计通过工具调用实现类似功能。

2.8 KiB Raw Blame History Unescape Escape