codex-mirror 0.1.5 → 0.1.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/README.md +36 -20
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -49,50 +49,65 @@ npm run build
|
|
|
49
49
|
node dist/cli.js
|
|
50
50
|
```
|
|
51
51
|
|
|
52
|
-
|
|
53
|
-
|
|
52
|
+
## Demo
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
npx codex-mirror@latest
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
`GIF source path:` `docs/assets/demo.gif`
|
|
61
|
+
`Direct link (for npm):` `https://raw.githubusercontent.com/Mohit-Patil/codex-mirror/main/docs/assets/demo.gif`
|
|
62
|
+
|
|
63
|
+
From the TUI main menu:
|
|
64
|
+
1. Choose `Quick Clone`.
|
|
54
65
|
2. Optionally run login for that clone.
|
|
55
66
|
3. Use `Manage Clones` to run, update, remove.
|
|
56
67
|
4. Use `Diagnostics` for health checks.
|
|
68
|
+
5. Use `Shell PATH Setup` to auto-configure wrapper discovery.
|
|
69
|
+
6. Use `Star on GitHub` to open the repository page.
|
|
70
|
+
7. Choose `Exit` for a final `Star and Exit` / `Skip and Exit` prompt.
|
|
57
71
|
|
|
58
72
|
## CLI usage
|
|
59
73
|
|
|
60
|
-
|
|
74
|
+
Examples below use the installed command.
|
|
75
|
+
For local development from source, replace `codex-mirror` with `node dist/cli.js`.
|
|
61
76
|
|
|
62
77
|
```bash
|
|
63
78
|
# Create clone (default root: ~/.codex-mirror/clones/<name>)
|
|
64
|
-
|
|
79
|
+
codex-mirror create --name work
|
|
65
80
|
|
|
66
81
|
# List clones
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
82
|
+
codex-mirror list
|
|
83
|
+
codex-mirror list --full
|
|
84
|
+
codex-mirror list --json
|
|
70
85
|
|
|
71
86
|
# Run clone
|
|
72
|
-
|
|
73
|
-
|
|
87
|
+
codex-mirror run work
|
|
88
|
+
codex-mirror run work -- --model o3
|
|
74
89
|
|
|
75
90
|
# Login/logout
|
|
76
|
-
|
|
77
|
-
|
|
91
|
+
codex-mirror login work
|
|
92
|
+
codex-mirror logout work
|
|
78
93
|
|
|
79
94
|
# Health checks
|
|
80
|
-
|
|
81
|
-
|
|
95
|
+
codex-mirror doctor
|
|
96
|
+
codex-mirror doctor work --json
|
|
82
97
|
|
|
83
98
|
# Updates
|
|
84
|
-
|
|
85
|
-
|
|
99
|
+
codex-mirror update work
|
|
100
|
+
codex-mirror update --all
|
|
86
101
|
|
|
87
102
|
# Remove clone
|
|
88
|
-
|
|
103
|
+
codex-mirror remove work
|
|
89
104
|
|
|
90
105
|
# Reinstall wrappers
|
|
91
|
-
|
|
106
|
+
codex-mirror wrapper install
|
|
92
107
|
|
|
93
108
|
# Check/setup PATH for wrapper commands
|
|
94
|
-
|
|
95
|
-
|
|
109
|
+
codex-mirror path status
|
|
110
|
+
codex-mirror path setup
|
|
96
111
|
```
|
|
97
112
|
|
|
98
113
|
## Data layout
|
|
@@ -177,4 +192,5 @@ npm run check
|
|
|
177
192
|
```bash
|
|
178
193
|
git push origin main --follow-tags
|
|
179
194
|
```
|
|
180
|
-
4. Tag trigger `v*`
|
|
195
|
+
4. Tag trigger `v*` runs `.github/workflows/release.yml` and publishes to npm.
|
|
196
|
+
5. Release workflow enforces `tag version == package.json version` (for example: `v0.1.5` requires `"version": "0.1.5"`).
|