1
0
mirror of https://github.com/GuDaStudio/codexmcp.git synced 2026-02-05 02:00:24 +08:00

v0.6.4:更新README

This commit is contained in:
GuDaStudio
2025-11-14 11:14:46 +08:00
parent 3ebc8ae1d1
commit bdde615511
2 changed files with 40 additions and 1 deletions

View File

@@ -133,6 +133,10 @@ claude mcp list
- SESSION_ID (UUID | null): 用于继续之前的会话以与codex进行多轮交互默认为 None开启新会话 - SESSION_ID (UUID | null): 用于继续之前的会话以与codex进行多轮交互默认为 None开启新会话
- skip_git_repo_check (boolean): 是否允许在非 Git 仓库中运行,默认 False - skip_git_repo_check (boolean): 是否允许在非 Git 仓库中运行,默认 False
- return_all_messages (boolean): 是否返回所有消息(包括推理、工具调用等),默认 False - return_all_messages (boolean): 是否返回所有消息(包括推理、工具调用等),默认 False
- image (List[Path] | null): 附加一个或多个图片文件到初始提示词,默认为 None
- model (string | null): 指定使用的模型,默认为 None使用用户默认配置
- yolo (boolean | null): 无需审批运行所有命令(跳过沙箱),默认 False
- profile (string | null): 从 `~/.codex/config.toml` 加载的配置文件名称,默认为 None使用用户默认配置
返回值: 返回值:
{ {
@@ -195,6 +199,10 @@ claude mcp list
| `SESSION_ID` | `UUID \| None` | ❌ | `None` | 会话 IDNone 则开启新会话) | | `SESSION_ID` | `UUID \| None` | ❌ | `None` | 会话 IDNone 则开启新会话) |
| `skip_git_repo_check` | `bool` | ❌ | `False` | 是否允许在非 Git 仓库运行 | | `skip_git_repo_check` | `bool` | ❌ | `False` | 是否允许在非 Git 仓库运行 |
| `return_all_messages` | `bool` | ❌ | `False` | 是否返回完整推理信息 | | `return_all_messages` | `bool` | ❌ | `False` | 是否返回完整推理信息 |
| `image` | `List[Path] \| None` | ❌ | `None` | 附加图片文件到初始提示词 |
| `model` | `str \| None` | ❌ | `None` | 指定使用的模型(默认使用用户配置) |
| `yolo` | `bool \| None` | ❌ | `False` | 无需审批运行所有命令(跳过沙箱) |
| `profile` | `str \| None` | ❌ | `None` | 从 `~/.codex/config.toml` 加载的配置文件名称 |
</details> </details>

View File

@@ -46,6 +46,25 @@ Please ensure you have successfully **installed** and **configured** both Claude
- [Claude Code Installation Guide](https://docs.claude.com/docs/claude-code) - [Claude Code Installation Guide](https://docs.claude.com/docs/claude-code)
- [Codex CLI Installation Guide](https://developers.openai.com/codex/quickstart) - [Codex CLI Installation Guide](https://developers.openai.com/codex/quickstart)
Please ensure you have successfully installed the [uv tool](https://docs.astral.sh/uv/getting-started/installation/):
- Windows
Run the following command in PowerShell:
```
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```
- Linux/macOS
Download and install using curl/wget:
```
curl -LsSf https://astral.sh/uv/install.sh | sh # Using curl
wget -qO- https://astral.sh/uv/install.sh | sh # Using wget
```
**Note: We strongly recommend Windows users run this project in WSL!**
<!-- If you're facing challenges with subscription or configuration, we'd be happy to [assist you](https://cc.guda.studio). --> <!-- If you're facing challenges with subscription or configuration, we'd be happy to [assist you](https://cc.guda.studio). -->
### 1. Installation Steps ### 1. Installation Steps
@@ -72,6 +91,9 @@ claude mcp list
> If you see the following output, installation was successful! > If you see the following output, installation was successful!
> `codex: uvx --from git+https://github.com/GuDaStudio/codexmcp.git codexmcp - ✓ Connected` > `codex: uvx --from git+https://github.com/GuDaStudio/codexmcp.git codexmcp - ✓ Connected`
**1.4** Optionally allow Claude Code to automatically interact with Codex by adding `mcp__codex__codex` to the allow list in `~/.claude/settings.json`
![](../images/image.png)
### 2. Configure Claude Code Prompts (Optional) ### 2. Configure Claude Code Prompts (Optional)
To optimize Claude Code's collaboration with Codex, we **highly recommend adding the following to `~/.claude/CLAUDE.md`** To optimize Claude Code's collaboration with Codex, we **highly recommend adding the following to `~/.claude/CLAUDE.md`**
@@ -111,6 +133,10 @@ You **must execute** the following steps:
- SESSION_ID (UUID | null): For continuing previous sessions to enable multi-turn interactions with Codex, defaults to None (start new session) - SESSION_ID (UUID | null): For continuing previous sessions to enable multi-turn interactions with Codex, defaults to None (start new session)
- skip_git_repo_check (boolean): Whether to allow running in non-Git repositories, defaults to False - skip_git_repo_check (boolean): Whether to allow running in non-Git repositories, defaults to False
- return_all_messages (boolean): Whether to return all messages (including reasoning, tool calls, etc.), defaults to False - return_all_messages (boolean): Whether to return all messages (including reasoning, tool calls, etc.), defaults to False
- image (List[Path] | null): Attach one or more image files to the initial prompt, defaults to None
- model (string | null): Specify the model to use, defaults to None (uses user's default configuration)
- yolo (boolean | null): Run all commands without approval (skip sandboxing), defaults to False
- profile (string | null): Configuration profile name to load from `~/.codex/config.toml`, defaults to None (uses user's default configuration)
Return value: Return value:
{ {
@@ -173,6 +199,10 @@ You **must execute** the following steps:
| `SESSION_ID` | `UUID \| None` | ❌ | `None` | Session ID (None starts new session) | | `SESSION_ID` | `UUID \| None` | ❌ | `None` | Session ID (None starts new session) |
| `skip_git_repo_check` | `bool` | ❌ | `False` | Whether to allow running in non-Git repositories | | `skip_git_repo_check` | `bool` | ❌ | `False` | Whether to allow running in non-Git repositories |
| `return_all_messages` | `bool` | ❌ | `False` | Whether to return complete reasoning information | | `return_all_messages` | `bool` | ❌ | `False` | Whether to return complete reasoning information |
| `image` | `List[Path] \| None` | ❌ | `None` | Attach image files to initial prompt |
| `model` | `str \| None` | ❌ | `None` | Specify model to use (defaults to user configuration) |
| `yolo` | `bool \| None` | ❌ | `False` | Run all commands without approval (skip sandboxing) |
| `profile` | `str \| None` | ❌ | `None` | Configuration profile name from `~/.codex/config.toml` |
</details> </details>
@@ -255,7 +285,8 @@ Copyright (c) 2025 [guda.studio](mailto:gudaclaude@gmail.com)
--- ---
<div align="center"> <div align="center">
Support us with a 🌟~
## Support us with a 🌟~
[![Star History Chart](https://api.star-history.com/svg?repos=GuDaStudio/codexmcp&type=date&legend=top-left)](https://www.star-history.com/#GuDaStudio/codexmcp&type=date&legend=top-left) [![Star History Chart](https://api.star-history.com/svg?repos=GuDaStudio/codexmcp&type=date&legend=top-left)](https://www.star-history.com/#GuDaStudio/codexmcp&type=date&legend=top-left)
</div> </div>