Urlscan 技术文档

1. 安装指南

Urlscan 可以通过以下几种方式安装：

• 从你的发行版仓库安装
• 从 PyPi 安装
• 使用 pip 进行本地开发安装

以下是安装命令：

pipx install urlscan

或者

pip install --user urlscan

或者

cd <path/to/urlscan> && pip install --user -e .

注意：urwid 的最低版本要求是 1.2.1。

2. 项目使用说明

Urlscan 用于解析电子邮件消息或文件，扫描其中的 URL 和电子邮件地址。然后显示 URL 及其在消息中的上下文，允许用户选择一个或多个 URL 发送到 Web 浏览器。或者，它可以将所有 URL 列表发送到 stdout。

Urlscan 与 urlview 相比，具有以下附加功能：

• 支持电子邮件的 quoted-printable 和 base64 编码。
• 为每个 URL 提供上下文，对于 HTML 邮件，使用简单的解析器将 HTML 渲染为文本。
• 默认情况下缩短 URL 以适应一行。
• 通过输入数字跳转到 URL。
• 不区分大小写的增量搜索。
• 执行任意函数（例如，将 URL 复制到剪贴板），而不是在浏览器中打开 URL。
• 使用 l 在使用 Python webbrowser 模块、xdg-open 或通过命令行传递的函数之间切换打开 URL 的方式。

3. 项目 API 使用文档

Urlscan 的命令行使用方式如下：

urlscan OPTIONS <file>

以下是选项列表：

• -c, --compact: 省略 URL 上下文。
• -d, --dedupe: 删除重复的 URL。
• -E, --regex <expression>: 使用自定义正则表达式匹配 URL。
• -f, --run-safe <expression>: 执行安全的命令。
• -g, --genconf: 生成配置文件。
• -H, --nohelp: 启动时隐藏帮助菜单。
• --headers: 扫描某些电子邮件头部中的 URL。
• -n, --no-browser: 不打开浏览器，只输出 URL。
• -p, --pipe: 允许将 URL 通过管道传输到命令。
• -r, --run <expression>: 执行命令。
• -R, --reverse: 反转 URL 显示顺序。
• -s, --single: 单个 URL 模式。
• -w, --width: 设置显示宽度。
• -W --whitespace-off: 禁用空格和省略号。

4. 项目安装方式

请参考上述“安装指南”部分的内容进行安装。Urlscan 可以通过多种方式进行安装，包括从 PyPi 或你的 Linux 发行版的仓库中安装。安装完成后，你可以根据你的需求配置相关的 .muttrc 文件以在 mutt 邮件阅读器中使用 urlscan。