Stale 项目技术文档

1. 安装指南

1.1 克隆仓库

你可以通过以下命令克隆本项目仓库来获取最新的代码包：

$ git clone https://github.com/jparise/stale.git

1.2 下载压缩包

你也可以选择下载最新的 tarball 压缩包。

2. 项目使用说明

Stale 用于识别并删除 Pinboard 中的过期链接。以下为使用方法：

usage: stale.py [-h] [-t TOKEN] [--ignore REGEX [REGEX ...]] [-d] [-e] [--timeout TIMEOUT] [-v] [--debug] [--version]

2.1 参数说明

• -h, --help：显示帮助信息并退出。
• -t TOKEN, --token TOKEN：你的 Pinboard API token，格式为 'username:hex-values'（默认：None）。
• --ignore REGEX [REGEX ...]：忽略来自这些主机的链接（默认：None）。
• -d, --delete：删除过期链接（默认：False）。
• -e：将错误视为过期（默认：False）。
• --timeout TIMEOUT：HTTP 连接超时时间（秒）（默认：5）。
• -v, --verbose：启用详细输出（默认：False）。
• --debug：启用调试输出（默认：False）。
• --version：显示程序版本号并退出。

你可以在 Pinboard 的设置页面找到你的个人 API token。它看起来像 <pinboard-username>:<long-string-of-hex-values>。

2.2 SSL 证书

Stale 会访问每个链接以验证它是否仍然活跃。因为大多数主机使用 SSL，所以你的 Python 环境需要有一个当前的 SSL 证书集合。否则，连接尝试可能会失败，出现类似 [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed 的错误。

对于 macOS，你可以通过运行以下命令更新你的证书：

/Applications/Python\ 3.7/Install\ Certificates.command

3. 项目API使用文档

本项目中未提供特定的 API 接口，主要是通过命令行参数进行操作。

4. 项目安装方式

本项目主要通过克隆 GitHub 仓库进行安装，具体步骤请参考安装指南部分。