codexmate 0.0.2
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/.github/workflows/release.yml +45 -0
- package/LICENSE +190 -0
- package/README.md +290 -0
- package/README.zh-CN.md +286 -0
- package/cli.js +3022 -0
- package/package.json +25 -0
- package/res/screenshot.png +0 -0
- package/web-ui.html +3183 -0
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
name: release
|
|
2
|
+
run-name: "${{ github.event.repository.name }} ${{ inputs.tag }}"
|
|
3
|
+
on:
|
|
4
|
+
workflow_dispatch:
|
|
5
|
+
inputs:
|
|
6
|
+
tag:
|
|
7
|
+
description: 'Tag to release (e.g., v0.0.1)'
|
|
8
|
+
required: true
|
|
9
|
+
permissions:
|
|
10
|
+
contents: write
|
|
11
|
+
|
|
12
|
+
jobs:
|
|
13
|
+
release:
|
|
14
|
+
runs-on: ubuntu-latest
|
|
15
|
+
steps:
|
|
16
|
+
- name: Checkout tag
|
|
17
|
+
uses: actions/checkout@v4
|
|
18
|
+
with:
|
|
19
|
+
ref: ${{ inputs.tag }}
|
|
20
|
+
fetch-depth: 0
|
|
21
|
+
- uses: actions/setup-node@v4
|
|
22
|
+
with:
|
|
23
|
+
node-version: '18'
|
|
24
|
+
cache: 'npm'
|
|
25
|
+
- name: Verify tag matches package.json version
|
|
26
|
+
run: |
|
|
27
|
+
node -e "const pkg=require('./package.json'); const tag='${{ inputs.tag }}'; const expected='v'+pkg.version; if(tag!==expected){ console.error('Tag '+tag+' does not match package.json version '+expected); process.exit(1);} console.log('Tag matches '+expected);"
|
|
28
|
+
- name: Compute release name
|
|
29
|
+
run: |
|
|
30
|
+
node -e "const p=require('./package.json'); const tag='${{ inputs.tag }}'; const name=p.name.includes('/')? p.name.split('/')[1]: p.name; const value=name+' '+tag; console.log('RELEASE_NAME='+value);" >> "$GITHUB_ENV"
|
|
31
|
+
- name: Pack npm artifact
|
|
32
|
+
run: |
|
|
33
|
+
name=$(node -e "const p=require('./package.json'); const n=p.name.replace('@','').replace('/','-'); process.stdout.write(n+'-'+p.version+'.tgz');")
|
|
34
|
+
npm pack
|
|
35
|
+
test -f "$name"
|
|
36
|
+
echo "PACKAGE_TGZ=$name" >> "$GITHUB_ENV"
|
|
37
|
+
- name: Create GitHub Release
|
|
38
|
+
uses: softprops/action-gh-release@v2
|
|
39
|
+
with:
|
|
40
|
+
tag_name: ${{ inputs.tag }}
|
|
41
|
+
name: ${{ env.RELEASE_NAME }}
|
|
42
|
+
prerelease: false
|
|
43
|
+
draft: false
|
|
44
|
+
files: ${{ env.PACKAGE_TGZ }}
|
|
45
|
+
generate_release_notes: true
|
package/LICENSE
ADDED
|
@@ -0,0 +1,190 @@
|
|
|
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 the 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
|
+
Copyright 2025 ymkiux
|
|
179
|
+
|
|
180
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
181
|
+
you may not use this file except in compliance with the License.
|
|
182
|
+
You may obtain a copy of the License at
|
|
183
|
+
|
|
184
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
185
|
+
|
|
186
|
+
Unless required by applicable law or agreed to in writing, software
|
|
187
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
188
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
189
|
+
See the License for the specific language governing permissions and
|
|
190
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,290 @@
|
|
|
1
|
+
# Codex Mate
|
|
2
|
+
|
|
3
|
+
> A lightweight AI configuration assistant: CLI + Web to manage Codex providers/models and Claude Code configs
|
|
4
|
+
|
|
5
|
+
[](https://github.com/ymkiux/codexmate/actions/workflows/release.yml) [](https://github.com/ymkiux/codexmate/blob/main/package.json) [](https://github.com/ymkiux/codexmate) [](https://www.npmjs.com/package/codexmate)
|
|
6
|
+
[](https://github.com/ymkiux/codexmate/commits) [](LICENSE) [](https://nodejs.org)
|
|
7
|
+
|
|
8
|
+
English | [Chinese](README.zh-CN.md)
|
|
9
|
+
|
|
10
|
+
## Overview
|
|
11
|
+
|
|
12
|
+
If you frequently switch between models, providers, or configuration profiles, Codex Mate turns that into a single command or a single click.
|
|
13
|
+
|
|
14
|
+
## What You Get
|
|
15
|
+
|
|
16
|
+
- Faster provider/model switching
|
|
17
|
+
- More controllable local configuration management
|
|
18
|
+
- A visual Web UI to reduce CLI burden
|
|
19
|
+
- Change tracking with backups
|
|
20
|
+
|
|
21
|
+
## Feature Overview
|
|
22
|
+
|
|
23
|
+
| Module | Problem | Key Capabilities |
|
|
24
|
+
| --- | --- | --- |
|
|
25
|
+
| Codex Config | Switching providers/models is painful | Provider/model switching, model management, CLI + Web entry points, template-confirmed writes |
|
|
26
|
+
| Claude Code Config | Multiple profiles and inconsistent write paths | Profile management, default write to `~/.claude/settings.json`, compatibility mode env vars |
|
|
27
|
+
| Session Browser | Local sessions are hard to track | List/filter sessions, export to Markdown, delete and batch cleanup |
|
|
28
|
+
| Utilities | Compression/extraction requires extra tools | Multithreaded compress/unzip via 7-Zip |
|
|
29
|
+
|
|
30
|
+
## Why Codex Mate
|
|
31
|
+
|
|
32
|
+
- Focused on two jobs: Codex provider/model switching + Claude Code config apply
|
|
33
|
+
- Local-first: configs and API keys are written to local files, not the cloud
|
|
34
|
+
- Lightweight: CLI + Web, no desktop app required
|
|
35
|
+
- Reversible: auto-backup before first takeover
|
|
36
|
+
|
|
37
|
+
## Use Cases
|
|
38
|
+
|
|
39
|
+
- Frequent provider/model switching, want a one-command flow
|
|
40
|
+
- Use both Codex and Claude Code, want a single entry point
|
|
41
|
+
- Multi-project or multi-environment setups that need quick config changes
|
|
42
|
+
- Want a visual UI without a heavy client
|
|
43
|
+
|
|
44
|
+
## Scope and Boundaries
|
|
45
|
+
|
|
46
|
+
- Only configuration management for Codex and Claude Code, not a full all-in-one tool suite
|
|
47
|
+
- No built-in proxy/relay/billing dashboard/cloud sync (kept lightweight)
|
|
48
|
+
- Web UI runs only when you start it (`codexmate start`)
|
|
49
|
+
|
|
50
|
+
## Quick Start
|
|
51
|
+
|
|
52
|
+
1. Install (global):
|
|
53
|
+
```bash
|
|
54
|
+
npm install -g ymkiux/codexmate
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
2. Check status:
|
|
58
|
+
```bash
|
|
59
|
+
codexmate status
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
3. Start the Web UI:
|
|
63
|
+
```bash
|
|
64
|
+
codexmate start
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Then open `http://localhost:3737` in your browser.
|
|
68
|
+
|
|
69
|
+
## UI Preview
|
|
70
|
+
|
|
71
|
+

|
|
72
|
+
|
|
73
|
+
## Install
|
|
74
|
+
|
|
75
|
+
### Global (Recommended)
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
npm install -g ymkiux/codexmate
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### From Source
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
git clone https://github.com/ymkiux/codexmate.git
|
|
85
|
+
cd codexmate
|
|
86
|
+
npm install
|
|
87
|
+
npm link
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### Requirements
|
|
91
|
+
|
|
92
|
+
- Node.js >= 14
|
|
93
|
+
- Windows / macOS / Linux
|
|
94
|
+
|
|
95
|
+
## CLI Cheat Sheet
|
|
96
|
+
|
|
97
|
+
| Command | Description |
|
|
98
|
+
| --- | --- |
|
|
99
|
+
| `codexmate` | Show help and available commands |
|
|
100
|
+
| `codexmate status` | Show current status |
|
|
101
|
+
| `codexmate list` | List all providers |
|
|
102
|
+
| `codexmate switch <provider>` | Switch provider |
|
|
103
|
+
| `codexmate use <model>` | Switch model |
|
|
104
|
+
| `codexmate add <name> <URL> [API key]` | Add a provider |
|
|
105
|
+
| `codexmate delete <provider>` | Delete a provider |
|
|
106
|
+
| `codexmate models` | List all models |
|
|
107
|
+
| `codexmate add-model <model>` | Add a model |
|
|
108
|
+
| `codexmate delete-model <model>` | Delete a model |
|
|
109
|
+
| `codexmate start` | Start the Web UI |
|
|
110
|
+
|
|
111
|
+
## Web UI
|
|
112
|
+
|
|
113
|
+
Start the Web UI (auto opens browser):
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
codexmate start
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Codex Config Mode
|
|
120
|
+
|
|
121
|
+
- View current provider and model status
|
|
122
|
+
- Quickly switch provider and model
|
|
123
|
+
- Manage available model list
|
|
124
|
+
- Edit `~/.codex/AGENTS.md` instruction file (same level as `config.toml`)
|
|
125
|
+
- Add/delete custom providers
|
|
126
|
+
- Supports Codex config management on Linux/Windows
|
|
127
|
+
|
|
128
|
+
### Claude Code Config Mode (Windows / macOS / Linux)
|
|
129
|
+
|
|
130
|
+
- Manage multiple Claude Code profiles
|
|
131
|
+
- Configure API key, Base URL, and model
|
|
132
|
+
- Default write to `env` in `~/.claude/settings.json`: `env.ANTHROPIC_API_KEY` / `env.ANTHROPIC_AUTH_TOKEN` / `env.ANTHROPIC_BASE_URL` / `env.ANTHROPIC_MODEL` / `env.CLAUDE_CODE_USE_KEY`
|
|
133
|
+
- Compatibility mode: write to system environment variables (useful for legacy workflows or specific Windows cases)
|
|
134
|
+
|
|
135
|
+
### Session Browser
|
|
136
|
+
|
|
137
|
+
- View local Codex and Claude Code sessions in one page
|
|
138
|
+
- Filter by source (Codex / Claude / All)
|
|
139
|
+
- Filter by session path (cwd), auto refresh on selection
|
|
140
|
+
- Export selected sessions to Markdown
|
|
141
|
+
- Delete single sessions (local jsonl records)
|
|
142
|
+
- Batch delete multiple sessions with partial failure summary
|
|
143
|
+
- Delete individual records or multi-select within session details (writes back to original jsonl)
|
|
144
|
+
|
|
145
|
+
### Codex Template Confirmation Mode
|
|
146
|
+
|
|
147
|
+
- Codex config changes in Web UI go to a `config.toml` template editor first
|
|
148
|
+
- Only writes to `config.toml` after you click "Confirm Apply Template"
|
|
149
|
+
- Prevents direct one-click overwrites from the UI
|
|
150
|
+
|
|
151
|
+
## Configuration Files
|
|
152
|
+
|
|
153
|
+
Config directory: `~/.codex/`
|
|
154
|
+
|
|
155
|
+
- `config.toml` - Codex main config
|
|
156
|
+
- `auth.json` - API auth info
|
|
157
|
+
- `models.json` - Available model list
|
|
158
|
+
- `provider-current-models.json` - Per-provider current model config
|
|
159
|
+
- `codexmate-init.json` - First-run marker
|
|
160
|
+
- `config.toml.codexmate-backup-*.bak` - Backup created on first takeover
|
|
161
|
+
|
|
162
|
+
Claude Code config files:
|
|
163
|
+
|
|
164
|
+
- `~/.claude/settings.json` - Runtime config (default write target)
|
|
165
|
+
- `~/.claude/settings.json.codexmate-backup-*.bak` - Backup before first overwrite
|
|
166
|
+
|
|
167
|
+
## First Run Initialization
|
|
168
|
+
|
|
169
|
+
When you run `codexmate` for the first time and an existing `~/.codex/config.toml` is detected that is not managed by Codex Mate:
|
|
170
|
+
|
|
171
|
+
- The original file is backed up as `config.toml.codexmate-backup-<timestamp>.bak`
|
|
172
|
+
- The original `config.toml` is preserved, and a first-run marker is written
|
|
173
|
+
- Only when `CODEXMATE_FORCE_RESET_EXISTING_CONFIG=1` is set will the default config be rebuilt
|
|
174
|
+
- Subsequent runs will not repeat this process
|
|
175
|
+
|
|
176
|
+
## Examples
|
|
177
|
+
|
|
178
|
+
### Add a Custom API Provider
|
|
179
|
+
|
|
180
|
+
```bash
|
|
181
|
+
codexmate add myapi https://api.example.com/v1 sk-your-api-key
|
|
182
|
+
codexmate switch myapi
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### Switch to a Different Model
|
|
186
|
+
|
|
187
|
+
```bash
|
|
188
|
+
codexmate use gpt-4-turbo
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
### Configure Claude Code (Cross-Platform)
|
|
192
|
+
|
|
193
|
+
1. Start the Web UI: `codexmate start`
|
|
194
|
+
2. Switch to "Claude Code Config" mode in the browser
|
|
195
|
+
3. Add a profile (example Zhipu GLM): Name=ZhipuGLM, API Key=your API key, Base URL=`https://open.bigmodel.cn/api/anthropic`, Model=`glm-4.7`
|
|
196
|
+
4. Click the card to apply, or use "Save & Apply to Claude Config" in the editor
|
|
197
|
+
5. Default write to `~/.claude/settings.json`; compatibility mode writes system env vars
|
|
198
|
+
6. Restart Claude Code to apply
|
|
199
|
+
|
|
200
|
+
### Start the Web UI
|
|
201
|
+
|
|
202
|
+
```bash
|
|
203
|
+
codexmate start
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
Then open `http://localhost:3737`.
|
|
207
|
+
|
|
208
|
+
## FAQ
|
|
209
|
+
|
|
210
|
+
### Q: Which operating systems are supported?
|
|
211
|
+
|
|
212
|
+
A: Codex features support Windows and Linux (CLI and Web). Claude Code config applies to Windows / macOS / Linux (writes to `~/.claude/settings.json`). Compatibility mode env vars are Windows-only.
|
|
213
|
+
|
|
214
|
+
### Q: Where are API keys stored?
|
|
215
|
+
|
|
216
|
+
A: API keys are stored locally in `~/.codex/config.toml` and are not uploaded.
|
|
217
|
+
|
|
218
|
+
### Q: Is the Web UI safe?
|
|
219
|
+
|
|
220
|
+
A: The Web UI runs locally; all operations happen on your machine. API keys are masked in the UI.
|
|
221
|
+
|
|
222
|
+
### Q: How do Claude Code configs take effect?
|
|
223
|
+
|
|
224
|
+
A: After clicking "Apply to Claude Config", it writes to `~/.claude/settings.json`. Restart Claude Code to apply. If using compatibility mode env vars, a restart is also recommended.
|
|
225
|
+
|
|
226
|
+
### Q: How to uninstall?
|
|
227
|
+
|
|
228
|
+
A: Run `npm uninstall -g codexmate`.
|
|
229
|
+
|
|
230
|
+
## Extras: Multithreaded Compression/Extraction
|
|
231
|
+
|
|
232
|
+
Based on 7-Zip for multithreaded zip/unzip.
|
|
233
|
+
|
|
234
|
+
```bash
|
|
235
|
+
# Compress file or folder (default compression level 5)
|
|
236
|
+
codexmate zip <path>
|
|
237
|
+
|
|
238
|
+
# Set compression level (0-9, 0=store only, 9=max)
|
|
239
|
+
codexmate zip <path> --max:9
|
|
240
|
+
|
|
241
|
+
# Unzip a zip file (default to same-level folder)
|
|
242
|
+
codexmate unzip <zip path>
|
|
243
|
+
|
|
244
|
+
# Unzip to a specific output directory
|
|
245
|
+
codexmate unzip <zip path> <output dir>
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
Examples:
|
|
249
|
+
|
|
250
|
+
```bash
|
|
251
|
+
# Compress a project folder
|
|
252
|
+
codexmate zip ./my-project
|
|
253
|
+
|
|
254
|
+
# Max compression
|
|
255
|
+
codexmate zip ./my-project --max:9
|
|
256
|
+
|
|
257
|
+
# Store only (fast)
|
|
258
|
+
codexmate zip ./large-folder --max:0
|
|
259
|
+
|
|
260
|
+
# Unzip
|
|
261
|
+
codexmate unzip ./my-project.zip
|
|
262
|
+
|
|
263
|
+
# Unzip to a target location
|
|
264
|
+
codexmate unzip ./backup.zip D:/restored
|
|
265
|
+
```
|
|
266
|
+
|
|
267
|
+
Note: Requires [7-Zip](https://www.7-zip.org/) installed.
|
|
268
|
+
|
|
269
|
+
## Tech Stack
|
|
270
|
+
|
|
271
|
+
- **Node.js** - Runtime
|
|
272
|
+
- **@iarna/toml** - TOML parser
|
|
273
|
+
- **Vue.js 3** - Web UI framework
|
|
274
|
+
- **Native HTTP** - Built-in Web server
|
|
275
|
+
|
|
276
|
+
## Release (GitHub Actions)
|
|
277
|
+
|
|
278
|
+
Create a tag that matches `package.json` (for example `v0.0.1`). Then run the `release` workflow in GitHub Actions and input that tag. It will create a GitHub Release and attach the `npm pack` `.tgz` artifact.
|
|
279
|
+
|
|
280
|
+
## License
|
|
281
|
+
|
|
282
|
+
Apache-2.0 © [ymkiux](https://github.com/ymkiux)
|
|
283
|
+
|
|
284
|
+
## Contributing
|
|
285
|
+
|
|
286
|
+
Issues and pull requests are welcome.
|
|
287
|
+
|
|
288
|
+
---
|
|
289
|
+
|
|
290
|
+
Made with [ymkiux](https://github.com/ymkiux)
|