projmux 0.14.2 → 0.15.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.
package/README-ko.md CHANGED
@@ -5,9 +5,9 @@
5
5
  </p>
6
6
 
7
7
  <p align="center">
8
- <strong>여러 AI 에이전트를 함께 쓰는 tmux 기반 개발 작업 공간.</strong>
8
+ <strong>여러 AI 에이전트로 개발하기 위한 tmux 작업 공간.</strong>
9
9
  <br>
10
- <em>Claude Code, Codex, Antigravity pane을 한곳에서 운영하고, 에이전트가 권한을 요청하거나 작업을 마치면 바로 알려 줍니다.</em>
10
+ <em>Codex, Claude Code, Antigravity 작업 공간에 나란히 띄웁니다.</em>
11
11
  </p>
12
12
 
13
13
  <p align="center">
@@ -17,140 +17,84 @@
17
17
  <a href="README.md"><img src="https://img.shields.io/badge/lang-English-blue" alt="English README"></a>
18
18
  </p>
19
19
 
20
+ ```sh
21
+ npm install -g projmux
22
+ projmux shell
23
+ ```
24
+
20
25
  <p align="center">
21
- <img src="docs/assets/projmux-ai-attention.gif" alt="projmux AI 세션 재개, 권한 요청, 그룹형 알림 흐름" width="820">
22
- <br>
23
- <em>기존 AI 세션을 이어서 열고 다른 프로젝트에서 작업하다가, 에이전트가 승인을 요청하면 그룹형 알림에서 확인하고 해당 작업 pane으로 돌아갑니다.</em>
26
+ <img src="docs/assets/projmux-overview-ko.gif" alt="projmux 작업 공간: 프로젝트를 옮기고, 이어서 세션을 고르고, 실행 중인 에이전트 옆에서 대화를 이어갑니다" width="820">
24
27
  </p>
25
28
 
26
- ## projmux란?
29
+ ##
27
30
 
28
- `projmux`는 프로젝트 디렉터리마다 오래 유지되는 tmux 세션을 연결합니다.
29
- 프로젝트 전환, 세션 미리보기, AI 분할 창 실행, 상태 표시를 키보드 중심의
30
- 작업 공간 하나로 묶습니다.
31
- Claude Code, Codex, Antigravity의 훅 연동을 관리하고, 각 에이전트의 권한
32
- 요청과 작업 완료 알림을 한곳에 모읍니다.
31
+ - `Alt-1` 프로젝트
32
+ - `Alt-2` 알림
33
+ - `Alt-3` 최근
34
+ - `Alt-4` AI 재개
35
+ - `Alt-5` 설정
36
+ - `Alt-7` AI 실행 (pane 분할)
33
37
 
34
- 터미널 작업 공간을 명령 하나로 열고, 같은 키 조합으로 프로젝트와 tmux
35
- 창, pane, 알림, 설정 사이를 빠르게 오가고 싶을 때 사용합니다.
38
+ `Alt-1`–`Alt-5`는 설정 없이 바로 동작합니다. 키를 바꾸려면
39
+ [터미널 설정](docs/keybindings.md)을 보세요.
36
40
 
37
- ## 요구 사항
38
-
39
- - [Node.js](https://nodejs.org/)와 npm: 기본 설치 경로에 필요합니다.
40
- - [tmux](https://github.com/tmux/tmux/wiki/Installing) **3.4 이상**.
41
-
42
- 설치한 뒤에는 읽기 전용 점검 명령인 `projmux doctor`로 로컬 실행 환경을
43
- 확인하세요.
41
+ ## 하던 대화 이어가기
44
42
 
45
- ## 설치
43
+ `Alt-4`를 누르면 Codex, Claude Code, Antigravity 세션이 한 곳에 모여 나옵니다.
44
+ 하나를 고르면 하던 자리에서, 같은 대화 그대로 열립니다.
46
45
 
47
- ```sh
48
- npm install -g projmux
49
- projmux version
50
- ```
46
+ ## 에이전트가 부를 때
51
47
 
52
- npm 패키지는 작은 Node.js 실행 연결부와 Linux/macOS x64·arm64용 projmux
53
- 실행 파일을 함께 설치합니다. 일반 사용자에게는 npm 설치를 권장합니다.
48
+ 승인 요청이든 작업 완료든, 에이전트가 보내는 알림은 곳에 모입니다. `Alt-2`를
49
+ 누르면 기다리고 있는 pane으로 바로 갑니다.
54
50
 
55
- Go 또는 소스 코드로 직접 설치하는 방법, GitHub Release와 패키징에 관한
56
- 내용은 [설치 안내](docs/install.md)를 참고하세요.
51
+ <p align="center">
52
+ <img src="docs/assets/projmux-ai-attention-ko.gif" alt="projmux 알림함: 대화 도중 알림이 도착하면 그 알림을 낸 pane으로 바로 이동합니다" width="820">
53
+ </p>
57
54
 
58
- ## 빠른 시작
55
+ ## 여러 에이전트를 나란히
59
56
 
60
- 독립된 projmux용 tmux 환경을 엽니다.
57
+ 하나에 shell, Codex, Claude Code를 함께 띄워 둘 수 있습니다. 에이전트가 다른
58
+ 에이전트를 열 때도 사람이 쓰는 것과 같은 CLI를 씁니다.
61
59
 
62
60
  ```sh
63
- projmux shell
61
+ projmux create claude --project mobile-client -- "마이그레이션 계획 초안을 잡아줘."
64
62
  ```
65
63
 
66
- projmux 안에서는 다음 키를 사용합니다.
67
-
68
- - `Alt-1`: 프로젝트 사이드바를 엽니다.
69
- - `Alt-2`: 알림 목록을 엽니다.
70
- - `Alt-3`: 최근 창 목록(`Recent Windows`)을 엽니다.
71
- - `Alt-4`: 이어서 열 AI 세션을 선택합니다.
72
- - `Alt-5`: 설정을 엽니다.
73
- - `Alt-7`: 새 AI 분할 창을 선택합니다.
74
-
75
- `Alt-1`부터 `Alt-5`까지는 별도 설정 없이 쓸 수 있는 기본 키입니다. `Alt-7`도
76
- 기본으로 제공되며 설정에서 바꿀 수 있습니다. 전체 키 구성은
77
- [터미널 키 설정](docs/keybindings.md)을 참고하세요.
78
-
79
- 키가 동작하지 않는다면 macOS 배포본의 `projmux shell`에서는 접근성 권한을
80
- 한 번 승인하세요. 이후 물리 키 어댑터가 자동으로 동작합니다. 그 밖의
81
- 환경에서는 tmux 밖에서 `projmux setup`을 실행한 다음, 지원되는 터미널에
82
- `projmux setup terminal [terminal] --apply`를 적용하세요.
83
-
84
- ## 일상 사용
85
-
86
- - 프로젝트 디렉터리를 고르면 projmux가 해당 tmux 세션을 만들거나 기존
87
- 세션을 다시 사용합니다.
88
- - 자주 쓰는 프로젝트는 `pin`으로 고정해 목록 위쪽에서 쉽게 찾을 수
89
- 있습니다.
90
- - 전환하기 전에 창(window)과 pane, Git 브랜치, AI pane
91
- 상태를 미리 확인할 수 있습니다.
92
- - 기존 Claude, Codex, Antigravity 대화를 이어서 열거나 projmux가 관리하는 새
93
- AI 분할 창을 만들 수 있습니다.
94
- - 권한 요청과 작업 완료 알림을 에이전트별로 묶어 보고, 확인이 필요한
95
- pane으로 곧바로 이동할 수 있습니다.
96
- - 읽기 전용 `Resource Inspector`에서 프로젝트, 창, pane별 CPU와 RSS 사용량을
97
- 확인할 수 있습니다. 현재 Linux/tmux 환경을 지원합니다.
98
- - 창과 pane 배치, shell 작업 디렉터리, 지원되는 AI 세션 재개 정보를
99
- `Session State` 스냅샷으로 저장하고 미리 볼 수 있습니다.
100
- - 환경 변수를 직접 편집하지 않고 `Settings > Project Picker`에서 검색 루트와
101
- 작업 디렉터리를 추가할 수 있습니다.
102
- - `Settings > About > Update` 또는 `projmux update apply`로 업그레이드할 수
103
- 있습니다.
104
-
105
64
  <p align="center">
106
- <img src="docs/assets/projmux-shell-sidebar.gif" alt="projmux 프로젝트 전환과 Codex 작업 흐름" width="820">
107
- <br>
108
- <em>프로젝트를 전환하고 Codex pane을 연 뒤 완료 알림을 확인합니다.</em>
65
+ <img src="docs/assets/projmux-three-pane-workflow-ko.gif" alt="projmux 3-pane 작업 흐름: shell, Codex, 그리고 Codex가 연 Claude Code pane" width="820">
109
66
  </p>
110
67
 
111
- `PROJMUX_PROJDIR`, 관리 루트, 알림, 사용량 추적에 관한 자세한 내용은
112
- [설정](docs/configuration.md) 참고하세요. 설치 방식에 따른 업데이트 동작은
113
- [업그레이드 안내](docs/upgrading.md)에 정리되어 있습니다.
114
-
115
- ## 멀티 에이전트 워크플로
68
+ 에이전트별 템플릿과 이름 규칙은
69
+ [AI 에이전트 바로가기](docs/ai-agent-shortcuts.md) 정리해 두었습니다.
116
70
 
117
- 하나의 tmux 창에 shell과 projmux가 관리하는 Claude, Codex, Antigravity pane을
118
- 나란히 띄울 수 있습니다. 프로젝트와 pane 사이를 오가며 작업해도 projmux가
119
- 에이전트별 권한 요청과 완료 알림을 그룹형 알림함에 모아 줍니다.
71
+ ## 밖에
120
72
 
121
- <p align="center">
122
- <img src="docs/assets/projmux-three-pane-workflow.gif" alt="projmux의 shell, Codex, Claude 3-pane 작업 흐름" width="820">
123
- <br>
124
- <em>shell, Codex, Claude pane을 오가며 서로 다른 작업을 진행하고, 완료 알림은 한곳에서 확인합니다.</em>
125
- </p>
73
+ - [Resource Inspector](docs/resource-attribution.md) — 프로젝트·창·pane별 CPU와
74
+ RSS를 실시간으로 봅니다.
75
+ - [Session State](docs/session-restore.md) — 창 배치와 작업 디렉터리를 스냅샷으로
76
+ 남깁니다.
77
+ - 검색 루트, 키 설정, 업데이트는 설정에서 바꿉니다.
126
78
 
127
- ## 에이전트 스킬 자동화
79
+ ## 요구 사항
128
80
 
129
- AI 도구에서도 같은 projmux 명령줄 도구(CLI) 호출해 projmux가 관리하는
130
- pane을 열고 작업 지시를 전달할 수 있습니다.
81
+ [Node.js](https://nodejs.org/) npm,
82
+ [tmux](https://github.com/tmux/tmux/wiki/Installing) 3.4 이상이 필요합니다.
83
+ 로컬 환경은 `projmux doctor`로 점검합니다. 읽기만 하고 아무것도 바꾸지 않습니다.
84
+ 앱이 아예 뜨지 않으면 [문제 해결](docs/troubleshooting.md)을 보세요.
131
85
 
132
- ```sh
133
- projmux create codex --placement right -- "Review the retry logic."
134
- ```
86
+ ## 문서
135
87
 
136
- Claude, Codex를 비롯한 여러 에이전트용 템플릿과 이름 규칙은
137
- [AI 에이전트 바로가기](docs/ai-agent-shortcuts.md) 정리되어 있습니다.
138
-
139
- ## 추가 문서
140
-
141
- - [설치 안내](docs/install.md)
142
- - [설정](docs/configuration.md)
143
- - [터미널 키 설정](docs/keybindings.md)
144
- - [AI 에이전트 바로가기](docs/ai-agent-shortcuts.md)
145
- - [CLI 명령어](docs/cli.md) — 커맨드 매니페스트에서 생성됨
146
- - [CLI 사용 가이드](docs/cli-guide.md)
147
- - [상태 표시줄](docs/statusbar.md)
148
- - [훅](docs/hooks.md)
149
- - [사용량 추적](docs/usage-tracking.md)
150
- - [Resource Inspector](docs/resource-attribution.md)
151
- - [Session State](docs/session-restore.md)
152
- - [운영 진단](docs/operational-diagnostics.md)
153
- - [에이전트 작업 흐름](docs/agent-workflow.md)
88
+ [설치 안내](docs/install.md) ·
89
+ [설정](docs/configuration.md) ·
90
+ [업그레이드](docs/upgrading.md) ·
91
+ [CLI 명령어](docs/cli.md) ·
92
+ [CLI 사용 가이드](docs/cli-guide.md) ·
93
+ [상태 표시줄](docs/statusbar.md) ·
94
+ [](docs/hooks.md) ·
95
+ [사용량 추적](docs/usage-tracking.md) ·
96
+ [운영 진단](docs/operational-diagnostics.md) ·
97
+ [에이전트 작업 흐름](docs/agent-workflow.md)
154
98
 
155
99
  ## 개발
156
100
 
@@ -161,9 +105,9 @@ make fix
161
105
  make test
162
106
  ```
163
107
 
164
- 기여자를 위한 자세한 내용은 [테스트](docs/testing.md),
165
- [구조](docs/architecture.md), [저장소 구성](docs/repo-layout.md) 참고하세요.
108
+ 자세한 내용은 [테스트](docs/testing.md), [구조](docs/architecture.md),
109
+ [저장소 구성](docs/repo-layout.md) 있습니다.
166
110
 
167
111
  ## 라이선스
168
112
 
169
- MIT. [LICENSE](LICENSE)를 참고하세요.
113
+ MIT. [LICENSE](LICENSE)를 보세요.
package/README.md CHANGED
@@ -7,7 +7,7 @@
7
7
  <p align="center">
8
8
  <strong>A tmux-native workspace for multi-agent AI development.</strong>
9
9
  <br>
10
- <em>Managed Claude Code, Codex, and Antigravity panes with hook-driven attention and agent-aware session resume.</em>
10
+ <em>Run Codex, Claude Code, and Antigravity side by side in one workspace.</em>
11
11
  </p>
12
12
 
13
13
  <p align="center">
@@ -23,138 +23,77 @@ projmux shell
23
23
  ```
24
24
 
25
25
  <p align="center">
26
- <img src="docs/assets/projmux-ai-attention.gif" alt="projmux AI session resume, agent permission, and grouped notification workflow" width="820">
27
- <br>
28
- <em>Resume an existing AI session, keep working in another project, then return through grouped notifications when the agent needs approval.</em>
26
+ <img src="docs/assets/projmux-overview.gif" alt="projmux workspace: switch projects, pick a session to resume, and continue it next to a running agent" width="820">
29
27
  </p>
30
28
 
31
- ## Why
32
-
33
- Six tmux windows. Each one is running Claude Code, Codex, or Antigravity on a
34
- different repo. Three are idle. One is waiting on a permission prompt. One
35
- crashed an hour ago and you have no idea which.
29
+ ## Keys
36
30
 
37
- projmux manages Claude Code, Codex, and Antigravity hook integrations, including
38
- Antigravity's hook/statusline wiring, shows live per-pane state in the tmux
39
- status bar, and lets one keystroke take you to the pane that actually needs
40
- you. It also remembers each agent's resume id, so after a reboot every pane
41
- comes back as the *same* conversation — not a fresh one.
31
+ - `Alt-1` projects
32
+ - `Alt-2` notifications
33
+ - `Alt-3` recent windows
34
+ - `Alt-4` resume an AI session
35
+ - `Alt-5` settings
36
+ - `Alt-7` new AI split
42
37
 
43
- ## Requirements
38
+ `Alt-1`–`Alt-5` work with no configuration. See
39
+ [Terminal Keybindings](docs/keybindings.md) to remap them.
44
40
 
45
- - [Node.js](https://nodejs.org/) and npm, for the main install path.
46
- - [tmux](https://github.com/tmux/tmux/wiki/Installing) **3.4 or newer**.
41
+ ## Pick up a conversation
47
42
 
48
- Run `projmux doctor` after installing for read-only local runtime diagnostics.
43
+ `Alt-4` lists your Codex, Claude Code, and Antigravity sessions. Choose one and
44
+ it opens where you left it, as the same conversation.
49
45
 
50
- ## Install
46
+ ## Get called back
51
47
 
52
- The npm package shown above installs a small Node.js shim plus the matching
53
- projmux binary for Linux and macOS on x64 or arm64. npm is the primary
54
- distribution path for normal users.
48
+ Agent permission requests and completions land in one grouped inbox. `Alt-2`
49
+ takes you to the pane that is waiting.
55
50
 
56
- Verify with `projmux version`. Then `projmux doctor` provides read-only local
57
- runtime diagnostics (tmux 3.4+ and hook integration health).
58
- If installation succeeds but the app cannot enter or npm reports an incomplete
59
- optional dependency, follow [Troubleshooting](docs/troubleshooting.md).
60
-
61
- Manual Go, source checkout, GitHub Release, and packaging details live in
62
- [Install](docs/install.md).
51
+ <p align="center">
52
+ <img src="docs/assets/projmux-ai-attention.gif" alt="projmux attention queue: a notification lands mid-conversation, and one key takes you to the pane that raised it" width="820">
53
+ </p>
63
54
 
64
- ## Quick Start
55
+ ## Run agents in parallel
65
56
 
66
- Open the isolated projmux tmux app:
57
+ Keep a shell, Codex, and Claude Code in the same window. Agents can open other
58
+ agents through the same CLI you use:
67
59
 
68
60
  ```sh
69
- projmux shell
61
+ projmux create claude --project mobile-client -- "Draft the migration plan."
70
62
  ```
71
63
 
72
- Inside the app:
73
-
74
- - `Alt-1` opens the project sidebar.
75
- - `Alt-2` opens the notification list.
76
- - `Alt-3` opens Recent Windows.
77
- - `Alt-4` opens the AI resume session picker.
78
- - `Alt-5` opens settings.
79
- - `Alt-7` opens the AI split picker.
80
-
81
- The `Alt-1` through `Alt-5` launch keys are the guaranteed zero-config
82
- defaults. `Alt-7` is an additional editable built-in default. Add aliases in
83
- Settings > Keybindings or `~/.config/projmux/keymap.toml`. If a key does not
84
- fire, the Darwin release uses a native physical-key adapter automatically
85
- inside `projmux shell` after one-time macOS Accessibility approval. On other
86
- paths, run `projmux setup` outside tmux, then use
87
- `projmux setup terminal [terminal] --apply` for supported terminal delivery
88
- fallbacks.
89
-
90
- ## Day-To-Day Use
91
-
92
- - Pick a project directory and projmux creates or reuses its tmux session.
93
- - Pin important projects so they stay easy to reach.
94
- - Preview windows, panes, git branch, and AI pane state
95
- before switching.
96
- - Resume an existing Claude, Codex, or Antigravity conversation, or open a new
97
- managed AI split.
98
- - Review grouped permission and completion events, then jump directly to the
99
- pane that needs attention.
100
- - Inspect live project, window, and pane CPU/RSS with the read-only Resource
101
- Inspector on Linux/tmux.
102
- - Save and inspect Session State snapshots for window/pane layouts, shell cwd,
103
- and supported AI resumes.
104
- - Use Settings > Project Picker to add roots and workdirs without editing env
105
- vars.
106
- - Use Settings > About > Update or `projmux update apply` to upgrade.
107
-
108
64
  <p align="center">
109
- <img src="docs/assets/projmux-shell-sidebar.gif" alt="projmux project switch and managed Codex workflow" width="820">
110
- <br>
111
- <em>Switch projects, launch a managed Codex pane, and review its completion notification.</em>
65
+ <img src="docs/assets/projmux-three-pane-workflow.gif" alt="projmux three-pane workflow: a shell, Codex, and a Claude Code pane Codex opened" width="820">
112
66
  </p>
113
67
 
114
- For detailed configuration, including `PROJMUX_PROJDIR`, managed roots,
115
- notifications, and usage tracking, see [Configuration](docs/configuration.md).
116
- For update behavior by installer type, see [Upgrading](docs/upgrading.md).
117
-
118
- ## Multi-Agent Workflow
119
-
120
- Keep a shell and managed Claude, Codex, or Antigravity panes visible in the
121
- same tmux window. Move between projects and panes while projmux collects agent
122
- permission and completion events in one grouped inbox.
68
+ Templates and naming conventions are in
69
+ [AI Agent Shortcuts](docs/ai-agent-shortcuts.md).
123
70
 
124
- <p align="center">
125
- <img src="docs/assets/projmux-three-pane-workflow.gif" alt="projmux shell, Codex, and Claude three-pane workflow" width="820">
126
- <br>
127
- <em>Move across shell, Codex, and Claude panes while independent tasks report back through one notification queue.</em>
128
- </p>
71
+ ## Also in the app
129
72
 
130
- ## Automation With Agent Skills
73
+ - Live per-project, per-window, and per-pane CPU/RSS in the
74
+ [Resource Inspector](docs/resource-attribution.md).
75
+ - Layout and cwd snapshots in [Session State](docs/session-restore.md).
76
+ - Search roots, keybindings, and updates in Settings.
131
77
 
132
- AI tools can invoke the same projmux CLI to open a managed pane and deliver a
133
- prompt:
78
+ ## Requirements
134
79
 
135
- ```sh
136
- projmux create codex --placement right -- "Review the retry logic."
137
- ```
80
+ [Node.js](https://nodejs.org/) and npm, plus
81
+ [tmux](https://github.com/tmux/tmux/wiki/Installing) 3.4 or newer. Run
82
+ `projmux doctor` for read-only local diagnostics, or
83
+ [Troubleshooting](docs/troubleshooting.md) if the app will not start.
138
84
 
139
- Templates and naming conventions for Claude, Codex, and other agents are in
140
- [AI Agent Shortcuts](docs/ai-agent-shortcuts.md).
85
+ ## Docs
141
86
 
142
- ## More Docs
143
-
144
- - [Install](docs/install.md)
145
- - [Configuration](docs/configuration.md)
146
- - [Terminal Keybindings](docs/keybindings.md)
147
- - [AI Agent Shortcuts](docs/ai-agent-shortcuts.md)
148
- - [CLI Reference](docs/cli.md) — generated from the command manifest
149
- - [CLI Task Guide](docs/cli-guide.md)
150
- - [Statusbar](docs/statusbar.md)
151
- - [Hooks](docs/hooks.md)
152
- - [Usage tracking](docs/usage-tracking.md)
153
- - [Resource Inspector](docs/resource-attribution.md)
154
- - [Session State](docs/session-restore.md)
155
- - [Operational Diagnostics](docs/operational-diagnostics.md)
156
- - [Troubleshooting](docs/troubleshooting.md)
157
- - [Agent Workflow](docs/agent-workflow.md)
87
+ [Install](docs/install.md) ·
88
+ [Configuration](docs/configuration.md) ·
89
+ [Upgrading](docs/upgrading.md) ·
90
+ [CLI Reference](docs/cli.md) ·
91
+ [CLI Task Guide](docs/cli-guide.md) ·
92
+ [Statusbar](docs/statusbar.md) ·
93
+ [Hooks](docs/hooks.md) ·
94
+ [Usage tracking](docs/usage-tracking.md) ·
95
+ [Operational Diagnostics](docs/operational-diagnostics.md) ·
96
+ [Agent Workflow](docs/agent-workflow.md)
158
97
 
159
98
  ## Development
160
99
 
@@ -166,7 +105,7 @@ make test
166
105
  ```
167
106
 
168
107
  See [Testing](docs/testing.md), [Architecture](docs/architecture.md), and
169
- [Repo Layout](docs/repo-layout.md) for contributor details.
108
+ [Repo Layout](docs/repo-layout.md).
170
109
 
171
110
  ## License
172
111