Skip to content
Draft
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
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ jobs:
- name: Install dependencies
run: pnpm install --frozen-lockfile

- name: Validate Codex App Server manifest
run: pnpm check:codex-runtime

- name: Typecheck
run: pnpm typecheck

Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/p0-release-candidate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ jobs:
- name: Install dependencies
run: pnpm install --frozen-lockfile

- name: Validate Codex App Server manifest
run: pnpm check:codex-runtime

- name: Typecheck
run: pnpm typecheck

Expand Down
28 changes: 28 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,17 @@ jobs:
- name: Typecheck
run: pnpm typecheck

- name: Prepare embedded Codex App Server
shell: bash
run: |
if [[ "${RUNNER_OS}" == "macOS" ]]; then
pnpm prepare:codex-runtime:mac
node scripts/check_codex_runtime.mjs --mode=release --platform=darwin-arm64 --platform=darwin-x64
else
pnpm prepare:codex-runtime:win
node scripts/check_codex_runtime.mjs --mode=release --platform=win32-x64
fi

- name: Download Kokoro TTS assets
uses: actions/download-artifact@v4
with:
Expand Down Expand Up @@ -445,6 +456,15 @@ jobs:
hdiutil verify "$dmg"
done

- name: Verify packaged Codex App Server
shell: bash
run: |
if [[ "${RUNNER_OS}" == "macOS" ]]; then
node scripts/smoke_codex_packaged_runtime.mjs --root=release --expect=darwin-arm64 --expect=darwin-x64
else
node scripts/smoke_codex_packaged_runtime.mjs --root=release --expect=win32-x64
fi

- name: Smoke packaged Windows app
if: runner.os == 'Windows'
run: node scripts/smoke_windows_packaged_app.mjs --mode=full --require-katago
Expand Down Expand Up @@ -500,6 +520,11 @@ jobs:
- name: Typecheck
run: pnpm typecheck

- name: Prepare embedded Codex App Server
run: |
pnpm prepare:codex-runtime:win
node scripts/check_codex_runtime.mjs --mode=release --platform=win32-x64

- name: Download Kokoro TTS assets
uses: actions/download-artifact@v4
with:
Expand Down Expand Up @@ -622,6 +647,9 @@ jobs:
throw "NVIDIA portable archive exceeds GitHub's 2 GiB asset limit: $($nvidiaPortable.Name) $($nvidiaPortable.Length)"
}

- name: Verify packaged Codex App Server
run: node scripts/smoke_codex_packaged_runtime.mjs --root=release --expect=win32-x64

- name: Smoke NVIDIA packaged Windows app
run: node scripts/smoke_windows_packaged_app.mjs --mode=nvidia --require-katago

Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ data/katago/models/**
data/katago/edition.json
!data/katago/README.md

# Platform Codex App Server binaries are verified release inputs, not source files.
data/codex/bin/**

# Large local Kokoro TTS model files are prepared by scripts for release packaging.
# Voices and metadata are small enough to version; the ONNX model is not.
data/tts/kokoro/**/onnx/*.onnx
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ docs 架构、发布、签名、公证、QA 文档
- pnpm 10+
- Python 3.10+
- KataGo 二进制和一个 KataGo 模型
- 可选:OpenAI-compatible 多模态 LLM API
- 可选:OpenAI-compatible 多模态 LLM API,或通过官方 Codex App Server 使用 ChatGPT 登录

启动:

Expand All @@ -196,6 +196,12 @@ pnpm dist:win
pnpm dist:linux
```

## AI 老师连接

- **API Key**:可继续使用支持 OpenAI-compatible API 的多模态模型服务。
- **ChatGPT 登录**:在“设置 → AI 老师”选择“使用 ChatGPT 登录”。GoAgent 通过官方 Codex App Server 完成登录、模型发现和请求;可使用当前 ChatGPT 套餐中支持棋盘图片输入的模型。
- 登录型连接使用 GoAgent 独立的 Codex App Server 数据目录,不读取或修改系统 Codex CLI / Codex Desktop 的登录;GoAgent 业务代码不读取、复制或输出 OAuth token。

## KataGo 资源

GoAgent 优先寻找随安装包携带的 KataGo 运行时:
Expand All @@ -214,8 +220,8 @@ data/katago/
## 隐私与安全

- 棋谱、学生画像、报告和设置默认保存在 `~/.goagent`。
- LLM API Key 在支持的平台上使用 Electron `safeStorage` 加密保存
- 前端不会拿到已保存的完整 API Key
- LLM API Key 保存在 GoAgent 本地 secret store 中;只有用户主动点击“显示 Key”核对时才会在设置页读取并显示
- ChatGPT 登录凭据由 GoAgent 内置的官方 Codex App Server 保存在 GoAgent 专属目录中;GoAgent 业务代码不会读取或输出 OAuth token,也不会触碰系统 Codex 登录
- 当前手讲解会发送棋盘截图、KataGo JSON 和知识库摘录到用户配置的 LLM 服务。
- Web 搜索只用于泛化围棋概念,不发送学生姓名、棋谱原文、截图、API Key 或本机路径。

Expand Down
11 changes: 9 additions & 2 deletions README_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Requirements:
- pnpm 10+
- Python 3.10+
- KataGo binary and model
- Optional OpenAI-compatible multimodal LLM API
- Optional OpenAI-compatible multimodal LLM API, or ChatGPT sign-in through the official Codex App Server

For remote compute, see [iKataGo Remote Engine](./docs/IKATAGO_REMOTE_ENGINE.md). GoAgent uses a local `ikatago-client -- analysis` process and does not send positions remotely unless the user explicitly enables that engine path.

Expand All @@ -151,10 +151,17 @@ pnpm dist:win
pnpm dist:linux
```

## AI Teacher Connections

- **API key**: Continue using any OpenAI-compatible multimodal model service.
- **ChatGPT sign-in**: Choose “Sign in with ChatGPT” under **Settings → AI Teacher**. GoAgent uses the official Codex App Server for sign-in, model discovery, and requests, and can use models in the active ChatGPT plan that accept board images.
- ChatGPT sign-in uses a GoAgent-specific Codex App Server data directory. It does not read or modify Codex CLI or Codex Desktop sign-in. GoAgent application code does not read, copy, or print OAuth tokens.

## Privacy

- Games, reports, settings, and student profiles stay under `~/.goagent` by default.
- Saved LLM API keys are encrypted with Electron `safeStorage` when available.
- Saved LLM API keys use GoAgent's local secret store and are only read back into Settings when the user explicitly chooses “Show key.”
- The embedded official Codex App Server keeps ChatGPT credentials in GoAgent's dedicated data directory. GoAgent application code does not read or print OAuth tokens and does not touch the system Codex sign-in.
- Current-move teaching may send a board screenshot, KataGo JSON, and selected knowledge cards to the configured LLM endpoint.
- Web search is optional and should only use generic Go concepts.

Expand Down
32 changes: 32 additions & 0 deletions build/afterPack.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
const { createHash } = require('node:crypto')
const { chmodSync, copyFileSync, existsSync, mkdirSync, readFileSync, statSync } = require('node:fs')
const { join } = require('node:path')
const { Arch } = require('builder-util')

module.exports = async function afterPack(context) {
const projectDir = context.packager.projectDir
const manifestPath = join(projectDir, 'data', 'codex', 'manifest.json')
const manifest = JSON.parse(readFileSync(manifestPath, 'utf8'))
const arch = Arch[context.arch]
const target = `${context.electronPlatformName}-${arch}`
const asset = manifest.targets[target]
if (!asset) throw new Error(`Codex runtime manifest does not support ${target}`)

const source = join(projectDir, 'data', 'codex', 'bin', target, asset.executable)
if (!existsSync(source)) throw new Error(`Codex runtime is missing for ${target}. Run the matching prepare:codex-runtime script first.`)
const digest = createHash('sha256').update(readFileSync(source)).digest('hex')
if (statSync(source).size !== asset.bytes || digest !== asset.sha256) {
throw new Error(`Codex runtime validation failed for ${target}`)
}

const resources = context.electronPlatformName === 'darwin'
? join(context.appOutDir, `${context.packager.appInfo.productFilename}.app`, 'Contents', 'Resources')
: join(context.appOutDir, 'resources')
const destinationDir = join(resources, 'data', 'codex')
const destination = join(destinationDir, 'bin', target, asset.executable)
mkdirSync(join(destinationDir, 'bin', target), { recursive: true })
copyFileSync(source, destination)
copyFileSync(manifestPath, join(destinationDir, 'manifest.json'))
copyFileSync(join(projectDir, 'data', 'codex', 'LICENSE'), join(destinationDir, 'LICENSE'))
if (context.electronPlatformName !== 'win32') chmodSync(destination, 0o755)
}
201 changes: 201 additions & 0 deletions data/codex/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2025 OpenAI

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Loading
Loading