tpc-explorer 1.0.0 → 1.1.0

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.
Files changed (2) hide show
  1. package/README.md +76 -0
  2. package/package.json +3 -2
package/README.md ADDED
@@ -0,0 +1,76 @@
1
+ # TPC Explorer Pro
2
+
3
+ A terminal file explorer with embedded AI assistants (Claude Code / OpenAI Codex).
4
+
5
+ ![Node.js](https://img.shields.io/badge/node-%3E%3D18-green) ![Platform](https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-blue)
6
+
7
+ ## Install
8
+
9
+ ```bash
10
+ npm install -g tpc-explorer
11
+ tpc
12
+ ```
13
+
14
+ Or run directly:
15
+
16
+ ```bash
17
+ npx tpc-explorer
18
+ ```
19
+
20
+ ## Features
21
+
22
+ - File tree with syntax-highlighted preview and line numbers
23
+ - Embedded AI terminal — launch Claude Code or OpenAI Codex inside the explorer
24
+ - Multiple AI sessions running simultaneously, switch between them with `Ctrl+A`
25
+ - Session history — browse and resume past Claude/Codex conversations
26
+ - Tokyo Night Storm theme with emoji file-type icons (no Nerd Font needed)
27
+ - File management: create files/folders, delete
28
+
29
+ ## Keyboard Shortcuts
30
+
31
+ | Key | Action |
32
+ |-----|--------|
33
+ | `Ctrl+T` | Switch panel (Tree / Sessions / Viewer) |
34
+ | `Ctrl+A` | Switch between active AI sessions |
35
+ | `Ctrl+D` | Kill all sessions and quit |
36
+ | `a` | Launch new AI (Claude Code / Codex) |
37
+ | `n` | New file |
38
+ | `f` | New folder |
39
+ | `d` | Delete file/folder |
40
+ | `r` | Refresh tree and sessions |
41
+ | `q` / `Esc` | Quit |
42
+
43
+ ### Inside AI session
44
+
45
+ | Key | Action |
46
+ |-----|--------|
47
+ | `Ctrl+C` | Send interrupt to AI |
48
+ | `Ctrl+C` x2 | Force kill active session |
49
+ | `Ctrl+T` | Switch to another panel (AI keeps running) |
50
+
51
+ ## Layout
52
+
53
+ ```
54
+ ┌─ EXPLORER ──┬─────────── PREVIEW ───────────┐
55
+ │ file tree │ syntax-highlighted file view │
56
+ │ │ or embedded AI terminal │
57
+ ├─ SESSIONS ──┤ │
58
+ │ Claude │ │
59
+ │ Codex │ │
60
+ ├─────────────┴────────────────────────────────┤
61
+ │ status bar Ctrl-D Quit│
62
+ └──────────────────────────────────────────────┘
63
+ ```
64
+
65
+ ## Requirements
66
+
67
+ - Node.js >= 18
68
+ - Build tools for native modules (node-pty):
69
+ - **macOS**: Xcode Command Line Tools (`xcode-select --install`)
70
+ - **Linux**: `build-essential` (`sudo apt install build-essential`)
71
+ - **Windows**: `windows-build-tools` (`npm install -g windows-build-tools`)
72
+ - Optional: [Claude Code](https://claude.ai/code) and/or [OpenAI Codex](https://openai.com/codex) CLI installed
73
+
74
+ ## License
75
+
76
+ ISC
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tpc-explorer",
3
- "version": "1.0.0",
3
+ "version": "1.1.0",
4
4
  "description": "Terminal file explorer with embedded AI assistants (Claude Code / OpenAI Codex)",
5
5
  "main": "index.js",
6
6
  "bin": {
@@ -28,7 +28,8 @@
28
28
  },
29
29
  "files": [
30
30
  "index.js",
31
- "setup.js"
31
+ "setup.js",
32
+ "README.md"
32
33
  ],
33
34
  "dependencies": {
34
35
  "@xterm/addon-serialize": "^0.14.0",