# @haxtheweb/haxcms-nodejs 中文文档

规范地址：https://npmcn.com/package/%40haxtheweb/haxcms-nodejs/

版本：26\.8\.1
npm 元数据更新时间：2026-08-14T21:17:10.006Z
中文译文更新时间：2026-11-17T14:18:42.364Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40haxtheweb/haxcms-nodejs
原文对照：https://npmcn.com/package/%40haxtheweb/haxcms-nodejs/?lang=original
项目主页：https://hax.psu.edu/
源码仓库：https://github.com/haxtheweb/haxcms-nodejs

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

- 包体积（解压后）：37.9 MB，4223 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=18\.20\.3
- 运行依赖：36 个
- 首次发布：2024-06-17T20:48:10.725Z
- 最新版本发布：2026-08-14T21:17:09.773Z
- 近 30 天下载量：5387（2026-10-18 至 2026-11-16，npm 官方下载统计）
- 已发布版本数：61（近 12 个月 4 个）

## 中文简介

HAXcms 单站点和多站点节点服务器、 api 和管理

## 安装

```sh
npm install @haxtheweb/haxcms-nodejs
```

也可以使用：`pnpm add @haxtheweb/haxcms-nodejs`、`yarn add @haxtheweb/haxcms-nodejs`、`bun add @haxtheweb/haxcms-nodejs`

## README

[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/haxtheweb/haxcms-nodejs/badge)](https://securityscorecards.dev/viewer/?uri=github.com/haxtheweb/haxcms-nodejs) [![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](https://npmcn.com/SUPPORT.md) [![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://npmcn.com/CODE_OF_CONDUCT.md) [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/EKYJAjqGhf) [![Lit](https://img.shields.io/badge/-Lit-324fff?style=flat&logo=data:image/svg%2bxml;base64,PHN2ZyBmaWxsPSIjZmZmIiB2aWV3Qm94PSIwIDAgMTYwIDIwMCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCBkPSJtMTYwIDgwdjgwbC00MC00MHptLTQwIDQwdjgwbDQwLTQwem0wLTgwdjgwbC00MC00MHptLTQwIDQwdjgwbDQwLTQwem0tNDAtNDB2ODBsNDAtNDB6bTQwLTQwdjgwbC00MC00MHptLTQwIDEyMHY4MGwtNDAtNDB6bS00MC00MHY4MGw0MC00MHoiLz48L3N2Zz4%3D)](https://lit.dev/) [![#HAXTheWeb](https://img.shields.io/badge/-HAXTheWeb-999999FF?style=flat&logo=data:image/svg%2bxml;base64,PHN2ZyBpZD0iZmVhMTExZTAtMjEwZC00Y2QwLWJhMWQtZGZmOTQyODc0Njg1IiBkYXRhLW5hbWU9IkxheWVyIDEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDE4NC40IDEzNS45NyI+PGRlZnM+PHN0eWxlPi5lMWJjMjAyNS0xODAwLTRkYzItODc4NS1jNDZlZDEwM2Y0OTJ7ZmlsbDojMjMxZjIwO308L3N0eWxlPjwvZGVmcz48cGF0aCBjbGFzcz0iZTFiYzIwMjUtMTgwMC00ZGMyLTg3ODUtYzQ2ZWQxMDNmNDkyIiBkPSJNNzguMDcsODMuNDVWNTVIODYuMnY4LjEzaDE2LjI2djQuMDdoNC4wN1Y4My40NUg5OC40VjY3LjE5SDg2LjJWODMuNDVaIi8+PHBvbHlnb24gcG9pbnRzPSIxNTMuMTMgNjMuNyAxNTMuMTMgNTEuMzkgMTQwLjU0IDUxLjM5IDE0MC41NCAzOS4wOSAxMjcuOTUgMzkuMDkgMTI3Ljk1IDI2Ljc5IDEwMi43OCAyNi43OSAxMDIuNzggMzkuMDkgMTE1LjM2IDM5LjA5IDExNS4zNiA1MS4zOSAxMjcuOTUgNTEuMzkgMTI3Ljk1IDYzLjcgMTQwLjU0IDYzLjcgMTQwLjU0IDc2IDEyNy4zNiA3NiAxMjcuMzYgODguMyAxMTQuNzggODguMyAxMTQuNzggMTAwLjYxIDEwMi4xOSAxMDAuNjEgMTAyLjE5IDExMi45MSAxMjcuMzYgMTEyLjkxIDEyNy4zNiAxMDAuNjEgMTM5Ljk1IDEwMC42MSAxMzkuOTUgODguMyAxNTIuNTQgODguMyAxNTIuNTQgNzYgMTY1LjcyIDc2IDE2NS43MiA2My43IDE1My4xMyA2My43Ii8+PHBvbHlnb24gcG9pbnRzPSIzMy4xMyA2My43IDMzLjEzIDUxLjM5IDQ1LjcyIDUxLjM5IDQ1LjcyIDM5LjA5IDU4LjMxIDM5LjA5IDU4LjMxIDI2Ljc5IDgzLjQ4IDI2Ljc5IDgzLjQ4IDM5LjA5IDcwLjg5IDM5LjA5IDcwLjg5IDUxLjM5IDU4LjMxIDUxLjM5IDU4LjMxIDYzLjcgNDUuNzIgNjMuNyA0NS43MiA3NiA1OC44OSA3NiA1OC44OSA4OC4zIDcxLjQ4IDg4LjMgNzEuNDggMTAwLjYxIDg0LjA3IDEwMC42MSA4NC4wNyAxMTIuOTEgNTguODkgMTEyLjkxIDU4Ljg5IDEwMC42MSA0Ni4zMSAxMDAuNjEgNDYuMzEgODguMyAzMy43MiA4OC4zIDMzLjcyIDc2IDIwLjU0IDc2IDIwLjU0IDYzLjcgMzMuMTMgNjMuNyIvPjwvc3ZnPg==)](https://haxtheweb.org/) [![Published on npm](https://img.shields.io/npm/v/@haxtheweb/haxcms-nodejs?style=flat)](https://www.npmjs.com/package/@haxtheweb/haxcms-nodejs) [![build](https://github.com/haxtheweb/haxcms-nodejs/workflows/build/badge.svg)](https://github.com/haxtheweb/haxcms-nodejs/actions) [![X](https://img.shields.io/twitter/follow/haxtheweb.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=haxtheweb)

# 有节点后端的 HAXcms

在 HAXsite 或 HAXcms 实例中启动服务器

![HAXcms nodejs backend](https://npmcn.com/package/%40haxtheweb/haxcms-nodejs/screenshots/haxcms-nodejs.png)

## 运行命令

```bash
npm install
npm start
```

访问http://localhost:3:00 如果它不自动打开

## API 符合性测试

运行端点匹配检查 `src/openapi/site-spec.yaml`数字 :

```bash
npm run test:api-conformance
```

跑跑者创建出一个孤立的跑跑时间工作空间,然后在结束点检查运行前通过API将一个真正的站点绑住.

-   第一个靴子舞步呼叫 `createSite` 并生成运行时站点名称 :
    -   `haxcms-test-harness-{timestampStartOfTest}`
-   所有符合要求的呼声都与真正的站点路径相撞.
-   可选运行时间登录覆盖值 :
    -   `HAXCMS_TEST_USERNAME`
    -   `HAXCMS_TEST_PASSWORD`

运行时间认证覆盖也通过全局程序得到支持 :

-   `globalThis.HAXCMS_RUNTIME_CREDENTIALS = { username, password }`
-   `globalThis.HAXCMS_RUNTIME_USERNAME`
-   `globalThis.HAXCMS_RUNTIME_PASSWORD`

### 当前报道概况

目前这个寄存器的自动测试覆盖是API兼容套件:

-   套接字文件 : `test/api-conformance/site-spec.conformance.test.cjs`
-   脚本 : `npm run test:api-conformance`
-   额外的测试脚本/套件目前没有被接入 `package.json`

套房目前验证:

-   发现/光谱终点:
    -   `getSiteApiDiscovery`, (中文(简体) ), `getSiteOpenApi`, (中文(简体) ), `getSiteOpenApiJson`, (中文(简体) ), `getSiteOpenApiYaml`, (中文(简体) ), `getApiCatalog`
-   站点/内容图终点 :
    -   `getSiteSummary`, (中文(简体) ), `listEntityDescriptors`, (中文(简体) ), `listSchemas`, (中文(简体) ), `listItems`, (中文(简体) ), `getItemByIdOrSlug`, (中文(简体) ), `listContent`, (中文(简体) ), `getContentByIdOrSlug`, (中文(简体) ), `listTags`, (中文(简体) ), `searchContent`
-   组件和元数据终点:
    -   `listCustomElements`, (中文(简体) ), `getCustomElementByName`, (中文(简体) ), `listBlocks`, (中文(简体) ), `getBlockByName`, (中文(简体) ), `getBlockUsage`, (中文(简体) ), `listRegions`, (中文(简体) ), `getRegionByName`
-   主题/报告/观点/分析终点:
    -   `listThemes`, (中文(简体) ), `getActiveTheme`, (中文(简体) ), `getThemeByName`, (中文(简体) ), `listReports`, (中文(简体) ), `getReportByName`, (中文(简体) ), `getAnalyticsCapabilities`, (中文(简体) ), `listViews`, (中文(简体) ), `getViewById`, (中文(简体) ), `getViewResults`, (中文(简体) ), `listDisplaysAlias`, (中文(简体) ), `getDisplayResultsAlias`
-   安全文件和修订终点 :
    -   `listFiles`, (中文(简体) ), `createFile`, (中文(简体) ), `getFileByUuid`, (中文(简体) ), `updateFileByUuid`, (中文(简体) ), `deleteFileByUuid`, (中文(简体) ), `listItemRevisions`

同一套间中的行为覆盖率包括:

-   OpenAPI 响应/测试符合性检查
-   对安全路径进行认证矩阵检查( 无认证、 仅限无记名、 无效的站点标志、 有效站点标志)
-   边界/误差检查(缺失所需的参数、无效的ID/slugs、pagigation/query边界)
-   代表/负责人检查`json`, (中文(简体) ), `yaml`, (中文(简体) ), `xml`, (中文(简体) ), `md`, (中文(简体) ), `html` 支助地点)
-   端到端文件生命周期检查(创建 ~ 列表/查找 ~ 获取 ~ 更新 ~ 删除)

在套间中临时已知跳过 :

-   `getApiCatalog returns linkset payload`
    -   原因:运行时间 `/.well-known/api-catalog` 固定行为仍在最后确定中

## MCP和部署概况

-   MCP 策略默认通过 `_config/config.json`。 。 。 .
-   新的安装包括:
    -   `deploymentProfile`数字 : `single-site`, (中文(简体) ), `self-hosted-multi-site`,或 `haxiam-managed`
    -   `mcp.enabled`: 全球MCP 切换
    -   `mcp.readOnly`: 为未来的 MCP 编写工具进行文字保护切换
-   默认行为 :
    -   `haxiam-managed` 除非明确启用,否则默认禁用 MCP .
    -   其他配置默认为 MCP , 启用只读模式 .

# 获取帮助/ 问题/ 支持

-   Discord 频道 - [https://discord.gg/EKYJAjqGhf 互联网档案馆的存檔,存档日期2013-12-21](https://discord.gg/EKYJAjqGhf)
-   统一问题队列 - [https://github.com/haxtheweb/issubs/issubs.com/hextheweb/issubs/issubs.com/hextheweb/issubs/issubs.com/hexthewebs/hissubs/issubs.com/hexthewebs/hissubs/hissubs.com/hexthewebs/hissubs/hissubs/hissub.com/hexthewebs/hissubs/hissubs/hissub.com/hxthewebs/hissubs/hissubs/hissubs/hissub.com/hissub.com/hex. 互联网网站网站 互联网网站 互联网网站网站 互联网网站 互联网网站 互联网网站 互联网网站 互联网网站 互联网网站 互联网网站 互联网网站 互联网网站 互联网网站 互联网网站 互联网网站](https://github.com/haxtheweb/issues/issues)
-   在任意HAX空格中直接使用Merlin并输入"Issue"来跳出一个报告!

## 观看和学习更多关于HAX在这里:

-   试试Hax: [https://hax.cloud (英语)](https://hax.cloud/)
-   有害物质 [https://haxtheweb.org/ what-is-hax 页面存档备份,存于互联网档案馆](https://haxtheweb.org/what-is-hax)
-   Youtube频道 - https://www.youtube.com/@haxtheweb

# 相关链接和技术

-   [国家预防机制 软件包列表](https://www.npmjs.com/org/haxtheweb)
-   [HAXcms (节点JS)](https://github.com/haxtheweb/haxcms-nodejs)
-   [有害物质(PHP)](https://github.com/haxtheweb/haxcms-php)
-   [故事书文件](https://open-apis.hax.cloud/)
-   [HAX \[点\] PSU](https://hax.psu.edu/)
-   [HAX 医生网站](https://haxtheweb.org/)
-   [HAX + 11 二号](https://github.com/haxtheweb/hax11ty)

![HAX Traveler: World Changer](https://raw.githubusercontent.com/haxtheweb/art/refs/heads/main/haxtheweb/hax-traveler-world-changer.jpg)

## 常见问题

### @haxtheweb/haxcms-nodejs 是什么？

HAXcms 单站点和多站点节点服务器、 api 和管理

### 如何安装 @haxtheweb/haxcms-nodejs？

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

### @haxtheweb/haxcms-nodejs 支持 TypeScript 吗？

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

### @haxtheweb/haxcms-nodejs 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @haxtheweb/haxcms-nodejs 需要什么版本的 Node\.js？

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

### @haxtheweb/haxcms-nodejs 可以商用吗？

@haxtheweb/haxcms-nodejs 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @haxtheweb/haxcms-nodejs 的下载量有多少？

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

### @haxtheweb/haxcms-nodejs 还在维护吗？

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

