# @begyoupardon/marzgah 中文文档

规范地址：https://npmcn.com/package/%40begyoupardon/marzgah/

版本：0\.2\.4
npm 元数据更新时间：2026-10-31T14:02:22.405Z
中文译文更新时间：2026-10-31T15:54:57.711Z
软件包许可：UNLICENSED

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40begyoupardon/marzgah
原文对照：https://npmcn.com/package/%40begyoupardon/marzgah/?lang=original
项目主页：https://github.com/begyoupardon/marzgah#readme
源码仓库：https://github.com/begyoupardon/marzgah

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：952 kB，27 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：5 个
- 首次发布：2026-10-27T16:19:21.539Z
- 最新版本发布：2026-10-31T14:02:22.053Z
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

设置和管理一个自托管的Marzgah VPN经销商面板

## 安装

```sh
npm install @begyoupardon/marzgah
```

也可以使用：`pnpm add @begyoupardon/marzgah`、`yarn add @begyoupardon/marzgah`、`bun add @begyoupardon/marzgah`

## README

# Marzgah CLI

设置和管理一个自托管的Marzgah VPN经销商面板。需要 **1.4.4或更新版本**;npm发布这个包，但可执行文件运行在Bun上。

## 创建面板

```sh
bunx @begyoupardon/marzgah init my-panel
```

CLI从与此版本捆绑在一起的模板创建一个完整的项目，安装它的依赖项，并启动交互式安装向导。它拒绝覆盖非空目录。安装程序直接支持Bun、Docker和Cloudflare配置说明。Docker和Cloudflare需要各自的工具/帐户。

要创建文件而不安装依赖项、联系VPN后端或请求凭据：

```sh
bunx @begyoupardon/marzgah init my-panel --scaffold-only
cd my-panel
bun install --frozen-lockfile
bun run cli init
```

在现有生成的项目中， `init` 如果没有目录，则运行配置向导。

## 管理一个小组

从面板的目录中运行命令，其中包含 `.env` 数据直播：

```sh
cd my-panel
bunx @begyoupardon/marzgah doctor
bunx @begyoupardon/marzgah migrate
bunx @begyoupardon/marzgah create-admin
bunx @begyoupardon/marzgah reset-password
bunx @begyoupardon/marzgah backup --out ./backups/manual.db
```

恢复备份前停止面板：

```sh
bunx @begyoupardon/marzgah restore ./backups/manual.db
```

数据库管理命令在本地SQLite上操作。Cloudflare D1迁移使用安装向导所描述的Wrangler。 `DATABASE_PATH` 默认为 `./data/panel.db`;从当前目录解析相对路径。包自带迁移，使用 `MIGRATIONS_DIR` 作为显式覆盖可用。环境变量优先于 `.env` 值。在管理面板数据库时，使用与面板版本匹配的CLI版本。

如需重复使用，请使用 `bun add --global @begyoupardon/marzgah`，然后跑 `marzgah --help`.

## 来源和许可

来源及问题： [https://github.com/begyoupardon/marzgah](https://github.com/begyoupardon/marzgah)

应用程序代码目前没有开源许可证(`UNLICENSED`）; 不隐含许可授予。第三方依赖许可证仍然适用。捆绑的Arad字体的SIL开放字体许可证保留在 `public/licenses/Arad-OFL.txt` 在生成的项目中。Poppins通过其Fontsource包在本地安装。

## 常见问题

### @begyoupardon/marzgah 是什么？

设置和管理一个自托管的Marzgah VPN经销商面板

### 如何安装 @begyoupardon/marzgah？

在项目目录运行 npm install @begyoupardon/marzgah，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 marzgah，可以用 npx marzgah 直接运行。

### @begyoupardon/marzgah 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/begyoupardon\_\_marzgah 是否存在。

### @begyoupardon/marzgah 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @begyoupardon/marzgah 可以商用吗？

@begyoupardon/marzgah 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @begyoupardon/marzgah 还在维护吗？

最新版本 0\.2\.4 发布于 2026/10/31（2 天前）；至今共发布 3 个版本，其中过去 12 个月发布了 3 个；首次发布于 2026/10/28。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。