Skip to content

chen-yu-hao/codex-web

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

codex-web

一个本地运行的 Web UI,用来:

  • 浏览/搜索 Skills
  • 一键安装/卸载 Skills 到本机的 Codex 目录(默认 ~/.codex/skills
  • 查看 Codex sessions(默认从 ~/.codex/sessions 读取)
  • 通过 WebSocket 启动/继续 codex CLI 对话(Workspace Chat)

注意:这是一个会在服务器端直接执行 codex 命令的本地工具,不建议暴露到公网。

目录结构

  • server/:Express + WebSocket API(启动 codex、提供 skills/agents catalog、sessions 等接口)
  • client/:React + Vite 前端(开发端口 5173,代理后端 8787
  • components/:本地 templates(skills/agents/hooks 等),后端优先从这里读取

运行要求

  • Node.js(建议 18+)
  • 本机已安装并可在 PATH 中运行 codex(用于 Workspace Chat / Codex Grid 等功能)

快速开始(开发)

# 安装依赖(根目录 + client)
npm install
npm install --prefix client

# 同时启动后端(8787) + 前端(5173)
npm run dev

打开:http://localhost:5173

生产构建与运行

npm run build
npm run start

打开:http://localhost:8787

配置(环境变量)

后端默认端口与目录可通过环境变量覆盖(见 server/index.js):

  • PORT:后端端口(默认 8787
  • CCT_SOURCE_DIR / CCT_CACHE_DIR:外部 templates 目录(当本项目不存在 components/ 或希望切换来源时使用)
  • CCT_REPO_URL:templates 仓库地址(默认指向 davila7/claude-code-templates
  • CCT_ALLOW_CLONE=1:当本地 templates 不存在时允许后端 git clone(需要网络)
  • CODEX_SKILLS_DIR:skills 安装目录(默认 ~/.codex/skills
  • CODEX_SESSIONS_DIR:sessions 目录(默认 ~/.codex/sessions

常见问题

  • codex: not found:确认已安装 Codex CLI,并确保 codex 在 PATH 中可执行。
  • Skills/Agents 列表为空:确认 components/ 存在且包含 skills/**/SKILL.mdagents/**/*.md,或设置 CCT_SOURCE_DIR 指向你的 templates 目录。

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

⭐ Found this useful? Give us a star to support the project!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •