# @codeyam-editor/codeyam-editor 中文文档

规范地址：https://npmcn.com/package/%40codeyam-editor/codeyam-editor/

版本：0\.1\.20
npm 元数据更新时间：2026-11-08T19:02:42.166Z
中文译文更新时间：2026-11-10T08:31:35.681Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40codeyam-editor/codeyam-editor
原文对照：https://npmcn.com/package/%40codeyam-editor/codeyam-editor/?lang=original
项目主页：https://codeyam.com/

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

- 包体积（解压后）：5.1 MB，152 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>=20\.0\.0
- 运行依赖：1 个
- 首次发布：2026-04-06T12:43:40.208Z
- 最新版本发布：2026-11-08T19:02:42.020Z
- 近 30 天下载量：2946（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：77（近 12 个月 77 个）

## 中文简介

用于情景驱动开发的语言不可知性执行沙盒

## 安装

```sh
npm install @codeyam-editor/codeyam-editor
```

也可以使用：`pnpm add @codeyam-editor/codeyam-editor`、`yarn add @codeyam-editor/codeyam-editor`、`bun add @codeyam-editor/codeyam-editor`

## README

# 代码Yam 编辑器

一个由步骤驱动的AI构建编辑器,带有一个孤立的Live预览,情景捕捉,校验命令,以及一个 Rust Control API.

CodeYam编辑器运行在您的项目旁边,并驱动一个AI构建代理通过一个有计划的,分步骤的工作流程. 每个特征都与 _假设_ (数据状态) 演示它,在现场预览中显示 当你去和捕捉,以便它们可以 重新验证以后。 它与任意堆栈一起工作:网络应用,后端服务,CLI,库.

## 安装

**建议:一行安装器.** 它通过 npm 安装和放置 `codeyam-editor` 在你身边 `PATH`数字 :

```bash
curl -fsSL https://codeyam.com/install.sh | sh
```

它检查先决条件(Node 20或更新,Linux上一个最近足够多的glibc),运行全局 npm 安装,并添加 npm 的全局 `bin` 您 shell 配置文件的目录, 所以新 shell 找到 `codeyam-editor`它印着它到底改变了什么.

**普通npm 数据** (你负责) `PATH` 自己吗

```bash
npm install -g @codeyam-editor/codeyam-editor
```

> 如果您使用自定义 npm 前缀( 例如) `npm config set prefix ~/.npm-global` 为避免 `sudo`),添加其 `bin` 目录到 `PATH` 你自己来 否则安装成功, 但 shell 报告 `codeyam-editor: command not found`。单行安装器这样做是为了你.

**无安装: 一次性运行** 通过 npx :

```bash
npx @codeyam-editor/codeyam-editor
```

## 所需资源

-   节点.js20或更新.
-   支持的平台之一. npm 自动安装匹配的本地二进制 :
    -   苹果硅(arm64)或英特尔(x64)上的macOS
    -   Linux x64 有 glibc 2.28 或更新: Ubuntu 20.04+, Debian 10+, RHEL/Rocky/Alma 8+, Fedora 29+, Amazon Linux 2023. CentOS 7和Amazon Linux 2等较老的Distro不支持.
    -   视窗 x64
-   Playwright's Chromium, 用于情景截图: `npx playwright install chromium`。 。 。 .

## 快开始

在您的工程目录中 :

```bash
codeyam-editor init     # write .codeyam/editor.json
codeyam-editor start    # start the editor and open it in your browser
```

`start` 打印编辑器的本地 URL并打开它。 过 `--no-open` 跳过浏览器,或 `--port <PORT>` 选择港口. `init --provider <claude|codex|gemini|opencode>` 选择构建代理(默认情况下).

## 图标

| 命令 | 它会做什么 |
| --- | --- |
| `codeyam-editor start` | 启动编辑器( 控制 API 和您的应用进程) . |
| `codeyam-editor init` | 初始化一个新的 `.codeyam/editor.json` 相会. |
| `codeyam-editor mcp` | 为 Claude Desktop 和其他 MCP 客户端运行一个 MCP(模式上下文协议)服务器. |
| `codeyam-editor editor` | 工作流程子命令构建代理使用:情景、词汇表、审计等等. |

运行 `codeyam-editor <command> --help` 用于命令的选项,以及 `codeyam-editor editor --help` 用于完整的工作流程子命令列表.

## 与克劳德一起使用

编辑与 Claude Code 合作出盒子: `codeyam-editor init` 为它设立项目。 对于 Claude 桌面或任何其他 MCP 客户端, 注册 `codeyam-editor mcp` 作为 stdio MCP 服务器. 见 [codyam.com (英语)](https://codeyam.com/) 其他方法安装在克洛德.

## 链接

-   主页 : [https://codeyam.com/ (中文(简体) )](https://codeyam.com/)

## 许可证

麻省理工学院. 见 `LICENSE`。 。 。 .

## 常见问题

### @codeyam-editor/codeyam-editor 是什么？

用于情景驱动开发的语言不可知性执行沙盒

### 如何安装 @codeyam-editor/codeyam-editor？

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

### @codeyam-editor/codeyam-editor 支持 TypeScript 吗？

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

### @codeyam-editor/codeyam-editor 需要什么版本的 Node\.js？

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

### @codeyam-editor/codeyam-editor 可以商用吗？

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

### @codeyam-editor/codeyam-editor 的下载量有多少？

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

### @codeyam-editor/codeyam-editor 还在维护吗？

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