Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 26 additions & 10 deletions README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,10 @@ Codex Mate is a local-first CLI + Web UI for unified management of:
- Codex provider/model switching and config writes
- Claude Code profiles (writes to `~/.claude/settings.json`)
- OpenClaw JSON5 profiles and workspace `AGENTS.md`
- Local skills market for Codex / Claude Code (target switching, local skills management, cross-app import, ZIP distribution)
- Local Codex/Claude sessions (list/filter/export/delete)

It works on local files directly and does not require cloud hosting.
It works on local files directly and does not require cloud hosting. The skills market is also local-first: it operates on local directories and does not depend on a remote marketplace.

## Why Codex Mate?

Expand All @@ -34,6 +35,7 @@ It works on local files directly and does not require cloud hosting.
| Multi-tool management | Codex + Claude Code + OpenClaw in one entry | Different files and folders per tool |
| Operation mode | CLI + local Web UI | Manual TOML/JSON/JSON5 edits |
| Session handling | Browse/export/batch cleanup | Manual file location and processing |
| Skills reuse | Local skills market + cross-app import + ZIP distribution | Manual folder copy and reconciliation |
| Rollback readiness | Backup before first takeover | Easy to overwrite by mistake |
| Automation integration | MCP stdio (read-only by default) | Requires custom scripting |

Expand All @@ -52,6 +54,12 @@ It works on local files directly and does not require cloud hosting.
- Markdown export
- Session-level and message-level delete (supports batch)

**Skills Market**
- Switch the skills install target between Codex and Claude Code
- Inspect local installed skills, root paths, and status
- Scan importable sources from `Codex` / `Claude Code` / `Agents`
- Support cross-app import, ZIP import/export, and batch delete

**Engineering Utilities**
- MCP stdio domains (`tools`, `resources`, `prompts`)
- Built-in proxy controls (`proxy`)
Expand All @@ -74,15 +82,16 @@ flowchart TB
API["Local HTTP API"]
MCPS["MCP stdio Server"]
PROXY["Built-in Proxy"]
SERVICES["Config / Sessions / Skills / Workflow"]
SERVICES["Config / Sessions / Skills Market / Workflow"]
CORE["File IO / Network / Diff / Session Utils"]
end

subgraph Data["Local Files"]
CODEX["~/.codex"]
CLAUDE["~/.claude"]
OPENCLAW["~/.openclaw"]
STATE["sessions / trash / workflow runs"]
CODEX["~/.codex/config + auth + models"]
CLAUDE["~/.claude/settings.json"]
OPENCLAW["~/.openclaw/*.json5 + ~/.openclaw/openclaw.json + workspace/AGENTS.md"]
SKILLS["~/.codex/skills / ~/.claude/skills / ~/.agents/skills"]
STATE["sessions / trash / workflow runs / skill exports"]
end

CLI --> ENTRY
Expand All @@ -100,6 +109,7 @@ flowchart TB
CORE --> CODEX
CORE --> CLAUDE
CORE --> OPENCLAW
CORE --> SKILLS
CORE --> STATE
```

Expand All @@ -114,7 +124,9 @@ codexmate status
codexmate run
```

Default listen address is `127.0.0.1:3737`, and browser auto-open is enabled by default.
Default listen address is `0.0.0.0:3737` for LAN access, and browser auto-open is enabled by default.

> Safety note: the unauthenticated management UI is exposed to your current LAN by default. Use trusted networks only; for local-only access, set `CODEXMATE_HOST=127.0.0.1` or pass `--host 127.0.0.1`.

### Run from source

Expand Down Expand Up @@ -170,8 +182,6 @@ codexmate codex --model gpt-5.3-codex --follow-up "step1" --follow-up "step2"
- Provider/model switching
- Model list management
- `~/.codex/AGENTS.md` editing
- `~/.codex/skills` management (filter, batch delete, cross-app import)


### Claude Code Mode
- Multi-profile management
Expand All @@ -188,6 +198,12 @@ codexmate codex --model gpt-5.3-codex --follow-up "step1" --follow-up "step2"
- Local pin/unpin with persistent storage and pinned-first ordering
- Search, filter, export, delete, batch cleanup

### Skills Market Tab
- Switch the skills install target between `Codex` and `Claude Code`
- Show the current local skills root, installed items, and importable items
- Scan importable sources under `Codex` / `Claude Code` / `Agents`
- Support cross-app import, ZIP import/export, and batch delete

## MCP

> Transport: `stdio`
Expand Down Expand Up @@ -218,7 +234,7 @@ codexmate mcp serve --allow-write
| Variable | Default | Description |
| --- | --- | --- |
| `CODEXMATE_PORT` | `3737` | Web server port |
| `CODEXMATE_HOST` | `127.0.0.1` | Web listen host |
| `CODEXMATE_HOST` | `0.0.0.0` | Web listen host (set `127.0.0.1` for local-only access) |
| `CODEXMATE_NO_BROWSER` | unset | Set `1` to disable browser auto-open |
| `CODEXMATE_MCP_ALLOW_WRITE` | unset | Set `1` to allow MCP write tools by default |
| `CODEXMATE_FORCE_RESET_EXISTING_CONFIG` | `0` | Set `1` to force bootstrap reset of existing config |
Expand Down
36 changes: 26 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,10 @@ Codex Mate 提供一套本地优先的 CLI + Web UI,用于统一管理:
- Codex 的 provider / model 切换与配置写入
- Claude Code 配置方案(写入 `~/.claude/settings.json`)
- OpenClaw JSON5 配置与 Workspace `AGENTS.md`
- Codex / Claude Code Skills 市场(安装目标切换、本地 skills 管理、跨应用导入、ZIP 分发)
- Codex / Claude 本地会话浏览、筛选、导出、删除

项目不依赖云端托管,配置写入你的本地文件,便于审计和回滚。
项目不依赖云端托管,配置写入你的本地文件,便于审计和回滚。Skills 市场同样坚持本地优先,只操作本地目录,不依赖远程在线市场。

## 为什么选择 Codex Mate?

Expand All @@ -34,6 +35,7 @@ Codex Mate 提供一套本地优先的 CLI + Web UI,用于统一管理:
| 多工具管理 | Codex + Claude Code + OpenClaw 统一入口 | 多文件、多目录分散修改 |
| 使用方式 | CLI + 本地 Web UI | 纯手改 TOML / JSON / JSON5 |
| 会话处理 | 支持浏览、导出、批量清理 | 需要手动定位和处理文件 |
| Skills 复用 | 本地 Skills 市场 + 跨应用导入 + ZIP 分发 | 目录手动复制,容易遗漏 |
| 可回滚性 | 首次接管前自动备份 | 易误覆盖、回滚成本高 |
| 自动化接入 | 提供 MCP stdio(默认只读) | 需自行封装脚本 |

Expand All @@ -52,6 +54,12 @@ Codex Mate 提供一套本地优先的 CLI + Web UI,用于统一管理:
- 会话导出 Markdown
- 会话与消息级删除(支持批量)

**Skills 市场**
- 在 Codex 与 Claude Code 之间切换 skills 安装目标
- 查看本地已安装 skills、根目录与状态
- 扫描 `Codex` / `Claude Code` / `Agents` 可导入来源
- 支持跨应用导入、ZIP 导入 / 导出、批量删除

**工程能力**
- MCP stdio 能力(tools/resources/prompts)
- 内建代理配置与状态控制(`proxy`)
Expand All @@ -74,15 +82,16 @@ flowchart TB
API["Local HTTP API"]
MCPS["MCP stdio Server"]
PROXY["Built-in Proxy"]
SERVICES["Config / Sessions / Skills / Workflow"]
SERVICES["Config / Sessions / Skills Market / Workflow"]
CORE["File IO / Network / Diff / Session Utils"]
end

subgraph State["Local State"]
CODEX["~/.codex"]
CLAUDE["~/.claude"]
OPENCLAW["~/.openclaw"]
STATE["sessions / trash / workflow runs"]
CODEX["~/.codex/config + auth + models"]
CLAUDE["~/.claude/settings.json"]
OPENCLAW["~/.openclaw/*.json5 + ~/.openclaw/openclaw.json + workspace/AGENTS.md"]
SKILLS["~/.codex/skills / ~/.claude/skills / ~/.agents/skills"]
STATE["sessions / trash / workflow runs / skill exports"]
end

CLI --> ENTRY
Expand All @@ -100,6 +109,7 @@ flowchart TB
CORE --> CODEX
CORE --> CLAUDE
CORE --> OPENCLAW
CORE --> SKILLS
CORE --> STATE
```

Expand All @@ -114,7 +124,9 @@ codexmate status
codexmate run
```

默认监听 `127.0.0.1:3737`,并尝试自动打开浏览器。
默认监听 `0.0.0.0:3737`,支持局域网访问,并尝试自动打开浏览器。

> 安全提示:默认监听会在当前局域网暴露未鉴权的管理界面。若包含 API Key、provider 配置或 skills 管理,请仅在可信网络中使用;如需仅本机访问,可设置 `CODEXMATE_HOST=127.0.0.1` 或启动时传入 `--host 127.0.0.1`。

### 从源码运行

Expand Down Expand Up @@ -170,8 +182,6 @@ codexmate codex --model gpt-5.3-codex --follow-up "步骤1" --follow-up "步骤2
- provider / model 切换
- 模型管理
- `~/.codex/AGENTS.md` 编辑
- `~/.codex/skills` 管理(筛选、批量删除、跨应用导入)


### Claude Code 配置模式
- 多配置方案管理
Expand All @@ -188,6 +198,12 @@ codexmate codex --model gpt-5.3-codex --follow-up "步骤1" --follow-up "步骤2
- 支持本地会话置顶、持久化保存与置顶优先排序
- 搜索、筛选、导出、删除、批量清理

### Skills 市场标签页
- 在 `Codex` 与 `Claude Code` 之间切换 skills 安装目标
- 展示当前目标的本地 skills 根目录、已安装项和可导入项
- 扫描 `Codex` / `Claude Code` / `Agents` 目录中的可导入来源
- 支持跨应用导入、ZIP 导入 / 导出、批量删除

## MCP

> 传输:`stdio`
Expand Down Expand Up @@ -219,7 +235,7 @@ codexmate mcp serve --allow-write
| 变量 | 默认值 | 说明 |
| --- | --- | --- |
| `CODEXMATE_PORT` | `3737` | Web 服务端口 |
| `CODEXMATE_HOST` | `127.0.0.1` | Web 服务监听地址 |
| `CODEXMATE_HOST` | `0.0.0.0` | Web 服务监听地址(如需仅本机访问,显式设为 `127.0.0.1`) |
| `CODEXMATE_NO_BROWSER` | 未设置 | 设为 `1` 后不自动打开浏览器 |
| `CODEXMATE_MCP_ALLOW_WRITE` | 未设置 | 设为 `1` 后默认允许 MCP 写工具 |
| `CODEXMATE_FORCE_RESET_EXISTING_CONFIG` | `0` | 设为 `1` 时首次可强制重建托管配置 |
Expand Down
Loading
Loading