让开源，少一点语言距离。
npm包中文文档

@codeyam-editor/codeyam-editor

中文文档
0.1.20发布于 2026/11/09MIT近 30 天下载 2946

Language-agnostic managed execution sandbox for scenario-driven development

原始使用文档
中文原文
文档目录7 节
  1. Install
  2. Requirements
  3. Quick start
  4. Commands
  5. Use with Claude
  6. Links
  7. License

CodeYam Editor

A step-driven AI build editor with an isolated Live Preview, scenario capture, verification commands, and a Rust control API.

CodeYam Editor runs beside your project and drives an AI build agent through a planned, step-by-step workflow. Every feature is built together with the scenarios (the data states) that demonstrate it, shown in a live preview as you go and captured so they can be re-verified later. It works with any stack: web apps, backend services, CLIs, libraries.

Install

Recommended: the one-line installer. It installs through npm and puts codeyam-editor on your PATH:

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

It checks the prerequisites (Node 20 or newer, and on Linux a recent enough glibc), runs the global npm install, and adds npm's global bin directory to your shell profile, so a new shell finds codeyam-editor. It prints exactly what it changed.

Plain npm (you manage PATH yourself):

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

If you use a custom npm prefix (for example npm config set prefix ~/.npm-global to avoid sudo), add its bin directory to PATH yourself. Otherwise the install succeeds but the shell reports codeyam-editor: command not found. The one-line installer does this for you.

No install: a one-off run through npx:

npx @codeyam-editor/codeyam-editor

Requirements

  • Node.js 20 or newer.
  • One of the supported platforms. npm installs the matching native binary automatically:
    • macOS on Apple silicon (arm64) or Intel (x64)
    • Linux x64 with glibc 2.28 or newer: Ubuntu 20.04+, Debian 10+, RHEL/Rocky/Alma 8+, Fedora 29+, Amazon Linux 2023. Older distros such as CentOS 7 and Amazon Linux 2 are not supported.
    • Windows x64
  • Playwright's Chromium, for scenario screenshots: npx playwright install chromium.

Quick start

In your project directory:

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

start prints the editor's local URL and opens it. Pass --no-open to skip the browser, or --port <PORT> to pick the port. init --provider <claude|codex|gemini|opencode> chooses the build agent (Claude by default).

Commands

CommandWhat it does
codeyam-editor startStart the editor (control API and your app's process).
codeyam-editor initInitialize a new .codeyam/editor.json config.
codeyam-editor mcpRun an MCP (Model Context Protocol) server over stdio, for Claude Desktop and other MCP clients.
codeyam-editor editorThe workflow subcommands the build agent uses: scenarios, glossary, audit, and more.

Run codeyam-editor <command> --help for a command's options, and codeyam-editor editor --help for the full list of workflow subcommands.

Use with Claude

The editor works with Claude Code out of the box: codeyam-editor init sets up the project for it. For Claude Desktop or any other MCP client, register codeyam-editor mcp as a stdio MCP server. See codeyam.com for the other ways to install it in Claude.

License

MIT. See LICENSE.

版本与发布记录

@codeyam-editor/codeyam-editor 共发布 77 个版本，首次发布于 2026/04/06；过去 12 个月发布了 77 个版本。

版本发布日期距今
0.1.20latest2026/11/091 天前
0.1.20-staging.g96a25c6staging2026/11/081 天前
0.1.192026/11/072 天前
0.1.19-staging.g0f37ba32026/11/072 天前
0.1.182026/11/055 天前
0.1.18-staging.gb79a11e2026/11/045 天前

关于 @codeyam-editor/codeyam-editor 的常见问题

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

Language-agnostic managed execution sandbox for scenario-driven development

如何安装 @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 和提交记录判断。