Zotero CLI 使用教程

Zotero CLI 使用教程

zotero-cliCommand-line interface for Zotero项目地址:https://gitcode.com/gh_mirrors/zo/zotero-cli

1. 项目的目录结构及介绍

Zotero CLI 项目的目录结构如下：

zotero-cli/
├── LICENSE
├── README.md
├── setup.py
├── zotero_cli/
│   ├── __init__.py
│   ├── cli.py
│   └── ...
└── ...

• LICENSE：项目许可证文件，采用 GPL-3.0 许可证。
• README.md：项目说明文档，包含项目的基本介绍、安装方法和使用说明。
• setup.py：项目的安装脚本，用于通过 pip 安装项目。
• zotero_cli/：项目的主要代码目录，包含项目的核心功能实现。
  • __init__.py：Python 包的初始化文件。
  • cli.py：命令行接口的主要实现文件。

2. 项目的启动文件介绍

项目的启动文件是 zotero_cli/cli.py。该文件定义了命令行接口的主要功能，包括搜索、添加、编辑笔记等操作。用户可以通过命令行调用这些功能来管理 Zotero 库。

3. 项目的配置文件介绍

Zotero CLI 的配置文件是 ~/zotero/creds.txt。首次启动工具时，会要求用户输入 API 标识符和密钥，并将其缓存到 creds.txt 文件中。该文件的权限设置为仅当前用户可读写。

此外，如果用户使用共享的组库，可以通过在 ~/zotero/ 目录下创建一个空的 group 文件来永久设置组库选项。

使用示例

以下是一些常用的命令示例：

# 搜索项目
$ zotero-cli search "关键词"

# 添加笔记
$ zotero-cli add-note "项目ID" "笔记内容"

# 编辑笔记
$ zotero-cli edit-note "项目ID"

# 列出项目类型
$ zotero-cli list itemType

通过这些命令，用户可以方便地管理 Zotero 库中的项目和笔记。

zotero-cliCommand-line interface for Zotero项目地址:https://gitcode.com/gh_mirrors/zo/zotero-cli