logo
0
0
WeChat Login
docs: 补充 npm CLI 发布流程

code-agent-webui

Web UI for Codex app-server: Chat + Files (Changes/Diff), realtime streaming.

Requirements

  • Node.js 18+ (20+ recommended)
  • pnpm
  • codex installed and runnable: codex app-server

Setup

pnpm install

Env

Copy .env.example to .env (repo root) and edit:

cp .env.example .env

Example:

WEBUI_TOKEN=dev-token WEBUI_PUBLIC_URL=http://localhost:5173 FEISHU_WEBHOOK_URL= CODEX_BIN=codex SERVE_WEB_DIST=

Workspace root: the directory you run the command in.

Dev

pnpm dev

Open:

  • Web: http://localhost:5173

Server:

  • API: http://localhost:4390

Notes

  • Auth:
    • HTTP: Authorization: Bearer $WEBUI_TOKEN
    • Socket.IO: auth.token = $WEBUI_TOKEN
    • Web UI prompts for token and stores it in localStorage.
  • Notifications:
    • If FEISHU_WEBHOOK_URL set, server sends Feishu text messages for approvals/failures.
    • WEBUI_PUBLIC_URL used to generate deep links like /t/<threadId>.
  • Serve web from server (optional):
    • pnpm build
    • set SERVE_WEB_DIST=1
    • pnpm start then open http://localhost:4390
  • Mock codex (for local testing):
    • chmod +x bin/codex
    • set CODEX_BIN=../../bin/codex (when server runs from apps/server)

NPM CLI 包

本仓库包含一个可发布的 CLI 包:packages/cli(包名:code-agent-webui,命令:code-agent-webui)。

本地构建(用于发布)

pnpm build:cli

发布到 npm

发布前说明:

  • 如果 npm 上已存在同名包 code-agent-webui,需要先修改 packages/cli/package.jsonname(建议使用 scope:@<org>/code-agent-webui)。
  • 每次发布前请更新 packages/cli/package.jsonversion(遵循 semver)。

发布步骤:

# 1) 构建(会生成 packages/cli/dist/{cli.js,server/**,web/**}) pnpm build:cli # 2) 预览将要发布的内容(强烈建议) cd packages/cli npm pack --dry-run # 3) 登录 npm(只需一次) npm login # 4) 发布 npm publish --access public

发布 “next” 标签(可选):

cd packages/cli npm publish --tag next --access public

安装与运行:

npm i -g code-agent-webui code-agent-webui --help

packages/cli 目录执行(最简版本):

npm publish