README

此项目已迁移至https://github.com/box-project/box

如果您正在寻找升级，别忘了查看升级指南。

Box

什么是Box？

Box应用程序简化了Phar构建过程。默认情况下，该应用程序可以执行许多出色的操作

• 向现有Phar中添加、替换和删除文件和存根。
• 提取整个Phar，或者选择您想要的文件。
• 检索Phar扩展或Phar文件的信息。
  • 列出Phar的内容。
• 验证现有Phar的签名。
• 为OpenSSL签名生成RSA（PKCS#1编码）私钥。
  • 从现有RSA私钥中提取公钥。
• 使用Git标签和短提交哈希值进行版本控制。

由于应用程序基于Box库，您还可以享受其带来的好处

• 动态搜索和替换占位符。
• 根据文件类型压缩文件内容。
• 生成自定义存根。

分支

由于我未能进行适当的维护，我创建了一个维基页面来列出此项目的已知分支。请随时添加到这个列表。您可以在此找到维基页面。

如何开始使用？

您可以使用Box的以下三种方式之一

作为Phar（推荐）

您可能可以下载Box的Phar版本

$ curl -LSs https://box-project.github.io/box2/installer.php | php

该命令将检查您的PHP设置，警告您任何问题，并将其下载到当前目录。然后，您可以将其放置在更易于访问的位置（如/usr/local/bin），并更改其权限为755。您甚至可以将其重命名为box以避免每次都必须输入.phar扩展名。

$ box --version

每当应用程序发布新版本时，您只需运行update命令即可获取最新版本

$ box update

作为全局Composer安装

当您已以这种方式安装了其他工具（如phpunit和其他工具）时，这可能是最佳方式

$ composer global require kherge/box --prefer-source

作为 Composer 依赖项

您还可以将 Box 作为依赖项安装到您由 Composer 管理的项目中

$ composer require --dev kherge/box

（或）

{
    "require-dev": {
        "kherge/box": "~2.5"
    }
}

请注意，使用这种方法需要额外的配置步骤，以防止 Box 的自身依赖项意外添加到您的 Phar 中，从而导致文件大小膨胀。您可以在维基上找到更多关于此问题的信息：问题在维基上。

一旦您安装了应用程序，您可以通过运行 help 命令来获取有关所有可用命令的详细信息。这应该是您获取有关如何使用 Box 的信息的首选地点。您还可以在维基上找到更多有用的信息：在维基上。如果您偶然发现任何可能对他人有用的信息，维基对所有贡献者开放。

$ box help

创建 Phar 文件

要开始，您可能想查看 示例应用程序，该应用程序可以由 Box 构建出来。您项目的结构完全由您决定。Box 所需的只是一份名为 box.json 的文件位于项目目录的根目录下。您可以通过查看 build 命令的帮助信息来找到可用的配置设置的完整和详细列表

$ box help build

您可以在维基上找到流行项目的示例配置文件。

一旦您使用 box.json（或 box.json.dist）配置了您的项目，您只需在包含 box.json 的目录中运行 build 命令即可

$ box build -v

启用 -v 选项将启用详细输出。这将为您提供大量有用的调试构建过程的信息。一旦您对结果满意，我建议不要使用详细选项。这可能会显著减慢构建过程。

贡献

您可以通过以下三种方式之一进行贡献

1. 使用 问题跟踪器提交错误报告。
2. 在问题跟踪器上回答问题或修复错误。
3. 贡献新功能或更新维基。

代码贡献过程并不非常正式。您只需要确保您遵循 PSR-0、PSR-1 和 PSR-2 编码指南。任何新的代码贡献都必须附带适用的单元测试。

GPG 签名

您可以在 keybase.io 上找到 kherge 的 GPG。

32E4 B747 57B1 D652 34FC 389F 293D 7712 4151 5FE8