# @north-light/env-docker 中文文档

规范地址：https://npmcn.com/package/%40north-light/env-docker/

版本：0\.3\.573
npm 元数据更新时间：2026-11-01T23:58:10.870Z
中文译文更新时间：2026-11-02T01:17:35.256Z
软件包许可：UNLICENSED

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

原始 npm 页面：https://www.npmjs.com/package/%40north-light/env-docker
原文对照：https://npmcn.com/package/%40north-light/env-docker/?lang=original
项目主页：https://github.com/Northlight-Systems/crouter#readme
源码仓库：https://github.com/Northlight-Systems/crouter

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

- 包体积（解压后）：19.4 kB，13 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-10-09T21:02:05.884Z
- 最新版本发布：2026-11-01T23:58:10.688Z
- 已发布版本数：161（近 12 个月 161 个）

## 中文简介

用于路由器SDK的Docker连接管理器-通过Docker CLI启动，连接和停止crtrd容器。零路由器导入。

## 安装

```sh
npm install @north-light/env-docker
```

也可以使用：`pnpm add @north-light/env-docker`、`yarn add @north-light/env-docker`、`bun add @north-light/env-docker`

## README

# @ northlight /env-docker -从Node启动并连接到crtrd容器

![crouter](https://raw.githubusercontent.com/Northlight-Systems/crouter/main/assets/banner.svg)

[![npm](https://img.shields.io/npm/v/@north-light/env-docker?label=npm)](https://www.npmjs.com/package/@north-light/env-docker)

`@north-light/env-docker` 开始，连接和停止 `crtrd` （crouter守护进程）Docker容器通过 `docker` 命令行执行命令，并返回指定的连接设置 [`@north-light/sdk`](https://www.npmjs.com/package/@north-light/sdk) 需要。它没有依赖项，包括SDK。

它不是Docker客户端库或编排器：它运行一个容器并告诉您如何访问它。该映像不包含模型凭据，因此在运行代理执行任何操作之前，您需要在容器内配置提供程序。

[文档](https://crouter.docs.northlight.ai/docs/sdk/docker) · [SDK](https://crouter.docs.northlight.ai/docs/sdk) · [克劳特库](https://github.com/Northlight-Systems/crouter) · [来源](https://github.com/Northlight-Systems/crouter/tree/main/packages/crouter-env-docker)

## 安装

```bash
npm install @north-light/env-docker @north-light/sdk
```

必须打开Docker命令行 `PATH`，并能拉动 `ghcr.io/northlight-systems/crtrd` （或者你传递的图像）。

## 启动容器

```ts
import { start } from '@north-light/env-docker';
import Crouter from '@north-light/sdk';

const env = await start({
  name: 'my-crouter',
  volume: 'my-agent-home',
});

const client = new Crouter(env.connection());
console.log(await client.system.health());

await env.stop();
```

`start()` 创建一个容器 `ghcr.io/northlight-systems/crtrd:latest` 除非你通过 `image`，生成一个承载令牌，授予图像的沙盒启动器所需的特权(`SYS_ADMIN` 和 `NET_ADMIN`（无限制的seccomp和AppArmor），将映射的端口绑定到 `127.0.0.1`，等待 `/healthz`. `connection()` 返回 `{ baseURL, headers }`，形状 `new Crouter(...)` 需要。 `stop()` 移除容器。

选项: `env` 设置容器环境变量， `port` 选择主机端口。 `volume` 将命名Docker卷挂载到 `/volume`，图像的声明体积。命名卷在重新创建容器时保存画布状态、内存和已安装的凭据。

## 附加到现有容器

```ts
import { attach } from '@north-light/env-docker';

const env = await attach('my-crouter');
const connection = env.connection();
await env.stop(); // stops the container but does not remove it
```

`attach(name)` 读取容器的映射端口及其 `CRTRD_TOKEN`.

## 相关

-   [`@north-light/sdk`](https://www.npmjs.com/package/@north-light/sdk) -消费的客户端 `connection()`.
-   [`docker/README.md`](https://github.com/Northlight-Systems/crouter/blob/main/docker/README.md) -运行 `crtrd` 图像与 `docker run`，它的环境变量，并在本地构建它。
-   [主要存储库](https://github.com/Northlight-Systems/crouter) - - - `crtr` CLI, `crtrd` 守护进程。

## 许可证

专有的。版权所有2026 Northlight Systems版权所有。看到 `LICENSE`.

## 常见问题

### @north-light/env-docker 是什么？

用于路由器SDK的Docker连接管理器-通过Docker CLI启动，连接和停止crtrd容器。零路由器导入。

### 如何安装 @north-light/env-docker？

在项目目录运行 npm install @north-light/env-docker，或使用 pnpm add / yarn add / bun add。

### @north-light/env-docker 支持 TypeScript 吗？

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

### @north-light/env-docker 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @north-light/env-docker 可以商用吗？

@north-light/env-docker 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @north-light/env-docker 还在维护吗？

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