codex-lens 0.1.16 → 0.1.17
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 +113 -2
- package/dist/aggregator.js +2 -1
- package/dist/public/assets/{main-ssN8akn5.js → main-Ddz_kiqA.js} +12 -12
- package/dist/public/index.html +1 -1
- package/docs/README_zh.md +111 -0
- package/package.json +1 -1
- package/src/aggregator.js +2 -1
- package/src/components/App.jsx +6 -1
- package/update.bat +0 -23
package/README.md
CHANGED
|
@@ -1,2 +1,113 @@
|
|
|
1
|
-
# Codex-Lens
|
|
2
|
-
|
|
1
|
+
# Codex-Lens
|
|
2
|
+
|
|
3
|
+
[简体中文](./docs/README_zh.md)
|
|
4
|
+
|
|
5
|
+
A visualization tool for Codex task management and code review.
|
|
6
|
+
|
|
7
|
+
## Features
|
|
8
|
+
|
|
9
|
+
### File Explorer
|
|
10
|
+
- Real-time monitoring of project file changes with automatic file tree updates
|
|
11
|
+
- Folder expand/collapse support
|
|
12
|
+
- Right-click context menu: copy file path, open in file explorer
|
|
13
|
+
|
|
14
|
+
### Code Viewer
|
|
15
|
+
- Syntax highlighting for 20+ programming languages (JavaScript, Python, Java, C/C++, Go, Rust, etc.)
|
|
16
|
+
- Line numbers
|
|
17
|
+
- Code minimap with draggable slider for scrolling and click-to-jump navigation
|
|
18
|
+
- File change diff display showing additions/deletions/modifications
|
|
19
|
+
|
|
20
|
+
### Terminal Integration
|
|
21
|
+
- Built-in terminal for direct interaction with Codex
|
|
22
|
+
- Real-time Codex output display
|
|
23
|
+
- Terminal input support
|
|
24
|
+
|
|
25
|
+
### Tab Management
|
|
26
|
+
- Multi-file tabbed browsing
|
|
27
|
+
- Keyboard shortcuts: `Ctrl+W` close tab, `Ctrl+Tab` switch tabs
|
|
28
|
+
- Right-click menu: close, close others, close all
|
|
29
|
+
|
|
30
|
+
### Other Features
|
|
31
|
+
- WebSocket real-time communication with auto-reconnect
|
|
32
|
+
- Version detection and update notifications
|
|
33
|
+
- Modern dark theme UI
|
|
34
|
+
|
|
35
|
+
## Prerequisites
|
|
36
|
+
|
|
37
|
+
Before using Codex-Lens, you need to install Codex:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npm install -g @openai/codex
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Installation
|
|
44
|
+
|
|
45
|
+
### Install globally via npm
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
npm install -g codex-lens
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Usage
|
|
52
|
+
|
|
53
|
+
Run in your project directory:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
codexlens
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
The tool will automatically:
|
|
60
|
+
1. Detect the current project root directory
|
|
61
|
+
2. Start the Codex process
|
|
62
|
+
3. Open the browser interface (http://localhost:5174)
|
|
63
|
+
|
|
64
|
+
## Updates
|
|
65
|
+
|
|
66
|
+
### Check for Updates
|
|
67
|
+
|
|
68
|
+
The tool automatically checks for the latest version on npm when starting. If an update is available, a notification will appear in the top-right corner.
|
|
69
|
+
|
|
70
|
+
### Manual Update
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
npm update -g codex-lens
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Tech Stack
|
|
77
|
+
|
|
78
|
+
- **Frontend**: React 18, Vite, CodeMirror 6
|
|
79
|
+
- **Backend**: Node.js, Express, WebSocket
|
|
80
|
+
- **Terminal**: xterm.js, node-pty
|
|
81
|
+
- **File Watching**: chokidar
|
|
82
|
+
- **Diff Generation**: diff
|
|
83
|
+
|
|
84
|
+
## Development
|
|
85
|
+
|
|
86
|
+
### Clone the project
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
git clone https://github.com/your-username/codex-lens.git
|
|
90
|
+
cd codex-lens
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### Install dependencies
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
npm install
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### Development mode
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
# Build the project
|
|
103
|
+
npm run build
|
|
104
|
+
|
|
105
|
+
# Start the service
|
|
106
|
+
npm start
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
Development workflow: After modifying code, run `npm run build` to rebuild the project, then run `npm start` to start the service and see the changes.
|
|
110
|
+
|
|
111
|
+
## License
|
|
112
|
+
|
|
113
|
+
[MIT](LICENSE)
|
package/dist/aggregator.js
CHANGED
|
@@ -67,7 +67,8 @@ class Aggregator {
|
|
|
67
67
|
codexRunning: !!this.ptyProcess,
|
|
68
68
|
version: current,
|
|
69
69
|
latestVersion,
|
|
70
|
-
hasUpdate: latestVersion && latestVersion !== current
|
|
70
|
+
hasUpdate: latestVersion && latestVersion !== current,
|
|
71
|
+
projectRoot: this.projectRoot
|
|
71
72
|
});
|
|
72
73
|
} else {
|
|
73
74
|
next();
|