# @agnt-sdk/config 中文文档

规范地址：https://npmcn.com/package/%40agnt-sdk/config/

版本：0\.0\.2
npm 元数据更新时间：2026-10-25T13:50:48.876Z
中文译文更新时间：2026-11-05T23:52:29.501Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40agnt-sdk/config
原文对照：https://npmcn.com/package/%40agnt-sdk/config/?lang=original
项目主页：https://github.com/agnt-ai/agnt-node/tree/main/packages/config#readme
源码仓库：https://github.com/agnt-ai/agnt-node

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

- 包体积（解压后）：9.7 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：0 个
- 首次发布：2026-03-05T23:14:14.961Z
- 最新版本发布：2026-03-05T23:14:59.248Z
- 近 30 天下载量：8846（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 2 个）

## 中文简介

@agnt-sdk 包的共享配置加载器

## 安装

```sh
npm install @agnt-sdk/config
```

也可以使用：`pnpm add @agnt-sdk/config`、`yarn add @agnt-sdk/config`、`bun add @agnt-sdk/config`

## README

# @ agnt- sdk/ 配置

共享配置加载器 `@agnt-sdk` 软件包家庭.

所有 SDK 软件包都从同一处读取 `agnt.config.js` (或 `agnt.config.ts`)档案. 此软件包提供了类型定义和从目录树上走出的文件发现逻辑 `process.cwd()` 直到它找到配置文件——ESLint和TypeScript等工具使用的同一种常规.

## 安装

```bash
npm install @agnt-sdk/config
```

你通常不需要直接安装这个——这是对等的依赖性 `@agnt-sdk/client` 财务报告和审定财务报表 `@agnt-sdk/studio`。 。 。 .

## 配置文件

创建 `agnt.config.js` 在您的项目根部 :

```js
// agnt.config.js
export default {
  // Required by @agnt-sdk/client
  privateKey: `-----BEGIN PRIVATE KEY-----
MIIEvQIBADANBgkqhk...
-----END PRIVATE KEY-----`,
  kid: 'your-key-id',          // Key ID from the Agnt dashboard → Certificates

  // Required by all packages
  apiUrl: 'https://api.agnt.ai',

  // Required by @agnt-sdk/studio
  serviceKey: '',               // Optional: for private/unlisted prompts
  outputDir: './agnt/prompts',  // Where pulled manifests are saved
  apiMode: false,               // true = always fetch from API; false = use local files
};
```

## 使用量

```ts
import { loadConfig } from '@agnt-sdk/config';
import type { AgntConfig } from '@agnt-sdk/config';

const config: AgntConfig = await loadConfig();
```

### 覆盖搜索路径

```ts
const config = await loadConfig('/path/to/project');
```

### 直接通过配置( 不需要文件)

所有 SDK 软件包接受可选 `config` 绕过文件发现的参数——在没有配置文件的无服务器环境中有用:

```ts
const client = await AgntClient.create({
  config: {
    privateKey: process.env.AGNT_PRIVATE_KEY,
    kid: process.env.AGNT_KID,
    apiUrl: 'https://api.agnt.ai',
  }
});
```

## `AgntConfig` 类型参考

```ts
interface AgntConfig {
  /** RSA private key PEM — used by @agnt-sdk/client for RS256 JWT signing */
  privateKey?: string;

  /** Key ID registered on the Agnt platform — included in JWT header */
  kid?: string;

  /** Agnt API base URL, e.g. 'https://api.agnt.ai' */
  apiUrl: string;

  /** Service key for accessing private/unlisted prompts (@agnt-sdk/studio) */
  serviceKey: string;

  /** Directory where pulled manifest files are saved (@agnt-sdk/studio) */
  outputDir: string;

  /** true = fetch manifests from API on every execution (@agnt-sdk/studio) */
  apiMode: boolean;

  /** Max messages in agent loop before throwing — prevents infinite loops */
  maxMessages?: number;
}
```

## 许可证

麻省理工学院

## 常见问题

### @agnt-sdk/config 是什么？

@agnt-sdk 包的共享配置加载器

### 如何安装 @agnt-sdk/config？

在项目目录运行 npm install @agnt-sdk/config，或使用 pnpm add / yarn add / bun add。

### @agnt-sdk/config 支持 TypeScript 吗？

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

### @agnt-sdk/config 支持 ESM 还是 CommonJS？

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

### @agnt-sdk/config 需要什么版本的 Node\.js？

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

### @agnt-sdk/config 可以商用吗？

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

### @agnt-sdk/config 的下载量有多少？

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

### @agnt-sdk/config 还在维护吗？

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