# newbee-release

**Repository Path**: sbs-dev/newbee-release

## Basic Information

- **Project Name**: newbee-release
- **Description**: newbee release
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-08-19
- **Last Updated**: 2026-02-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# NeeBee Cli - A command line for WanFeng QA Team

## 简述
NeeBee Cli 是一个命令行工具，用于 WanFeng QA 团队配合使用"玩蜂接口测试平台"。
功能包括但不限于：启动本地执行器监听在线任务、离线查看用例信息、离线执行测试用例等。

## 安装
### 1. Windows
```powershell
(Invoke-RestMethod -Uri 'https://gitee.com/api/v5/repos/sbs-dev/newbee-release/releases/latest').assets | Where-Object { $_.browser_download_url -match 'newbee-windows-amd64' } | ForEach-Object { Invoke-WebRequest $_.browser_download_url -OutFile "newbee.exe" }; $currentPath = (Get-Location).Path; $envPath = [System.Environment]::GetEnvironmentVariable("Path", [System.EnvironmentVariableTarget]::Machine); if (-not $envPath.Split(';').Contains($currentPath)) { [System.Environment]::SetEnvironmentVariable("Path", "$envPath;$currentPath", [System.EnvironmentVariableTarget]::Machine) }
```
> 🎃 注意: 
> 1. 请使用管理员权限运行 PowerShell (自动添加环境变量 `PATH` 需要管理员权限)
> 2. 命令执行后请重新打开新的命令行窗口, 执行 `newbee` 命令确认是否安装成功
> 3. 命令执行后会在当前目录下载 `newbee.exe` 文件, 如果您移动了此文件, 
> 请手动配置环境变量 `PATH` 添加 `newbee.exe` 文件移动后所在的目录


### 2. Linux
```bash
sh -c 'INSTALL_PATH=~/newbee-cli; mkdir -p $INSTALL_PATH && curl -s -X GET "https://gitee.com/api/v5/repos/sbs-dev/newbee-release/releases/latest" | grep -o "\"browser_download_url\":\"https[^\"]*newbee-linux-amd64[^\"]*" | cut -d\" -f4 | xargs -I {} sh -c "curl -L {} -o $INSTALL_PATH/newbee && chmod +x $INSTALL_PATH/newbee && sudo ln -sf $INSTALL_PATH/newbee /usr/local/bin/newbee"'
```
> 🎃 注意:
> 1. `newbee` 可执行文件默认下载到 `~/newbee-cli` 目录下, 如果您需要自定义下载目录, 
> 请修改上述命令中的安装位置变量 `INSTALL_PATH` 为自定义的目录
> 2. 命令使用 `sudo ln -sf` 命令将 `newbee` 可执行文件软链接到 `/usr/local/bin` 目录下, 请确保您的用户有权限操作 `/usr/local/bin` 目录
> 如果您希望使用其他方式使`newbee` 可执行文件全局生效, 请自行修改命令
> 3. 命令执行后执行 `newbee` 命令确认是否安装成功

### 3. MacOS
```bash
sh -c 'INSTALL_PATH=~/newbee-cli; mkdir -p $INSTALL_PATH && curl -s -X GET "https://gitee.com/api/v5/repos/sbs-dev/newbee-release/releases/latest" | grep -o "\"browser_download_url\":\"https[^\"]*newbee-mac-amd64[^\"]*" | cut -d\" -f4 | xargs -I {} sh -c "curl -L {} -o $INSTALL_PATH/newbee && chmod +x $INSTALL_PATH/newbee && sudo ln -sf $INSTALL_PATH/newbee /usr/local/bin/newbee"'
```
> 🎃 注意:
> 1. `newbee` 可执行文件默认下载到 `~/newbee-cli` 目录下, 如果您需要自定义下载目录,
> 请修改上述命令中的安装位置变量 `INSTALL_PATH` 为自定义的目录
> 2. 命令使用 `sudo ln -sf` 命令将 `newbee` 可执行文件软链接到 `/usr/local/bin` 目录下, 请确保您的用户有权限操作 `/usr/local/bin` 目录
>    如果您希望使用其他方式使`newbee` 可执行文件全局生效, 请自行修改命令
> 3. 命令执行后执行 `newbee` 命令确认是否安装成功


## 使用
| Desc               | Command          | Argument                        | Flags                                     | Example                                                                                                                                                 |
|--------------------|------------------|---------------------------------|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| 查看帮助               | `newbee`         | `无`                             | `--help or -h`                            | `newbee --help`                                                                                                                                         |
| 版本信息               | `newbee version` | `无`                             | `--update or -u`                          | `newbee version` 查看版本信息<br/> `newbee version --update` 更新版本                                                                                             |
| 启动执行器 <br/> (局域网内) | `newbee start`   | `worker`                        | `--advanced or -a` <br/> `--config or -c` | `newbee start worker` 启动正式环境执行器 <br/> `newbee start worker --advanced` 开启高级选项 <br/> `newbee start worker --advanced --config your/config/path` 自定义执行器配置 |
| 设置全局配置             | `newbee set`     | `data-source` <br/> `exec-conf` | `无`                                       | `newbee set data-source your/path/*.bee` 指定离线数据源文件 <br/> `newbee set exec-conf your/path/exec.yaml` 指定运行配置文件 <br/>                                      |
| 查看列表               | `newbee list`    | `testcase`                      | `无`                                       | `newbee list testcase` 查看离线数据源文件中的用例列表                                                                                                                  |
| 执行用例 <br/> (单机离线)  | `newbee exec`    | `testcase`                      | `--id or -i`                              | `newbee exec testcase --id=0` 执行ID为0的用例(自动使用指定的运行配置文件)                                                                                                  |

> 🎃 注意:
> 1. 首次安装后, 后续可以使用 `newbee version --update` 命令更新到最新版本；
> 2. 离线数据文件格式为 `.bee` 文件, 需要在玩蜂接口测试平台进行导出；
> 3. 运行配置文件格式为 `.yaml` 文件, 因包含某些敏感信息，请联系管理员索要模版文件；