Bash Utils 技术文档

1. 安装指南

Bash Utils 是一个包含多个小型命令行工具的集合，适用于 Bash shell。这些工具主要用于简化日常任务，如文件处理、网络操作、文本转换等。以下是安装指南：

1.1 克隆项目

首先，你需要将项目克隆到本地。打开终端并执行以下命令：

git clone https://github.com/jabbalaci/Bash-Utils.git

1.2 安装依赖

部分脚本依赖于 Python 3 和一些第三方库。确保你已经安装了 Python 3，并使用 pip 安装所需的依赖：

cd Bash-Utils
pip install -r requirements.txt

1.3 设置环境变量

为了方便使用这些脚本，建议将项目目录添加到系统的 PATH 环境变量中。你可以通过编辑 ~/.bashrc 或 ~/.zshrc 文件来实现：

export PATH=$PATH:/path/to/Bash-Utils

然后执行以下命令使更改生效：

source ~/.bashrc

2. 项目的使用说明

Bash Utils 包含多个脚本，每个脚本都有特定的功能。以下是部分常用脚本的使用说明：

2.1 meaning.py

查找单词的含义：

meaning pen

2.2 dropbox_permissions.py

设置 Dropbox 文件夹中的文件和目录权限：

dropbox_permissions.py

2.3 export_firefox_cookies.py

从 Firefox 的 cookies.sqlite 中导出特定主机的 cookies：

export_firefox_cookies.py <host>

2.4 radio.py

播放网络电台：

radio.py

2.5 alarm.py

设置闹钟播放 MP3 文件：

alarm -t 7h5

2.6 cb.py

打印剪贴板内容：

cb.py

2.7 get_links.py

从网页中提取所有链接：

get_links.py <URL>

2.8 myip.py

获取外部 IP 地址：

myip

2.9 ocr.py

使用 Tesseract OCR 引擎将图像转换为文本：

ocr <image_file>

2.10 prettyjson.py

美化 JSON 文件：

prettyjson ugly.json

3. 项目 API 使用文档

Bash Utils 中的脚本主要通过命令行调用，每个脚本都有特定的参数和选项。以下是部分脚本的 API 使用文档：

3.1 meaning.py

• 功能: 查找单词的含义。
• 用法: meaning <word>
• 示例: meaning pen

3.2 dropbox_permissions.py

• 功能: 设置 Dropbox 文件夹中的文件和目录权限。
• 用法: dropbox_permissions.py
• 说明: 将脚本放置在 Dropbox 根目录并运行。

3.3 export_firefox_cookies.py

• 功能: 从 Firefox 的 cookies.sqlite 中导出特定主机的 cookies。
• 用法: export_firefox_cookies.py <host>
• 输出: 导出的 cookies 保存在 cookies.txt 中。

3.4 radio.py

• 功能: 播放网络电台。
• 用法: radio.py
• 支持的电台: Slay Radio, goa, trance, chillout 等。

3.5 alarm.py

• 功能: 设置闹钟播放 MP3 文件。
• 用法:
  • alarm -p：调整音量。
  • alarm -t <time>：设置闹钟时间。
• 示例: alarm -t 7h5

3.6 cb.py

• 功能: 打印剪贴板内容。
• 用法: cb.py

3.7 get_links.py

• 功能: 从网页中提取所有链接。
• 用法: get_links.py <URL>
• 输出: 打印网页中的所有链接。

3.8 myip.py

• 功能: 获取外部 IP 地址。
• 用法: myip

3.9 ocr.py

• 功能: 使用 Tesseract OCR 引擎将图像转换为文本。
• 用法: ocr <image_file>
• 输出: 打印图像中的文本内容。

3.10 prettyjson.py

• 功能: 美化 JSON 文件。
• 用法: prettyjson <json_file>
• 输出: 打印美化后的 JSON 内容。

4. 项目安装方式

Bash Utils 的安装方式非常简单，只需克隆项目并安装依赖即可。以下是详细步骤：

4.1 克隆项目

git clone https://github.com/jabbalaci/Bash-Utils.git

4.2 安装依赖

cd Bash-Utils
pip install -r requirements.txt

4.3 设置环境变量

将项目目录添加到 PATH 环境变量中：

export PATH=$PATH:/path/to/Bash-Utils
source ~/.bashrc

完成以上步骤后，你就可以在终端中直接使用这些脚本了。

---

通过本文档，你应该能够顺利安装并使用 Bash Utils 中的各种脚本。如果你有任何问题，可以参考项目的 GitHub 页面或联系作者。