# @adminiumjs/adminium 中文文档

规范地址：https://npmcn.com/package/%40adminiumjs/adminium/

版本：0\.3\.50
npm 元数据更新时间：2026-11-07T19:20:00.723Z
中文译文更新时间：2026-11-06T06:40:09.037Z
软件包许可：AGPL-3\.0-only

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

原始 npm 页面：https://www.npmjs.com/package/%40adminiumjs/adminium
原文对照：https://npmcn.com/package/%40adminiumjs/adminium/?lang=original
项目主页：https://adminium.dev/
源码仓库：https://github.com/MoSofi/Adminium

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

- 包体积（解压后）：154 MB，11235 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：^22\.14\.0 \|\| \>=23\.6\.0
- 运行依赖：37 个
- 首次发布：2026-07-21T14:18:05.948Z
- 最新版本发布：2026-11-07T19:20:00.359Z
- 近 30 天下载量：4415（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：73（近 12 个月 73 个）

## 中文简介

快捷服务器: REST /api/v1, auth, 任务, 服务仪表板构建

## 安装

```sh
npm install @adminiumjs/adminium
```

也可以使用：`pnpm add @adminiumjs/adminium`、`yarn add @adminiumjs/adminium`、`bun add @adminiumjs/adminium`

## README

# 管理

**从连接字符串到运出仪表板.**

管理内观 数据库——或 schema 文件——将结构分类 它找到关系,并生成一个完整的,可操作的 React admin 仪表板。 这个 软件包是一个安装中的全部产品:快活 API,元存储 迁移,CLI, 和它服务的预先建造的仪表板.

Adminium 免费且开源 **仅限AGPL-3.0**来源、问题和 释放: [https://github.com/MoSofi/Adminium (英语)](https://github.com/MoSofi/Adminium)。 。 。 .

> **npm 命名。 (中文(简体) ).** 这个 `@adminium` 范围和未覆盖的名称 `adminium` 两个晚上 属于无关的一方。 行政出版物 **`@adminiumjs`** - 安装 `@adminiumjs/adminium`从不裸露 `adminium`。已安装的命令仍然 `adminium`。 。 。 .

## 安装

创建项目并运行它 :

```sh
npx @adminiumjs/adminium new my-admin --sample
cd my-admin
npm run dev
```

或在全球安装命令 :

```sh
npm install -g @adminiumjs/adminium
adminium new my-admin
```

需要22.14节点或更新. 在一个更古老的节点上 CLI会用一个 留言说.

运行 `adminium` 没有参数创建工程: 它请求创建文件夹 名称和运行 `adminium new`。在没有项目的情况下,运行 `adminium try`:它要求数据库连接,探测它,生成 应用程序,并启动服务器 [http://localhost:4600 (英语)](http://localhost:4600/)。 。 。 .

## 图标

| 命令 | 它会做什么 |
| --- | --- |
| `adminium new [name]` | 创建工程文件夹( 或创建当前文件夹之一) , 与 `--sample` 用于演示数据库 |
| `adminium dev` | 运行一个工程, 当它配置或 `.env` 更改并重新装入其钩子、动作、页面和部件 |
| `adminium build` | 将工程的配置、 钩子、 动作、 页面和部件编译到 `.adminium/build` |
| `adminium check` | 检查一个工程、 其页面文件、 钩子、 动作、 页面和部件而不启动( 对于 CI) |
| `adminium pull [--from <url>]` | 从其数据库或运行它的服务器中写入工程的页面和计划文件 |
| `adminium eject <address>` | 将页面文件转换成以 React 写的页面 |
| `adminium try` 编号 : `adminium init` | 没有项目的互动设置: 连接数据库、 生成应用程序、 启动服务器 |
| `adminium start` | 启动服务器并服务仪表板(`--port`, (中文(简体) ), `--host`在一个项目中,项目 |
| `adminium introspect --connection <id>` | 透视连接并存储图示 |
| `adminium migrate [--status]` | 运行元存储迁移( 密码) |
| `adminium export-zip` | 导出实例配置为可运行的捆绑 |
| `adminium import-zip --in <file>` | 导入实例配置捆绑 |
| `adminium generate-prompt` | 构建 LLM 浓缩快取( 旋转自带) |
| `adminium apply-llm-response` | 验证LLM响应并应用被接受的建议 |

`adminium --help`,或 `adminium <command> --help`,打印全旗列表.

## 配置

一切都是环境驱动的, 一次验证在启动.

| 变量 | 目的 |
| --- | --- |
| `ADMINIUM_SECRET` | **要求.** 大师秘诀 第16章 Chars——如. `openssl rand -hex 32` |
| `PORT` | 听取端口( 默认) `4600`(中文(简体) ) |
| `HOST` | 绑定地址( 默认) `0.0.0.0`(中文(简体) ) |
| `ADMINIUM_META_URL` | 元存储 DSN : `postgres://`, (中文(简体) ), `mysql://`,或 `sqlite:<path>` |
| `ADMINIUM_DATA_DIR` | 文件、导出和备份的可写入目录(默认) `./data`(中文(简体) ) |
| `ADMINIUM_LOG_LEVEL` | `trace`.`fatal` (默认) `info`(中文(简体) ) |
| `ADMINIUM_TRUST_PROXY` | 在 TLS 终止代理后启用 |
| `ADMINIUM_TRUSTED_PROXIES` | 位于该代理地址( 默认) `loopback,uniquelocal`(中文(简体) ) |
| `ADMINIUM_CORS_ORIGINS` | 以逗号分隔的允许来源 |
| `ADMINIUM_BRIDGE_ORIGINS` | 允许将此实例交给连接字符串的出处( Q)`--bridge`(中文(简体) ) |
| `ADMINIUM_NETWORK_FEATURES` | `off` 用户界面停止提供网页/OAuth |
| `ADMINIUM_MAP_SERVER` | 地图图片的出处( 默认) `https://tiles.openfreemap.org`(三); `off` 没有地图 |
| `ADMINIUM_ROUTING_SERVER` | OSRM 服务器在设置中打开后询问了沿路的路由( 默认) `https://router.project-osrm.org`(三); `off` 仅限直线估算 |
| `ADMINIUM_TELEMETRY` | `off` 默认 |

缺少或错误的值会用打印的固定键使靴子失效,而不是 启动半配置服务器 .

### 数据库

管理员通过 **邮递SQL**, (中文(简体) ), **MySQL/马里亚DB** 财务报告和审定财务报表 **SQL 点** 适应器. 元商店(Adminium的自有) `adminium_*` (表)运行在Postgres, MySQL 或嵌入式 SQLite 文件; 作为可选的 Postgres 和 MySQL 驱动程序船 依附关系,所以 `--no-optional` 生成只安装 SQLite .

## 里面的东西

此软件包包含服务器自负载的内部软件包 `node_modules/@adminium/`数字 : `engine`, (中文(简体) ), `meta`, (中文(简体) ), `i18n`, (中文(简体) ), `llm`, (中文(简体) ), `schema-import`, (中文(简体) ), `manifest`, (中文(简体) ), `add-on-contracts`, (中文(简体) ), `widgets` 和三个数据库适配器。 他们 列于 `bundleDependencies`,所以npm安装它们 从这个焦油球和 从未从登记簿中取出过它们,以及编成的 `@adminium/*` 进口 解析这些文件夹。 仪表板船在 `dashboard/`因此无 正在安装其浏览器库. `schemas/` 拥有JSON史克马 工程的页面和计划文件名称 `$schema`,以及 `templates/` 页:1 文件 `adminium new` 写作.

## 相关软件包

-   `@adminiumjs/public-client`: 客户端的app前端用于调用 Adminium 这是公开的API.
-   `@adminiumjs/manifest` 财务报告和审定财务报表 `@adminiumjs/add-on-contracts`: 显式图案 和附加合同,用于附加宿主.

## 许可证

AGPL-3.0 -仅限. 此软件包的完整对应来源位于 [https://github.com/MoSofi/Adminium (英语)](https://github.com/MoSofi/Adminium)见捆绑 `LICENSE`。 。 。 .

## 常见问题

### @adminiumjs/adminium 是什么？

快捷服务器: REST /api/v1, auth, 任务, 服务仪表板构建

### 如何安装 @adminiumjs/adminium？

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

### @adminiumjs/adminium 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @adminiumjs/adminium 支持 ESM 还是 CommonJS？

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

### @adminiumjs/adminium 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^22\.14\.0 \|\| \>=23\.6\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @adminiumjs/adminium 可以商用吗？

@adminiumjs/adminium 使用 AGPL-3\.0-only 许可。最严格的 Copyleft：除分发外，通过网络向用户提供基于它的服务也需要开源对应源码。闭源 SaaS 使用前务必评估。以上为概括，不构成法律意见，请以许可原文为准。

### @adminiumjs/adminium 的下载量有多少？

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

### @adminiumjs/adminium 还在维护吗？

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