# @arbol-ai/maximus 中文文档

规范地址：https://npmcn.com/package/%40arbol-ai/maximus/

版本：8\.4\.0
npm 元数据更新时间：2026-11-07T19:39:07.721Z
中文译文更新时间：2026-11-06T14:36:18.006Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：785 kB，121 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：7 个
- peer 依赖：cf \>=1\.0\.0-beta\.23，pg ^8\.23\.1，vite ^8\.3\.4，oxfmt \>=0\.71\.0 \<1，oxlint ^1\.86\.0，ultracite ^8\.1\.0，@cloudflare/vite-plugin \>=2\.0\.0-beta\.v\.5
- 首次发布：2026-10-18T21:48:21.772Z
- 最新版本发布：2026-11-07T19:39:06.511Z
- 近 30 天下载量：2982（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 14 个）

## 中文简介

Maximus:一次定义一个服务,并在Cloudflare Workers上通过HTTP,MCP和Worker RPC服务,配置于 vite.config.ts,带有其OpenAPI和CLI.

## 安装

```sh
npm install @arbol-ai/maximus
```

也可以使用：`pnpm add @arbol-ai/maximus`、`yarn add @arbol-ai/maximus`、`bun add @arbol-ai/maximus`

## README

# @ arbol-ai/ maximus

Maximus在Cloudflare工人上建立了组织范围API,人们和AI的特工们都这样称呼. 每个 路由是一个文件,它一次宣布它的处理器和合同,同一个工人通过HTTP为它服务 带有 OpenAPI 3.1 文件, 当路由命名时作为 MCP 工具, 并超越本地 RPC 到 Workers 你允许.

```sh
bun create maximus my-api
```

```ts
// routes/v1/notes/[noteId].get.ts
import { defineHandler, UuidSchema } from '@arbol-ai/maximus';

import { NoteSchema } from '#src/notes.ts';

/** GET /api/v1/notes/{noteId}, also the MCP tool get_note: one note of the caller's organization. */
export default defineHandler(
  async ({ input, notes, fail }) => {
    const note = await notes.find(input.noteId);
    if (!note) {
      return fail('NOTE_NOT_FOUND');
    }
    return note;
  },
  {
    description: 'Read one note of the organization by its id.',
    input: { noteId: UuidSchema },
    output: NoteSchema,
    failures: ['NOTE_NOT_FOUND'],
    mcp: { name: 'get_note' },
  }
);
```

这个包是框架。 它的根入有路线和操作,TypeBox schemas,指使和 范围、 错误目录和带有 OpenAPI 文档的 HTTP 处理器; 每个可选的能力都是一种 其自己的条目,例如: `@arbol-ai/maximus/mcp`, (中文(简体) ), `/workers` 或者说 `/postgres`工人只携带 输入。 软件包安装 `maximus` 命令和船舶 马克西穆斯的编码工具 内 `skills/maximus/`。 。 。 . `maximus()` 从 `@arbol-ai/maximus/vite` 制造 `vite.config.ts` 一个项目的一 配置 .

-   [开始](https://github.com/getarbol/maximus/blob/main/docs/getting-started.md)
-   [概念](https://github.com/getarbol/maximus/blob/main/docs/concepts.md)
-   [软件包出口](https://github.com/getarbol/maximus/blob/main/docs/reference/exports.md),每个条目
-   [国 际](https://github.com/getarbol/maximus/blob/main/docs/reference/cli.md),则 `maximus` 命令
-   [所有文档](https://github.com/getarbol/maximus/blob/main/docs/README.md)

根据麻省理工学院的许可获释.

## 常见问题

### @arbol-ai/maximus 是什么？

Maximus:一次定义一个服务,并在Cloudflare Workers上通过HTTP,MCP和Worker RPC服务,配置于 vite\.config\.ts,带有其OpenAPI和CLI\.

### 如何安装 @arbol-ai/maximus？

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

### @arbol-ai/maximus 支持 TypeScript 吗？

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

### @arbol-ai/maximus 支持 ESM 还是 CommonJS？

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

### @arbol-ai/maximus 可以商用吗？

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

### @arbol-ai/maximus 的下载量有多少？

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

### @arbol-ai/maximus 还在维护吗？

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