Platypus 技术文档

1. 安装指南

1.1 下载安装

Platypus 是一个开源的 macOS 应用程序生成工具，可以将命令行脚本（如 Shell、Python、Perl 等）打包成原生的 macOS 应用程序。你可以通过以下方式安装 Platypys：

1. 直接下载安装包：

   • 访问 Platypus 的官方网站，下载最新版本的安装包：Platypus 5.4.1。
   • 下载完成后，解压缩并双击安装包进行安装。

2. 通过 Homebrew 安装：

   • 如果你已经安装了 Homebrew，可以通过以下命令安装 Platypus：

     $ brew install --cask platypus
     

   • 注意：通过 Homebrew 安装的版本可能不是最新的。

1.2 构建 Platypus

如果你需要从源码构建 Platypus，可以按照以下步骤操作：

1. 克隆 Platypus 的 GitHub 仓库。
2. 在终端中进入仓库根目录，运行以下命令：

   $ make build_unsigned
   

3. 构建完成后，生成的应用程序包会出现在 products 目录中。

2. 项目使用说明

2.1 创建应用程序

Platypus 的主要功能是将命令行脚本打包成 macOS 应用程序。使用步骤如下：

1. 打开 Platypus 应用程序。
2. 在主界面中，选择你要打包的脚本文件。
3. 配置应用程序的界面类型（如进度条、文本窗口、Web 视图等）。
4. 设置应用程序的图标、文件类型、版本号等信息。
5. 点击“创建”按钮，生成应用程序。

2.2 支持的脚本类型

Platypus 支持多种脚本语言，包括但不限于：

• Shell 脚本
• Python
• Perl
• Ruby
• PHP
• Swift
• JavaScript
• AppleScript
• Tcl
• AWK
• Dart

你可以选择任何你熟悉的脚本语言来创建应用程序。

2.3 用户界面选项

Platypus 提供了多种用户界面选项，方便你根据需求选择合适的界面类型：

• 进度条界面：显示脚本执行的进度。
• 文本窗口界面：显示脚本的输出内容。
• Web 视图界面：使用 WebKit 渲染 HTML 内容。
• 状态菜单界面：在菜单栏中显示应用程序图标。
• Droplet 界面：允许用户拖放文件到应用程序中。

2.4 高级功能

Platypus 还支持一些高级功能，如：

• 接收拖放文件：应用程序可以接收用户拖放的文件或文本片段，并将其作为参数传递给脚本。
• 以 root 权限运行：应用程序可以通过 macOS 的安全框架以 root 权限运行脚本。
• 注册 URI 处理程序：应用程序可以注册为特定 URI 方案的处理程序。
• 后台运行：应用程序可以配置为在后台运行。

3. 项目 API 使用文档

Platypus 提供了命令行工具 platypus，可以通过命令行生成应用程序。以下是一些常用的命令行选项：

3.1 基本用法

$ platypus [OPTIONS] scriptPath [destinationPath]

• scriptPath：要打包的脚本路径。
• destinationPath：生成的应用程序路径。

3.2 常用选项

• -O 或 --generate-profile：生成配置文件而不是应用程序。
• -i 或 --interface-type：指定用户界面类型（如进度条、文本窗口等）。
• -I 或 --app-icon：设置应用程序图标。
• -V 或 --app-version：设置应用程序版本号。

3.3 示例

生成一个带有进度条界面的应用程序：

$ platypus -i "MyAppIcon.icns" -V "1.0" -O "ProgressBar" myscript.sh MyApp.app

4. 项目安装方式

Platypus 可以通过以下两种方式安装：

1. 直接下载安装包：从官方网站下载最新版本的安装包并安装。
2. 通过 Homebrew 安装：使用 Homebrew 命令安装 Platypus。

如果你需要从源码构建 Platypus，可以参考“构建 Platypus”部分的内容。

---

通过以上文档，你可以轻松安装、使用 Platypus，并了解其 API 的使用方法。希望 Platypus 能帮助你更方便地创建 macOS 应用程序！