projmux 0.10.0 → 0.11.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
@@ -4,38 +4,43 @@
4
4
  <img src="docs/assets/projmux-icon.png" alt="projmux icon" width="112">
5
5
  </p>
6
6
 
7
- 프로젝트별 tmux workspace를 빠르게 전환하고, Claude Code, Codex,
8
- Antigravity pane의 preview/status context/attention까지 함께 다루는 터미널
9
- workspace 도구입니다.
10
-
11
- [![npm version](https://img.shields.io/npm/v/projmux?logo=npm)](https://www.npmjs.com/package/projmux)
12
- [![CI](https://github.com/crevissepartners/projmux/actions/workflows/ci.yml/badge.svg)](https://github.com/crevissepartners/projmux/actions/workflows/ci.yml)
7
+ <p align="center">
8
+ <strong>여러 AI 에이전트를 함께 쓰는 tmux 기반 개발 작업 공간.</strong>
9
+ <br>
10
+ <em>Claude Code, Codex, Antigravity pane을 한곳에서 운영하고, 에이전트가 권한을 요청하거나 작업을 마치면 바로 알려 줍니다.</em>
11
+ </p>
13
12
 
14
- [English README](README.md)
13
+ <p align="center">
14
+ <a href="https://www.npmjs.com/package/projmux"><img src="https://img.shields.io/npm/v/projmux?logo=npm" alt="npm version"></a>
15
+ <a href="https://github.com/crevissepartners/projmux/actions/workflows/ci.yml"><img src="https://github.com/crevissepartners/projmux/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
16
+ <a href="LICENSE"><img src="https://img.shields.io/github/license/crevissepartners/projmux" alt="MIT license"></a>
17
+ <a href="README.md"><img src="https://img.shields.io/badge/lang-English-blue" alt="English README"></a>
18
+ </p>
15
19
 
16
20
  <p align="center">
17
- <img src="docs/assets/projmux-ai-attention.gif" alt="projmux AI attention demo" width="820">
21
+ <img src="docs/assets/projmux-ai-attention.gif" alt="projmux AI 세션 재개, 권한 요청, 그룹형 알림 흐름" width="820">
18
22
  <br>
19
- <em>기존 AI session을 이어서 열고 다른 project에서 작업하다가, permission이 필요하면 notification list에서 managed pane으로 돌아갑니다.</em>
23
+ <em>기존 AI 세션을 이어서 열고 다른 프로젝트에서 작업하다가, 에이전트가 승인을 요청하면 그룹형 알림에서 확인하고 해당 작업 pane으로 돌아갑니다.</em>
20
24
  </p>
21
25
 
22
- ## 무엇인가
26
+ ## projmux란?
23
27
 
24
- `projmux`는 프로젝트 디렉터리를 오래 유지되는 tmux session으로 연결합니다.
25
- 프로젝트 전환, session preview, AI split 실행, tmux 안의 상태 표시를
26
- 키보드 중심 workspace 앱으로 묶습니다.
27
- Claude Code Codex hook event를 직접 수집하고, 수동으로 연결한 Antigravity
28
- hook/statusline event도 같은 notification 흐름으로 다룹니다.
28
+ `projmux`는 프로젝트 디렉터리마다 오래 유지되는 tmux 세션을 연결합니다.
29
+ 프로젝트 전환, 세션 미리보기, AI 분할 실행, 상태 표시를 키보드 중심의
30
+ 작업 공간 하나로 묶습니다.
31
+ Claude Code, Codex, Antigravity의 연동을 관리하고, 에이전트의 권한
32
+ 요청과 작업 완료 알림을 한곳에 모읍니다.
29
33
 
30
- 터미널 workspace를 명령으로 열고, 세트의 키로 project/window/pane,
31
- notification, settings 사이를 오가고 싶을 때 사용합니다.
34
+ 터미널 작업 공간을 명령 하나로 열고, 같은 조합으로 프로젝트와 tmux
35
+ 창, pane, 알림, 설정 사이를 빠르게 오가고 싶을 때 사용합니다.
32
36
 
33
37
  ## 요구 사항
34
38
 
35
39
  - [Node.js](https://nodejs.org/)와 npm: 기본 설치 경로에 필요합니다.
36
40
  - [tmux](https://github.com/tmux/tmux/wiki/Installing) **3.4 이상**.
37
41
 
38
- 설치 `projmux doctor`의 read-only 진단으로 로컬 runtime을 확인하세요.
42
+ 설치한 뒤에는 읽기 전용 점검 명령인 `projmux doctor`로 로컬 실행 환경을
43
+ 확인하세요.
39
44
 
40
45
  ## 설치
41
46
 
@@ -44,95 +49,108 @@ npm install -g projmux
44
49
  projmux version
45
50
  ```
46
51
 
47
- npm package는 작은 Node.js shim과 Linux/macOS x64/arm64용 projmux binary를
48
- 설치합니다. 일반 사용자의 기본 배포 경로는 npm입니다.
52
+ npm 패키지는 작은 Node.js 실행 연결부와 Linux/macOS x64·arm64용 projmux
53
+ 실행 파일을 함께 설치합니다. 일반 사용자에게는 npm 설치를 권장합니다.
49
54
 
50
- 수동 Go 설치, source checkout, GitHub Release, packaging 세부 사항은
51
- [Install](docs/install.md) 참고하세요.
55
+ Go 또는 소스 코드로 직접 설치하는 방법, GitHub Release 패키징에 관한
56
+ 내용은 [설치 안내](docs/install.md) 참고하세요.
52
57
 
53
58
  ## 빠른 시작
54
59
 
55
- 격리된 projmux tmux 앱을 엽니다:
60
+ 독립된 projmux tmux 환경을 엽니다.
56
61
 
57
62
  ```sh
58
63
  projmux shell
59
64
  ```
60
65
 
61
- 안에서:
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 분할 창을 선택합니다.
62
74
 
63
- - `Alt-1`: project sidebar.
64
- - `Alt-2`: notification list.
65
- - `Alt-3`: Recent Windows.
66
- - `Alt-4`: AI resume session picker.
67
- - `Alt-5`: settings.
68
- - `Alt-7`: AI split picker.
75
+ `Alt-1`부터 `Alt-5`까지는 별도 설정 없이 쓸 수 있는 기본 키입니다. `Alt-7`도
76
+ 기본으로 제공되며 설정에서 바꿀 수 있습니다. 전체 키 구성은
77
+ [터미널 설정](docs/keybindings.md)을 참고하세요.
69
78
 
70
- `Alt-1`부터 `Alt-5`까지는 zero-config 보장 기본값이고, `Alt-7`은 추가로
71
- 편집 가능한 built-in 기본값입니다. 전체 key map은
72
- [Terminal Keybindings](docs/keybindings.md)를 참고하세요. 키가 동작하지 않으면
73
- Darwin 배포본의 `projmux shell`에서는 macOS 접근성 권한을 한 번 승인하면
74
- 물리 키 어댑터가 자동으로 동작합니다. 그 밖의 경로에서는 tmux 밖에서
75
- `projmux setup`을 실행한 뒤, 지원 터미널에서는
76
- `projmux setup terminal [terminal] --apply`를 사용하세요.
79
+ 키가 동작하지 않는다면 macOS 배포본의 `projmux shell`에서는 접근성 권한을
80
+ 승인하세요. 이후 물리 어댑터가 자동으로 동작합니다. 그 밖의
81
+ 환경에서는 tmux 밖에서 `projmux setup`을 실행한 다음, 지원되는 터미널에
82
+ `projmux setup terminal [terminal] --apply`를 적용하세요.
77
83
 
78
84
  ## 일상 사용
79
85
 
80
- - project directory를 고르면 projmux가 tmux session을 만들거나 재사용합니다.
81
- - 중요한 project는 pin으로 고정합니다.
82
- - 전환 전에 window, pane, git branch, Kubernetes context, AI pane state를
83
- preview합니다.
84
- - 기존 Claude/Codex conversation을 resume하거나 managed AI split을 엽니다.
85
- - permission/completion event를 하나의 notification queue에서 확인하고 바로
86
- attention이 필요한 pane으로 이동합니다.
87
- - env var를 직접 편집하지 않고 Settings > Project Picker에서 root와 workdir을
88
- 추가할 있습니다.
89
- - Settings > About > Update 또는 `projmux update apply`로 업그레이드합니다.
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
+ 있습니다.
90
104
 
91
105
  <p align="center">
92
- <img src="docs/assets/projmux-shell-sidebar.gif" alt="projmux project 전환 managed Codex 데모" width="820">
106
+ <img src="docs/assets/projmux-shell-sidebar.gif" alt="projmux 프로젝트 전환과 Codex 작업 흐름" width="820">
93
107
  <br>
94
- <em>project를 전환하고 managed Codex pane을 연 뒤 completion notification을 확인합니다.</em>
108
+ <em>프로젝트를 전환하고 Codex pane을 연 뒤 완료 알림을 확인합니다.</em>
95
109
  </p>
96
110
 
97
- `PROJMUX_PROJDIR`, managed roots, notification, usage tracking 같은 자세한
98
- 설정은 [Configuration](docs/configuration.md)을 참고하세요. installer별 update
99
- 동작은 [Upgrading](docs/upgrading.md)에 있습니다.
111
+ `PROJMUX_PROJDIR`, 관리 루트, 알림, 사용량 추적에 관한 자세한 내용은
112
+ [설정](docs/configuration.md)을 참고하세요. 설치 방식에 따른 업데이트 동작은
113
+ [업그레이드 안내](docs/upgrading.md)에 정리되어 있습니다.
100
114
 
101
115
  ## 멀티 에이전트 워크플로
102
116
 
103
- 하나의 tmux window에 shell과 여러 managed agent를 함께 띄워 둡니다. pane을
104
- 이동하며 독립 작업을 시작하면 projmux가 permission/completion event를 하나의
105
- notification queue에 모읍니다.
117
+ 하나의 tmux 창에 shell과 projmux가 관리하는 Claude, Codex, Antigravity pane을
118
+ 나란히 띄울 있습니다. 프로젝트와 pane 사이를 오가며 작업해도 projmux가
119
+ 에이전트별 권한 요청과 완료 알림을 그룹형 알림함에 모아 줍니다.
106
120
 
107
121
  <p align="center">
108
- <img src="docs/assets/projmux-three-pane-workflow.gif" alt="projmux shell, Codex, Claude 3-pane workflow 데모" width="820">
122
+ <img src="docs/assets/projmux-three-pane-workflow.gif" alt="projmux shell, Codex, Claude 3-pane 작업 흐름" width="820">
109
123
  <br>
110
- <em>동일 폭의 shell, Codex, Claude pane을 이동하며 독립 작업의 완료 알림을 하나의 notification queue에서 확인합니다.</em>
124
+ <em>shell, Codex, Claude pane을 오가며 서로 다른 작업을 진행하고, 완료 알림은 한곳에서 확인합니다.</em>
111
125
  </p>
112
126
 
113
127
  ## 에이전트 스킬 자동화
114
128
 
115
- AI 도구도 같은 projmux CLI를 호출해 managed pane을 열고 prompt를 전달할 수
116
- 있습니다:
129
+ AI 도구에서도 같은 projmux 명령줄 도구(CLI)를 호출해 projmux가 관리하는
130
+ pane을 열고 작업 지시를 전달할 수 있습니다.
117
131
 
118
132
  ```sh
119
133
  projmux ai split --agent codex right -- "Review the retry logic."
120
134
  ```
121
135
 
122
- Claude, Codex 다른 agent용 template naming convention은
123
- [AI Agent Shortcuts](docs/ai-agent-shortcuts.md)에 정리되어 있습니다.
136
+ Claude, Codex 비롯한 여러 에이전트용 템플릿과 이름 규칙은
137
+ [AI 에이전트 바로가기](docs/ai-agent-shortcuts.md)에 정리되어 있습니다.
124
138
 
125
139
  ## 추가 문서
126
140
 
127
- - [Install](docs/install.md)
128
- - [Configuration](docs/configuration.md)
129
- - [Terminal Keybindings](docs/keybindings.md)
130
- - [AI Agent Shortcuts](docs/ai-agent-shortcuts.md)
131
- - [CLI Reference](docs/cli.md)
132
- - [Statusbar](docs/statusbar.md)
133
- - [Hooks](docs/hooks.md)
134
- - [Usage tracking](docs/usage-tracking.md)
135
- - [Agent Workflow](docs/agent-workflow.md)
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)
136
154
 
137
155
  ## 개발
138
156
 
@@ -143,8 +161,8 @@ make fix
143
161
  make test
144
162
  ```
145
163
 
146
- 기여자용 세부 사항은 [Testing](docs/testing.md), [Architecture](docs/architecture.md),
147
- [Repo Layout](docs/repo-layout.md)을 참고하세요.
164
+ 기여자를 위한 자세한 내용은 [테스트](docs/testing.md),
165
+ [구조](docs/architecture.md), [저장소 구성](docs/repo-layout.md)을 참고하세요.
148
166
 
149
167
  ## 라이선스
150
168
 
package/README.md CHANGED
@@ -23,9 +23,9 @@ projmux shell
23
23
  ```
24
24
 
25
25
  <p align="center">
26
- <img src="docs/assets/projmux-ai-attention.gif" alt="projmux AI attention demo" width="820">
26
+ <img src="docs/assets/projmux-ai-attention.gif" alt="projmux AI session resume, agent permission, and grouped notification workflow" width="820">
27
27
  <br>
28
- <em>Resume an existing AI session, keep working in another project, then jump back when the managed pane needs permission.</em>
28
+ <em>Resume an existing AI session, keep working in another project, then return through grouped notifications when the agent needs approval.</em>
29
29
  </p>
30
30
 
31
31
  ## Why
@@ -34,8 +34,8 @@ Six tmux windows. Each one is running Claude Code, Codex, or Antigravity on a
34
34
  different repo. Three are idle. One is waiting on a permission prompt. One
35
35
  crashed an hour ago and you have no idea which.
36
36
 
37
- projmux ingests Claude Code and Codex hook events directly, accepts manually
38
- wired Antigravity hook/statusline events, shows live per-pane state in the tmux
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
39
  status bar, and lets one keystroke take you to the pane that actually needs
40
40
  you. It also remembers each agent's resume id, so after a reboot every pane
41
41
  comes back as the *same* conversation — not a fresh one.
@@ -89,18 +89,22 @@ fallbacks.
89
89
 
90
90
  - Pick a project directory and projmux creates or reuses its tmux session.
91
91
  - Pin important projects so they stay easy to reach.
92
- - Preview windows, panes, git branch, Kubernetes context, and AI pane state
92
+ - Preview windows, panes, git branch, and AI pane state
93
93
  before switching.
94
- - Resume an existing Claude or Codex conversation, or open a new managed AI
95
- split.
96
- - Review permission and completion events in one notification queue, then jump
97
- directly to the pane that needs attention.
94
+ - Resume an existing Claude, Codex, or Antigravity conversation, or open a new
95
+ managed AI split.
96
+ - Review grouped permission and completion events, then jump directly to the
97
+ pane that needs attention.
98
+ - Inspect live project, window, and pane CPU/RSS with the read-only Resource
99
+ Inspector on Linux/tmux.
100
+ - Save and inspect Session State snapshots for window/pane layouts, shell cwd,
101
+ and supported AI resumes.
98
102
  - Use Settings > Project Picker to add roots and workdirs without editing env
99
103
  vars.
100
104
  - Use Settings > About > Update or `projmux update apply` to upgrade.
101
105
 
102
106
  <p align="center">
103
- <img src="docs/assets/projmux-shell-sidebar.gif" alt="projmux project switch and managed Codex demo" width="820">
107
+ <img src="docs/assets/projmux-shell-sidebar.gif" alt="projmux project switch and managed Codex workflow" width="820">
104
108
  <br>
105
109
  <em>Switch projects, launch a managed Codex pane, and review its completion notification.</em>
106
110
  </p>
@@ -111,14 +115,14 @@ For update behavior by installer type, see [Upgrading](docs/upgrading.md).
111
115
 
112
116
  ## Multi-Agent Workflow
113
117
 
114
- Keep a shell and multiple managed agents visible in the same tmux window.
115
- Move between panes to start independent tasks while projmux collects their
116
- permission and completion events in one notification queue.
118
+ Keep a shell and managed Claude, Codex, or Antigravity panes visible in the
119
+ same tmux window. Move between projects and panes while projmux collects agent
120
+ permission and completion events in one grouped inbox.
117
121
 
118
122
  <p align="center">
119
- <img src="docs/assets/projmux-three-pane-workflow.gif" alt="projmux shell, Codex, and Claude 3-pane workflow demo" width="820">
123
+ <img src="docs/assets/projmux-three-pane-workflow.gif" alt="projmux shell, Codex, and Claude three-pane workflow" width="820">
120
124
  <br>
121
- <em>Move across equal-width shell, Codex, and Claude panes while independent tasks report back through one notification queue.</em>
125
+ <em>Move across shell, Codex, and Claude panes while independent tasks report back through one notification queue.</em>
122
126
  </p>
123
127
 
124
128
  ## Automation With Agent Skills
@@ -139,10 +143,14 @@ Templates and naming conventions for Claude, Codex, and other agents are in
139
143
  - [Configuration](docs/configuration.md)
140
144
  - [Terminal Keybindings](docs/keybindings.md)
141
145
  - [AI Agent Shortcuts](docs/ai-agent-shortcuts.md)
142
- - [CLI Reference](docs/cli.md)
146
+ - [CLI Reference](docs/cli.md) — generated from the command manifest
147
+ - [CLI Task Guide](docs/cli-guide.md)
143
148
  - [Statusbar](docs/statusbar.md)
144
149
  - [Hooks](docs/hooks.md)
145
150
  - [Usage tracking](docs/usage-tracking.md)
151
+ - [Resource Inspector](docs/resource-attribution.md)
152
+ - [Session State](docs/session-restore.md)
153
+ - [Operational Diagnostics](docs/operational-diagnostics.md)
146
154
  - [Agent Workflow](docs/agent-workflow.md)
147
155
 
148
156
  ## Development