Skip to content

Commit

Permalink
Merge pull request #25 from huangzhhui/master
Browse files Browse the repository at this point in the history
Add readme CN version
  • Loading branch information
huangzhhui authored Sep 28, 2022
2 parents b15ceeb + b6e7b9b commit f31919c
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 3 deletions.
68 changes: 68 additions & 0 deletions README-CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
[English](./README.md) | 中文

# box, by Hyperf

Box 致力于帮助提升 Hyperf 应用程序的编程体验,管理 PHP 环境和相关依赖,同时提供将 Hyperf 应用程序打包为二进制程序的能力,还提供反向代理服务来管理和部署 Hyperf 应用程序。

## 目前还是早期实验版本,欢迎试玩 ~

您可以从该项目的 Github Actions 附件中下载最新构建的 `box` 二进制文件。
点击 [这里](https://github.com/hyperf/box/actions) 下载 ~

请注意 box **仅支持Swow**, 暂 **不支持** Swoole,故你的项目骨架应由 [hyperf/swow-skeleton](https://github.com/hyperf/swow-skeleton) 项目创建或其它 Swow 骨架创建。

### 使用

#### 安装 box

##### Mac

```bash
wget https://github.com/hyperf/box/releases/download/v0.0.4/box_x86_64_macos -O box
sudo mv ./box /usr/local/bin/box
sudo chmod 755 /usr/local/bin/box
// 确保 /usr/local/bin/box 在你的 $PATH 环境中,或者将 `box` 放到你想要的任意 $PATH 路径中
```

##### Linux x86_64

```bash
wget https://github.com/hyperf/box/releases/download/v0.0.4/box_x86_64_linux -O box
sudo mv ./box /usr/local/bin/box
sudo chmod 755 /usr/local/bin/box
// 确保 /usr/local/bin/box 在你的 $PATH 环境中,或者将 `box` 放到你想要的任意 $PATH 路径中
```
##### Linux aarch64
目前我们缺少 ARRCH64 Github Actions Runner,所以无法及时构建 ARRCH64 版本的 bin 文件。
```bash
wget https://github.com/hyperf/box/releases/download/v0.0.3/box_php8.1_aarch64_linux -O box
sudo mv ./box /usr/local/bin/box
sudo chmod 755 /usr/local/bin/box
// 确保 /usr/local/bin/box 在你的 $PATH 环境中,或者将 `box` 放到你想要的任意 $PATH 路径中
```

#### 初始化 Github Access Token

Box 需要一个 Github 访问令牌来请求 Github API,以检索包的版本。

1. [创建 Github Access Token](https://github.com/settings/tokens/new)`workflow` 范围需要勾选;
2. 运行 `box config set github.access-token <Your Token>` 命令来设置您的 token;
3. 玩得开心 ~

### 命令

- `box get pkg@version`从远程安装包,`pkg`是包名,`version`是包的版本,`box get pkg`表示安装最新版本的 pkg,例如, 运行 `box get [email protected]` 安装 PHP 8.1, 运行 `box get composer` 安装最新的 composer bin
- `box build-prepare``build``build-self` 命令做好相关环境的准备
- `box build-self` 构建 `box` bin 本身
- `box build <path>` 将 Hyperf 应用程序构建成二进制文件
- `box config list` 输出 box 配置文件的所有内容
- `box config get <key>` 从配置文件中按键检索值
- `box config set <key> <value>`通过 key 设置 value 到配置文件中
- `box config unset <key>`按 key 删除配置值
- `box config set-php-version <version>`设置 box 的当前 PHP 版本,可用值:8.0 | 8.1
- `box config get-php-version <version>`获取 box 的当前设置的 PHP 版本
- `box start -u <upsteamHost:upstreamPort>` 为上游服务器启动代理 HTTP 服务器
- `box php <argument>` 通过当前 box 的 PHP 版本运行任何 PHP 命令
- `box composer <argument>`通过当前 box 的 PHP 版本运行任何 Composer 命令,composer bin 的版本取决于最后执行的`get composer`命令
- `box php-cs-fixer <argument>` 通过当前 box 的 PHP 版本运行任何 php-cs-fixer 命令,composer bin 的版本取决于最后执行的 `get php-cs-fixer` 命令
- `box version` 输出当前 box bin 的版本号
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
English | [中文](./README-CN.md)

# box, by Hyperf

Box is committed to helping improve the programming experience of Hyperf applications, managing the PHP environment and related dependencies, providing the ability to package Hyperf applications as binary programs, and also providing reverse proxy services for managing and deploying Hyperf applications.
Expand All @@ -15,7 +17,7 @@ Please notice that box **ONLY** supports for **Swow**, but **NOT** Swoole, so yo

##### Mac

```base
```bash
wget https://github.com/hyperf/box/releases/download/v0.0.4/box_x86_64_macos -O box
sudo mv ./box /usr/local/bin/box
sudo chmod 755 /usr/local/bin/box
Expand All @@ -24,15 +26,15 @@ sudo chmod 755 /usr/local/bin/box

##### Linux x86_64

```base
```bash
wget https://github.com/hyperf/box/releases/download/v0.0.4/box_x86_64_linux -O box
sudo mv ./box /usr/local/bin/box
sudo chmod 755 /usr/local/bin/box
// Make sure /usr/local/bin/box in your $PATH env, or put `box` into any path in $PATH env that you want
```
##### Linux aarch64
At present, we are short of ARRCH64 Github Actions Runner, so we cannot timely construct the bin file of ARRCH64 version.
```base
```bash
wget https://github.com/hyperf/box/releases/download/v0.0.3/box_php8.1_aarch64_linux -O box
sudo mv ./box /usr/local/bin/box
sudo chmod 755 /usr/local/bin/box
Expand Down

0 comments on commit f31919c

Please sign in to comment.