@jacks001314/codex-go-darwin-arm64 1.0.5 → 1.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2025 OpenAI
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,229 +1,238 @@
|
|
|
1
|
-
# Codex Go
|
|
2
|
-
|
|
3
|
-
The latest audited alignment target is Rust `main` at `
|
|
4
|
-
[parity.json](./parity.json) records the current SDK and implementation evidence. Candidate baseline, commit, domain, and contract state live under [parity/](./parity/); only `parity/baseline.json` with `certificationReady: true` denotes a fully certified release.
|
|
5
|
-
|
|
6
|
-
`codex_go` 是 Codex CLI 的 Go 实现,目标是逐步对齐 Rust 版 Codex CLI 的命令行行为、配置语义、认证、模型请求、TUI、app-server、MCP、插件、沙箱和会话能力。
|
|
7
|
-
|
|
8
|
-
当前仓库是迁移中的工程版本。开发时以 Rust 版本为行为基线,进度和待办以 [plan.md](./plan.md) 为准。
|
|
9
|
-
|
|
10
|
-
## 环境要求
|
|
11
|
-
|
|
12
|
-
- Go 1.26.2+
|
|
13
|
-
- 推荐使用 Go toolchain 1.26.2
|
|
14
|
-
- Windows、Linux 或 macOS
|
|
15
|
-
|
|
16
|
-
模块信息见 [go.mod](./go.mod)。
|
|
17
|
-
|
|
18
|
-
## 快速开始
|
|
19
|
-
|
|
20
|
-
构建 CLI:
|
|
21
|
-
|
|
22
|
-
```powershell
|
|
23
|
-
go build -o .\bin\codex.exe .\cmd\codex
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
直接运行:
|
|
27
|
-
|
|
28
|
-
```powershell
|
|
29
|
-
go run .\cmd\codex -- "解释当前目录的代码结构"
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
非交互执行:
|
|
33
|
-
|
|
34
|
-
```powershell
|
|
35
|
-
go run .\cmd\codex exec "用一句话总结这个项目"
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
登录状态:
|
|
39
|
-
|
|
40
|
-
```powershell
|
|
41
|
-
go run .\cmd\codex login status
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
使用 API key 登录时从 stdin 读取密钥:
|
|
45
|
-
|
|
46
|
-
```powershell
|
|
47
|
-
$env:OPENAI_API_KEY | go run .\cmd\codex login --with-api-key
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
## 常用命令
|
|
51
|
-
|
|
52
|
-
```text
|
|
53
|
-
codex [OPTIONS] [PROMPT] 启动交互式 TUI,或用 PROMPT 开始会话
|
|
54
|
-
codex exec [OPTIONS] [PROMPT] 非交互执行
|
|
55
|
-
codex review [OPTIONS] 代码审查
|
|
56
|
-
codex login 登录 ChatGPT
|
|
57
|
-
codex login --with-api-key 从 stdin 保存 API key
|
|
58
|
-
codex login status 查看登录状态
|
|
59
|
-
codex logout 退出登录
|
|
60
|
-
codex features list 查看功能开关
|
|
61
|
-
codex mcp ... 管理 MCP server 配置和登录
|
|
62
|
-
codex plugin ... 管理插件和 marketplace
|
|
63
|
-
codex app-server ... 启动或管理 app-server
|
|
64
|
-
codex sandbox -- COMMAND 在权限配置下运行命令
|
|
65
|
-
codex doctor 环境诊断
|
|
66
|
-
codex completion [SHELL] 生成 shell completion
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
根级常用选项:
|
|
70
|
-
|
|
71
|
-
```text
|
|
72
|
-
-c, --config KEY=VALUE 覆盖配置
|
|
73
|
-
--enable FEATURE 启用功能开关
|
|
74
|
-
--disable FEATURE 禁用功能开关
|
|
75
|
-
-m, --model MODEL 指定模型
|
|
76
|
-
-p, --profile PROFILE 使用配置 profile
|
|
77
|
-
-C, --cd DIR 指定工作目录
|
|
78
|
-
--add-dir DIR 增加可访问目录
|
|
79
|
-
--sandbox PROFILE 指定沙箱策略
|
|
80
|
-
--ask-for-approval POLICY 指定审批策略
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
## 测试与检查
|
|
84
|
-
|
|
85
|
-
包加载检查:
|
|
86
|
-
|
|
87
|
-
```powershell
|
|
88
|
-
go list -buildvcs=false ./...
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
运行全部测试:
|
|
92
|
-
|
|
93
|
-
```powershell
|
|
94
|
-
go test ./...
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
如果本机 Go 缓存目录受限,可以临时指定缓存:
|
|
98
|
-
|
|
99
|
-
```powershell
|
|
100
|
-
$env:GOCACHE = Join-Path $env:TEMP 'codex_go_gocache'
|
|
101
|
-
go test ./...
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
格式化:
|
|
105
|
-
|
|
106
|
-
```powershell
|
|
107
|
-
go fmt ./...
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
## 编译、安装与发布
|
|
111
|
-
|
|
112
|
-
### npm 安装
|
|
113
|
-
|
|
114
|
-
发布后的全局安装命令:
|
|
115
|
-
|
|
116
|
-
```powershell
|
|
117
|
-
npm install -g @jacks001314/codex-go
|
|
118
|
-
gcode --version
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
npm 对外暴露的命令名为 `gcode`,避免与官方 `codex` 命令冲突;底层原生二进制仍名为 `codex`。主包会根据当前操作系统和 CPU 架构自动安装对应的原生二进制包。发布新版本时先构建七个 tarball,再按“六个平台包、主包”的顺序发布:
|
|
122
|
-
|
|
123
|
-
```powershell
|
|
124
|
-
node .\npm\scripts\build-packages.mjs --version 0.1.0
|
|
125
|
-
node .\npm\scripts\publish-packages.mjs --directory .\dist\v0.1.0\npm
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
如果 npm 账号要求发布时进行双因素认证,请传入认证器当前生成的 OTP:
|
|
129
|
-
|
|
130
|
-
```powershell
|
|
131
|
-
node .\npm\scripts\publish-packages.mjs --directory .\dist\v0.1.0\npm --otp 123456
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
发布需要登录 npm 账号 `jacks001314`;预发布可追加 `--tag next`。CI 发布应使用启用了 `Bypass 2FA` 的 granular access token,避免交互式 OTP 过期。
|
|
135
|
-
|
|
136
|
-
编译当前平台的开发版本:
|
|
137
|
-
|
|
138
|
-
```powershell
|
|
139
|
-
.\scripts\build.ps1
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
Windows builds also write `codex-command-runner.exe` and
|
|
143
|
-
`codex-windows-sandbox-setup.exe` under `bin\codex-resources`. NPM platform
|
|
144
|
-
packages use the official `vendor/<target-triple>/bin` layout with a sibling
|
|
145
|
-
`codex-resources` directory.
|
|
146
|
-
|
|
147
|
-
编译指定版本和目标平台:
|
|
148
|
-
|
|
149
|
-
```powershell
|
|
150
|
-
.\scripts\build.ps1 -Version 0.1.0 -GOOS linux -GOARCH amd64 -CGO off
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
从当前源码安装。Windows 默认安装到 `%LOCALAPPDATA%\Programs\CodexGo\bin`,
|
|
154
|
-
其他系统默认安装到 `~/.local/bin`:
|
|
155
|
-
|
|
156
|
-
```powershell
|
|
157
|
-
.\scripts\install.ps1 -Version 0.1.0
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
也可以指定安装目录:
|
|
161
|
-
|
|
162
|
-
```powershell
|
|
163
|
-
.\scripts\install.ps1 -InstallDir C:\Tools\CodexGo -Force
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
生成 Windows、Linux 和 macOS 的 amd64/arm64 发布包及 SHA-256 校验清单:
|
|
167
|
-
|
|
168
|
-
```powershell
|
|
169
|
-
.\scripts\release.ps1 -Version 0.1.0
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
发布产物默认写入 `dist/v<版本号>`。可用 `-Targets windows/amd64,linux/amd64`
|
|
173
|
-
限制目标平台,或用 `-SkipTests` 跳过发布前的全包编译检查。
|
|
174
|
-
|
|
175
|
-
Linux、macOS、WSL 或其他 POSIX Shell 环境可以使用对应的 Shell 脚本:
|
|
176
|
-
|
|
177
|
-
```sh
|
|
178
|
-
./scripts/build.sh --version 0.1.0
|
|
179
|
-
./scripts/install.sh --version 0.1.0
|
|
180
|
-
./scripts/release.sh --version 0.1.0
|
|
181
|
-
```
|
|
182
|
-
|
|
183
|
-
指定发布目标:
|
|
184
|
-
|
|
185
|
-
```sh
|
|
186
|
-
./scripts/release.sh --version 0.1.0 \
|
|
187
|
-
--targets 'linux/amd64 linux/arm64 darwin/arm64'
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
## 目录结构
|
|
191
|
-
|
|
192
|
-
```text
|
|
193
|
-
cmd/codex 可执行入口
|
|
194
|
-
app 顶层命令分发和运行时拼装
|
|
195
|
-
cli 命令行解析、参数校验、dispatch alias
|
|
196
|
-
config 配置加载、profile、feature override、权限配置
|
|
197
|
-
auth 登录凭据、auth.json、OAuth/API key/access token
|
|
198
|
-
model 模型 provider、Responses 请求/流式事件、模型 catalog
|
|
199
|
-
codexapi OpenAI/Codex API 客户端辅助
|
|
200
|
-
turn agent loop、tool dispatch、turn runtime
|
|
201
|
-
tool shell/apply_patch/MCP/tool_search/agent 工具运行时
|
|
202
|
-
exec codex exec/review 的非交互运行
|
|
203
|
-
appserver JSON-RPC app-server、thread/turn/runtime 服务
|
|
204
|
-
mcp MCP client/server、OAuth、resource、tool runtime
|
|
205
|
-
tui 终端 UI 状态、渲染、组件和 Bubble Tea adapter
|
|
206
|
-
session 会话存储、resume/fork/archive/delete
|
|
207
|
-
rollout rollout JSONL 记录和恢复
|
|
208
|
-
sandbox 权限 profile、Linux/Windows 沙箱、执行计划
|
|
209
|
-
review review 目标解析和 git diff 采集
|
|
210
|
-
doctor 环境诊断
|
|
211
|
-
plugin 插件 manifest、marketplace、安装流程
|
|
212
|
-
agent 多 agent graph、身份、registry、工具
|
|
213
|
-
utils 路径、JSON、ANSI、LRU、截断等共享工具
|
|
214
|
-
docs 设计和技术选型文档
|
|
215
|
-
```
|
|
216
|
-
|
|
217
|
-
## 开发约定
|
|
218
|
-
|
|
219
|
-
- 以 Rust 版 Codex 的行为和协议形状为基线。
|
|
220
|
-
- 新功能优先放入已有功能包,避免无必要地新增目录。
|
|
221
|
-
- 结构体参数和结构体返回值默认优先使用指针,简单标量按 Go 惯例传值。
|
|
222
|
-
- 代码变更后至少运行相关包测试;模块收口时运行 `go list -buildvcs=false ./...` 和 `go test ./...`。
|
|
223
|
-
- 迁移进度、验收项和工作日志维护在 [plan.md](./plan.md)。
|
|
224
|
-
|
|
225
|
-
## 参考文档
|
|
226
|
-
|
|
227
|
-
- [plan.md](./plan.md):迁移进度和待办
|
|
228
|
-
- [desgn.md](./desgn.md):迁移设计草案
|
|
229
|
-
- [docs/tui_tech_selection.md](./docs/tui_tech_selection.md):TUI 技术选型
|
|
1
|
+
# Codex Go
|
|
2
|
+
|
|
3
|
+
The latest audited alignment target is Rust `main` at `8c076942cb70fba8e5c4732c23f1faabc4aed484`; see [the 2026-10-18 alignment record](./update/plan_2026_10_18_round142.md).
|
|
4
|
+
[parity.json](./parity.json) records the current SDK and implementation evidence. Candidate baseline, commit, domain, and contract state live under [parity/](./parity/); only `parity/baseline.json` with `certificationReady: true` denotes a fully certified release.
|
|
5
|
+
|
|
6
|
+
`codex_go` 是 Codex CLI 的 Go 实现,目标是逐步对齐 Rust 版 Codex CLI 的命令行行为、配置语义、认证、模型请求、TUI、app-server、MCP、插件、沙箱和会话能力。
|
|
7
|
+
|
|
8
|
+
当前仓库是迁移中的工程版本。开发时以 Rust 版本为行为基线,进度和待办以 [plan.md](./plan.md) 为准。
|
|
9
|
+
|
|
10
|
+
## 环境要求
|
|
11
|
+
|
|
12
|
+
- Go 1.26.2+
|
|
13
|
+
- 推荐使用 Go toolchain 1.26.2
|
|
14
|
+
- Windows、Linux 或 macOS
|
|
15
|
+
|
|
16
|
+
模块信息见 [go.mod](./go.mod)。
|
|
17
|
+
|
|
18
|
+
## 快速开始
|
|
19
|
+
|
|
20
|
+
构建 CLI:
|
|
21
|
+
|
|
22
|
+
```powershell
|
|
23
|
+
go build -o .\bin\codex.exe .\cmd\codex
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
直接运行:
|
|
27
|
+
|
|
28
|
+
```powershell
|
|
29
|
+
go run .\cmd\codex -- "解释当前目录的代码结构"
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
非交互执行:
|
|
33
|
+
|
|
34
|
+
```powershell
|
|
35
|
+
go run .\cmd\codex exec "用一句话总结这个项目"
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
登录状态:
|
|
39
|
+
|
|
40
|
+
```powershell
|
|
41
|
+
go run .\cmd\codex login status
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
使用 API key 登录时从 stdin 读取密钥:
|
|
45
|
+
|
|
46
|
+
```powershell
|
|
47
|
+
$env:OPENAI_API_KEY | go run .\cmd\codex login --with-api-key
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## 常用命令
|
|
51
|
+
|
|
52
|
+
```text
|
|
53
|
+
codex [OPTIONS] [PROMPT] 启动交互式 TUI,或用 PROMPT 开始会话
|
|
54
|
+
codex exec [OPTIONS] [PROMPT] 非交互执行
|
|
55
|
+
codex review [OPTIONS] 代码审查
|
|
56
|
+
codex login 登录 ChatGPT
|
|
57
|
+
codex login --with-api-key 从 stdin 保存 API key
|
|
58
|
+
codex login status 查看登录状态
|
|
59
|
+
codex logout 退出登录
|
|
60
|
+
codex features list 查看功能开关
|
|
61
|
+
codex mcp ... 管理 MCP server 配置和登录
|
|
62
|
+
codex plugin ... 管理插件和 marketplace
|
|
63
|
+
codex app-server ... 启动或管理 app-server
|
|
64
|
+
codex sandbox -- COMMAND 在权限配置下运行命令
|
|
65
|
+
codex doctor 环境诊断
|
|
66
|
+
codex completion [SHELL] 生成 shell completion
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
根级常用选项:
|
|
70
|
+
|
|
71
|
+
```text
|
|
72
|
+
-c, --config KEY=VALUE 覆盖配置
|
|
73
|
+
--enable FEATURE 启用功能开关
|
|
74
|
+
--disable FEATURE 禁用功能开关
|
|
75
|
+
-m, --model MODEL 指定模型
|
|
76
|
+
-p, --profile PROFILE 使用配置 profile
|
|
77
|
+
-C, --cd DIR 指定工作目录
|
|
78
|
+
--add-dir DIR 增加可访问目录
|
|
79
|
+
--sandbox PROFILE 指定沙箱策略
|
|
80
|
+
--ask-for-approval POLICY 指定审批策略
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## 测试与检查
|
|
84
|
+
|
|
85
|
+
包加载检查:
|
|
86
|
+
|
|
87
|
+
```powershell
|
|
88
|
+
go list -buildvcs=false ./...
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
运行全部测试:
|
|
92
|
+
|
|
93
|
+
```powershell
|
|
94
|
+
go test ./...
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
如果本机 Go 缓存目录受限,可以临时指定缓存:
|
|
98
|
+
|
|
99
|
+
```powershell
|
|
100
|
+
$env:GOCACHE = Join-Path $env:TEMP 'codex_go_gocache'
|
|
101
|
+
go test ./...
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
格式化:
|
|
105
|
+
|
|
106
|
+
```powershell
|
|
107
|
+
go fmt ./...
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## 编译、安装与发布
|
|
111
|
+
|
|
112
|
+
### npm 安装
|
|
113
|
+
|
|
114
|
+
发布后的全局安装命令:
|
|
115
|
+
|
|
116
|
+
```powershell
|
|
117
|
+
npm install -g @jacks001314/codex-go
|
|
118
|
+
gcode --version
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
npm 对外暴露的命令名为 `gcode`,避免与官方 `codex` 命令冲突;底层原生二进制仍名为 `codex`。主包会根据当前操作系统和 CPU 架构自动安装对应的原生二进制包。发布新版本时先构建七个 tarball,再按“六个平台包、主包”的顺序发布:
|
|
122
|
+
|
|
123
|
+
```powershell
|
|
124
|
+
node .\npm\scripts\build-packages.mjs --version 0.1.0
|
|
125
|
+
node .\npm\scripts\publish-packages.mjs --directory .\dist\v0.1.0\npm
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
如果 npm 账号要求发布时进行双因素认证,请传入认证器当前生成的 OTP:
|
|
129
|
+
|
|
130
|
+
```powershell
|
|
131
|
+
node .\npm\scripts\publish-packages.mjs --directory .\dist\v0.1.0\npm --otp 123456
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
发布需要登录 npm 账号 `jacks001314`;预发布可追加 `--tag next`。CI 发布应使用启用了 `Bypass 2FA` 的 granular access token,避免交互式 OTP 过期。
|
|
135
|
+
|
|
136
|
+
编译当前平台的开发版本:
|
|
137
|
+
|
|
138
|
+
```powershell
|
|
139
|
+
.\scripts\build.ps1
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Windows builds also write `codex-command-runner.exe` and
|
|
143
|
+
`codex-windows-sandbox-setup.exe` under `bin\codex-resources`. NPM platform
|
|
144
|
+
packages use the official `vendor/<target-triple>/bin` layout with a sibling
|
|
145
|
+
`codex-resources` directory.
|
|
146
|
+
|
|
147
|
+
编译指定版本和目标平台:
|
|
148
|
+
|
|
149
|
+
```powershell
|
|
150
|
+
.\scripts\build.ps1 -Version 0.1.0 -GOOS linux -GOARCH amd64 -CGO off
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
从当前源码安装。Windows 默认安装到 `%LOCALAPPDATA%\Programs\CodexGo\bin`,
|
|
154
|
+
其他系统默认安装到 `~/.local/bin`:
|
|
155
|
+
|
|
156
|
+
```powershell
|
|
157
|
+
.\scripts\install.ps1 -Version 0.1.0
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
也可以指定安装目录:
|
|
161
|
+
|
|
162
|
+
```powershell
|
|
163
|
+
.\scripts\install.ps1 -InstallDir C:\Tools\CodexGo -Force
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
生成 Windows、Linux 和 macOS 的 amd64/arm64 发布包及 SHA-256 校验清单:
|
|
167
|
+
|
|
168
|
+
```powershell
|
|
169
|
+
.\scripts\release.ps1 -Version 0.1.0
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
发布产物默认写入 `dist/v<版本号>`。可用 `-Targets windows/amd64,linux/amd64`
|
|
173
|
+
限制目标平台,或用 `-SkipTests` 跳过发布前的全包编译检查。
|
|
174
|
+
|
|
175
|
+
Linux、macOS、WSL 或其他 POSIX Shell 环境可以使用对应的 Shell 脚本:
|
|
176
|
+
|
|
177
|
+
```sh
|
|
178
|
+
./scripts/build.sh --version 0.1.0
|
|
179
|
+
./scripts/install.sh --version 0.1.0
|
|
180
|
+
./scripts/release.sh --version 0.1.0
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
指定发布目标:
|
|
184
|
+
|
|
185
|
+
```sh
|
|
186
|
+
./scripts/release.sh --version 0.1.0 \
|
|
187
|
+
--targets 'linux/amd64 linux/arm64 darwin/arm64'
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
## 目录结构
|
|
191
|
+
|
|
192
|
+
```text
|
|
193
|
+
cmd/codex 可执行入口
|
|
194
|
+
app 顶层命令分发和运行时拼装
|
|
195
|
+
cli 命令行解析、参数校验、dispatch alias
|
|
196
|
+
config 配置加载、profile、feature override、权限配置
|
|
197
|
+
auth 登录凭据、auth.json、OAuth/API key/access token
|
|
198
|
+
model 模型 provider、Responses 请求/流式事件、模型 catalog
|
|
199
|
+
codexapi OpenAI/Codex API 客户端辅助
|
|
200
|
+
turn agent loop、tool dispatch、turn runtime
|
|
201
|
+
tool shell/apply_patch/MCP/tool_search/agent 工具运行时
|
|
202
|
+
exec codex exec/review 的非交互运行
|
|
203
|
+
appserver JSON-RPC app-server、thread/turn/runtime 服务
|
|
204
|
+
mcp MCP client/server、OAuth、resource、tool runtime
|
|
205
|
+
tui 终端 UI 状态、渲染、组件和 Bubble Tea adapter
|
|
206
|
+
session 会话存储、resume/fork/archive/delete
|
|
207
|
+
rollout rollout JSONL 记录和恢复
|
|
208
|
+
sandbox 权限 profile、Linux/Windows 沙箱、执行计划
|
|
209
|
+
review review 目标解析和 git diff 采集
|
|
210
|
+
doctor 环境诊断
|
|
211
|
+
plugin 插件 manifest、marketplace、安装流程
|
|
212
|
+
agent 多 agent graph、身份、registry、工具
|
|
213
|
+
utils 路径、JSON、ANSI、LRU、截断等共享工具
|
|
214
|
+
docs 设计和技术选型文档
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
## 开发约定
|
|
218
|
+
|
|
219
|
+
- 以 Rust 版 Codex 的行为和协议形状为基线。
|
|
220
|
+
- 新功能优先放入已有功能包,避免无必要地新增目录。
|
|
221
|
+
- 结构体参数和结构体返回值默认优先使用指针,简单标量按 Go 惯例传值。
|
|
222
|
+
- 代码变更后至少运行相关包测试;模块收口时运行 `go list -buildvcs=false ./...` 和 `go test ./...`。
|
|
223
|
+
- 迁移进度、验收项和工作日志维护在 [plan.md](./plan.md)。
|
|
224
|
+
|
|
225
|
+
## 参考文档
|
|
226
|
+
|
|
227
|
+
- [plan.md](./plan.md):迁移进度和待办
|
|
228
|
+
- [desgn.md](./desgn.md):迁移设计草案
|
|
229
|
+
- [docs/tui_tech_selection.md](./docs/tui_tech_selection.md):TUI 技术选型
|
|
230
|
+
|
|
231
|
+
## 许可证
|
|
232
|
+
|
|
233
|
+
本项目基于上游 [OpenAI Codex](https://github.com/openai/codex) 的 Apache-2.0 许可实现,同样以 Apache License 2.0 发布。
|
|
234
|
+
|
|
235
|
+
- [LICENSE](./LICENSE):Apache License, Version 2.0 全文
|
|
236
|
+
- [NOTICE](./NOTICE):上游来源、修改声明,以及发布包内附带的 ripgrep、bubblewrap、Opus 等第三方组件许可信息
|
|
237
|
+
|
|
238
|
+
分发二进制或 npm 包时必须一并携带 `LICENSE` 与 `NOTICE`(`scripts/release.ps1`、`scripts/release.sh`、`npm/scripts/build-packages.mjs` 已自动打包)。
|
package/package.json
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
[diffend] Oversized file quarantined before diffing.
|
|
2
2
|
name: package/vendor/aarch64-apple-darwin/bin/codex
|
|
3
|
-
size:
|
|
4
|
-
sha256:
|
|
3
|
+
size: 70471874 bytes
|
|
4
|
+
sha256: af0bf7bd9438bad5fae69ffd6d1c70b2d39f43589fe688f1249c9f2cc09c0ff3
|
|
Binary file
|