Instapaper CLI

概述

使用此技能通过ip命令行界面（CLI）处理 Instapaper 操作（该 CLI 必须已安装并可在PATH环境变量中找到），尤其当您需要可靠的自动化、结构化输出或故障排除指导时。

安装 CLI

• Go 安装：go install github.com/vburojevic/instapaper-cli/cmd/ip@latest
• Homebrew：brew tap vburojevic/tap && brew install instapaper-cli
• 从源代码构建：go build ./cmd/ip（以./ip方式运行）

工作流程（快速路径）

1. 验证设置

   

   • 确保INSTAPAPER_CONSUMER_KEY和INSTAPAPER_CONSUMER_SECRET在登录时设置或传递。
   • 首选--password-stdin进行身份验证；切勿存储密码。
   • 运行ip doctor --json（或ip auth status）在长时间作业之前。

2. 为自动化选择输出格式

   • 默认是--ndjson（流式传输，每行一个对象）。
   • 使用--json用于单个对象或紧凑数组。
   • 使用--plain用于稳定的、面向行的文本。
   • 添加--stderr-json用于结构化错误，以及--progress-json用于长时间运行。

3. 确定性地读取数据

   • 使用列表或导出配合--cursor/--cursor-dir或--since/--until来进行范围限定。
   • 使用--updated-since进行增量同步。
   • 当API不支持时，使用--select进行客户端过滤。

4. 安全地进行变更操作

   • 尽可能使用--dry-run或--idempotent。
   • 对于批量操作，使用--ids或--stdin并考虑--batch。
   • 删除操作需要明确的确认标志。

5. 处理额外项

   • 文本视图：ip text用于文章HTML。
   • 高亮部分：ip highlights list/add/delete。
   • 文件夹：ip folders list/add/delete/order。

6. 故障排除

   • 使用--debug来查看请求时间和状态。
   • 使用--stderr-json并将exit_code映射到操作。

命令参考

当您需要确切的标志、格式或示例时，请阅读这些内容：

• references/commands.md：针对授权、列表/导出/导入、变更、文件夹、高亮和文本的命令示例。
• references/output-and-sync.md：输出格式、进度流、游标/边界语法和过滤。
• references/errors.md：退出代码和结构化的标准错误错误代码。

防护措施

• 避免--format table用于解析；它仅供人类阅读。
• 使用--output或--output-dir用于大型导出，以避免标准输出压力。
• 在Windows上优先使用--password-stdin以避免密码回显。