tools-osx 项目技术文档

1. 安装指南

1.1 从源码安装

1. 克隆仓库或下载并解压工具包。
2. 运行 rake 命令。
3. 运行 rake install 命令进行安装。如果 /usr/local/bin 目录没有写权限，需要在命令前加上 sudo。

1.2 安装特定工具

1. 克隆仓库或下载并解压工具包。
2. 运行 rake 命令。
3. 运行 rake 'install[ql,trash]' 命令，指定需要安装的工具，工具名之间用逗号分隔。如果 /usr/local/bin 目录没有写权限，需要在命令前加上 sudo。

1.3 使用 zsh 插件管理器安装

注意：此方法无法安装 clipcat、dict 或 with 工具。

1. 对于 macOS 10.15 Catalina 及更新版本，使用 zsh 作为默认 shell。如果使用 zsh 插件管理器，可以通过以下方式安装单个工具，并自动下载、安装和更新：
   • 使用 zinit：在 ~/.zshrc 文件中添加以下内容，例如安装 trash 工具：

     zinit wait'1' lucid light-mode as"program" pick"src/trash" for morgant/tools-osx
     

2. 项目使用说明

2.1 工具列表

• clipcat: 打印并连接 Mac OS 文本剪贴板内容。
• dict: 在 Mac OS X 字典中进行查找。需要安装 MacRuby。
• eject: 弹出卷或网络卷，并弹出同一本地设备上的所有其他卷。
• launch: 搜索并启动应用程序。支持通配符匹配。
• ql: 使用 Mac OS X 的 Quick Look 功能打开文件。
• swuser: 使用 Mac OS X 的快速用户切换功能切换用户。
• trash: 将文件移动到废纸篓，而不是直接删除。支持跨卷操作、处理重复文件名、列出废纸篓内容、清空废纸篓等功能。
• with: 设置打开指定文档的应用程序。

2.2 使用示例

• clipcat: clipcat 命令将打印剪贴板中的文本内容。
• dict: dict <word> 命令将在字典中查找指定单词。
• eject: eject <volume_name> 命令将弹出指定卷。
• launch: launch <app_name> 命令将搜索并启动指定应用程序。
• ql: ql <file> 命令将使用 Quick Look 打开指定文件。
• swuser: swuser <user_name> 命令将切换到指定用户。
• trash: trash <file> 命令将文件移动到废纸篓。
• with: with <app_name> <file> 命令将使用指定应用程序打开文件。

3. 项目API使用文档

3.1 clipcat

• 功能: 打印并连接 Mac OS 文本剪贴板内容。
• 使用方法: clipcat

3.2 dict

• 功能: 在 Mac OS X 字典中进行查找。
• 使用方法: dict <word>

3.3 eject

• 功能: 弹出卷或网络卷，并弹出同一本地设备上的所有其他卷。
• 使用方法: eject <volume_name>

3.4 launch

• 功能: 搜索并启动应用程序。
• 使用方法: launch <app_name>

3.5 ql

• 功能: 使用 Mac OS X 的 Quick Look 功能打开文件。
• 使用方法: ql <file>

3.6 swuser

• 功能: 使用 Mac OS X 的快速用户切换功能切换用户。
• 使用方法: swuser <user_name>

3.7 trash

• 功能: 将文件移动到废纸篓，而不是直接删除。
• 使用方法: trash <file>

3.8 with

• 功能: 设置打开指定文档的应用程序。
• 使用方法: with <app_name> <file>

4. 项目安装方式

4.1 从源码安装

1. 克隆仓库或下载并解压工具包。
2. 运行 rake 命令。
3. 运行 rake install 命令进行安装。如果 /usr/local/bin 目录没有写权限，需要在命令前加上 sudo。

4.2 安装特定工具

1. 克隆仓库或下载并解压工具包。
2. 运行 rake 命令。
3. 运行 rake 'install[ql,trash]' 命令，指定需要安装的工具，工具名之间用逗号分隔。如果 /usr/local/bin 目录没有写权限，需要在命令前加上 sudo。

4.3 使用 zsh 插件管理器安装

注意：此方法无法安装 clipcat、dict 或 with 工具。

1. 对于 macOS 10.15 Catalina 及更新版本，使用 zsh 作为默认 shell。如果使用 zsh 插件管理器，可以通过以下方式安装单个工具，并自动下载、安装和更新：
   • 使用 zinit：在 ~/.zshrc 文件中添加以下内容，例如安装 trash 工具：

     zinit wait'1' lucid light-mode as"program" pick"src/trash" for morgant/tools-osx