# @app-vitals/agent-admin 中文文档

规范地址：https://npmcn.com/package/%40app-vitals/agent-admin/

版本：1\.2\.5
npm 元数据更新时间：2026-11-06T18:13:57.061Z
中文译文更新时间：2026-11-06T11:11:39.323Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：6.4 MB，353 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：11 个
- 首次发布：2026-10-23T17:51:38.645Z
- 最新版本发布：2026-11-06T18:13:56.674Z
- 近 30 天下载量：11317（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：37（近 12 个月 37 个）

## 中文简介

轮船管理服务 — CRUD API + UI 用于代理, env vars, cron jobs, 代币, 工具和插件

## 安装

```sh
npm install @app-vitals/agent-admin
```

也可以使用：`pnpm add @app-vitals/agent-admin`、`yarn add @app-vitals/agent-admin`、`bun add @app-vitals/agent-admin`

## README

# 船舶管理员服务

管理员服务提供网络UI和CRUD API,用于管理Shipwright代理商——env vars,克龙活口,指使,工具,和插件. 这也暴露出部署的特工用于获取其配置的运行时间API.

HTTP 服务器在 `admin/src/main.ts`,它由管理员UI,管理员CRUD API,代理运行时间API组成一个在端口3000运行的Hono应用程序.

## 本地运行

```bash
# From repo root — install all workspace deps
bun install

# Export required env vars (see Environment Variables table below)
export DATABASE_URL_SHIPWRIGHT_ADMIN=postgresql://...
export SHIPWRIGHT_SESSION_SECRET=...
# ... (remaining vars)

# Run the admin server
bun run admin/src/main.ts
```

服务收听 `http://localhost:3000` 默认。 访问 `/admin` 为UI.

## 环境变量

| 变量 | 需求 | 说明 |
| --- | --- | --- |
| `DATABASE_URL_SHIPWRIGHT_ADMIN` | 对 | PostgreSQL 管理员 Prisma 计划连接字符串 |
| `SHIPWRIGHT_SESSION_SECRET` | 对 | JWT 管理 UI 会话的 cookie 秘密 |
| `GOOGLE_CLIENT_ID` | 对 | Google OAuth 2. 0 管理员用户界面登录客户端ID |
| `GOOGLE_CLIENT_SECRET` | 对 | Google OAuth 2. 0 客户端秘密 |
| `SHIPWRIGHT_ADMIN_ALLOWED_EMAILS` | 对 | 允许登录的以逗号分隔的电子邮件列表 |
| `SHIPWRIGHT_ADMIN_APP_BASE_URL` | 对 | OAuth 重定向( 默认为 `http://localhost:3000`(中文(简体) ) |
| `SHIPWRIGHT_ADMIN_API_KEYS` | 没有 | 逗号分隔 `name:token:scope` 无记名证的图纸 范围是 `*`探员身份, `platform.read` 或者说 `platform.ops` (没有指针)——参见: [文档/代理人](https://npmcn.com/package/%40app-vitals/docs/agent-api.md) |
| `SHIPWRIGHT_ENCRYPTION_KEY` | 建议 | AES-256-GCM 存储机密加密的64 Char 十六进制密钥 |
| `PORT` | 没有 | HTTP 服务器端口( 默认为 `3000`(中文(简体) ) |

## 数据库

管理员服务使用自有的PostgreSQL数据库. 开始前运行迁移 :

```bash
export DATABASE_URL_SHIPWRIGHT_ADMIN=postgres://...
cd admin && bunx prisma migrate deploy --schema=prisma/schema
```

## 构建 Docker 图像

从 repo 根来构建( Dockerfile 使用完整的 monorepo 上下文) :

```bash
docker build -f admin/Dockerfile -t shipwright-admin .
```

运行图像 :

```bash
docker run \
  -e DATABASE_URL_SHIPWRIGHT_ADMIN=postgres://... \
  -e SHIPWRIGHT_SESSION_SECRET=... \
  -e GOOGLE_CLIENT_ID=... \
  -e GOOGLE_CLIENT_SECRET=... \
  -e SHIPWRIGHT_ADMIN_ALLOWED_EMAILS=admin@example.com \
  -e SHIPWRIGHT_ADMIN_APP_BASE_URL=https://admin.example.com \
  -p 3000:3000 \
  shipwright-admin
```

## 部署

提供GKE部署+服务清单 [`admin/deploy/deployment.yaml`](https://npmcn.com/package/%40app-vitals/agent-admin/deploy/deployment.yaml)。 。 。 .

它期望一个叫克伯尼特的秘密 `shipwright-admin-secret` 包含所有必需的外壳。 参见"明细表"上方的注释用于设置指示.

## 常见问题

### @app-vitals/agent-admin 是什么？

轮船管理服务 — CRUD API \+ UI 用于代理, env vars, cron jobs, 代币, 工具和插件

### 如何安装 @app-vitals/agent-admin？

在项目目录运行 npm install @app-vitals/agent-admin，或使用 pnpm add / yarn add / bun add。

### @app-vitals/agent-admin 支持 TypeScript 吗？

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

### @app-vitals/agent-admin 支持 ESM 还是 CommonJS？

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

### @app-vitals/agent-admin 可以商用吗？

@app-vitals/agent-admin 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @app-vitals/agent-admin 的下载量有多少？

根据 npm 官方下载统计，@app-vitals/agent-admin 在 2026/10/07 – 2026/11/05 这 30 天内被下载 11,317 次，日均约 377 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @app-vitals/agent-admin 还在维护吗？

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