overmux 0.0.6 → 0.0.8

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.
@@ -21,7 +21,7 @@ First you need to install the `overmux` CLI.
21
21
  Prerequisites:
22
22
 
23
23
  - [Node.js 22](https://nodejs.org/en/download) or newer
24
- - [pnpm 10](https://pnpm.io/installation) or newer
24
+ - [pnpm 10.5.0](https://pnpm.io/installation) or newer
25
25
 
26
26
  Install Overmux globally:
27
27
 
@@ -5,7 +5,8 @@ title: Install Overmux PWA
5
5
  Overmux is a [progressive web app (PWA)](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps), so you can install it on a mobile device. The installed app gets its own home screen icon and opens in a standalone window.
6
6
 
7
7
  <Callout type="warning">
8
- PWAs must be hosted on HTTPS. See [Choose an HTTPS setup](./400-secure-with-https/100-choose-an-https-setup.md).
8
+ PWAs must be hosted on HTTPS. See [Choose an HTTPS
9
+ setup](./400-secure-with-https/100-choose-an-https-setup.md).
9
10
  </Callout>
10
11
 
11
12
  ## Chrome on Android
@@ -90,3 +91,216 @@ Open your Overmux URL in Safari, select **Share**, and then select **Add to Home
90
91
  </p>
91
92
 
92
93
  Screenshots adapted from the [ntfy PWA installation guide](https://docs.ntfy.sh/subscribe/pwa/).
94
+ The eight image files are displayed unmodified, at reduced sizes. They match
95
+ [ntfy's documentation sources](https://github.com/binwiederhier/ntfy/tree/10cb6506f836dbb00bb77e3b52669f6ace37f555/docs/static/img)
96
+ and are used under the project's [Apache 2.0 license](https://github.com/binwiederhier/ntfy/blob/10cb6506f836dbb00bb77e3b52669f6ace37f555/LICENSE).
97
+ Copyright 2021 Philipp C. Heckel. This does not imply endorsement by ntfy or the browser vendors.
98
+
99
+ <details>
100
+ <summary>Screenshot license (Apache 2.0)</summary>
101
+
102
+ ```text
103
+ Apache License
104
+ Version 2.0, January 2004
105
+ http://www.apache.org/licenses/
106
+
107
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
108
+
109
+ 1. Definitions.
110
+
111
+ "License" shall mean the terms and conditions for use, reproduction,
112
+ and distribution as defined by Sections 1 through 9 of this document.
113
+
114
+ "Licensor" shall mean the copyright owner or entity authorized by
115
+ the copyright owner that is granting the License.
116
+
117
+ "Legal Entity" shall mean the union of the acting entity and all
118
+ other entities that control, are controlled by, or are under common
119
+ control with that entity. For the purposes of this definition,
120
+ "control" means (i) the power, direct or indirect, to cause the
121
+ direction or management of such entity, whether by contract or
122
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
123
+ outstanding shares, or (iii) beneficial ownership of such entity.
124
+
125
+ "You" (or "Your") shall mean an individual or Legal Entity
126
+ exercising permissions granted by this License.
127
+
128
+ "Source" form shall mean the preferred form for making modifications,
129
+ including but not limited to software source code, documentation
130
+ source, and configuration files.
131
+
132
+ "Object" form shall mean any form resulting from mechanical
133
+ transformation or translation of a Source form, including but
134
+ not limited to compiled object code, generated documentation,
135
+ and conversions to other media types.
136
+
137
+ "Work" shall mean the work of authorship, whether in Source or
138
+ Object form, made available under the License, as indicated by a
139
+ copyright notice that is included in or attached to the work
140
+ (an example is provided in the Appendix below).
141
+
142
+ "Derivative Works" shall mean any work, whether in Source or Object
143
+ form, that is based on (or derived from) the Work and for which the
144
+ editorial revisions, annotations, elaborations, or other modifications
145
+ represent, as a whole, an original work of authorship. For the purposes
146
+ of this License, Derivative Works shall not include works that remain
147
+ separable from, or merely link (or bind by name) to the interfaces of,
148
+ the Work and Derivative Works thereof.
149
+
150
+ "Contribution" shall mean any work of authorship, including
151
+ the original version of the Work and any modifications or additions
152
+ to that Work or Derivative Works thereof, that is intentionally
153
+ submitted to Licensor for inclusion in the Work by the copyright owner
154
+ or by an individual or Legal Entity authorized to submit on behalf of
155
+ the copyright owner. For the purposes of this definition, "submitted"
156
+ means any form of electronic, verbal, or written communication sent
157
+ to the Licensor or its representatives, including but not limited to
158
+ communication on electronic mailing lists, source code control systems,
159
+ and issue tracking systems that are managed by, or on behalf of, the
160
+ Licensor for the purpose of discussing and improving the Work, but
161
+ excluding communication that is conspicuously marked or otherwise
162
+ designated in writing by the copyright owner as "Not a Contribution."
163
+
164
+ "Contributor" shall mean Licensor and any individual or Legal Entity
165
+ on behalf of whom a Contribution has been received by Licensor and
166
+ subsequently incorporated within the Work.
167
+
168
+ 2. Grant of Copyright License. Subject to the terms and conditions of
169
+ this License, each Contributor hereby grants to You a perpetual,
170
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
171
+ copyright license to reproduce, prepare Derivative Works of,
172
+ publicly display, publicly perform, sublicense, and distribute the
173
+ Work and such Derivative Works in Source or Object form.
174
+
175
+ 3. Grant of Patent License. Subject to the terms and conditions of
176
+ this License, each Contributor hereby grants to You a perpetual,
177
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
178
+ (except as stated in this section) patent license to make, have made,
179
+ use, offer to sell, sell, import, and otherwise transfer the Work,
180
+ where such license applies only to those patent claims licensable
181
+ by such Contributor that are necessarily infringed by their
182
+ Contribution(s) alone or by combination of their Contribution(s)
183
+ with the Work to which such Contribution(s) was submitted. If You
184
+ institute patent litigation against any entity (including a
185
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
186
+ or a Contribution incorporated within the Work constitutes direct
187
+ or contributory patent infringement, then any patent licenses
188
+ granted to You under this License for that Work shall terminate
189
+ as of the date such litigation is filed.
190
+
191
+ 4. Redistribution. You may reproduce and distribute copies of the
192
+ Work or Derivative Works thereof in any medium, with or without
193
+ modifications, and in Source or Object form, provided that You
194
+ meet the following conditions:
195
+
196
+ (a) You must give any other recipients of the Work or
197
+ Derivative Works a copy of this License; and
198
+
199
+ (b) You must cause any modified files to carry prominent notices
200
+ stating that You changed the files; and
201
+
202
+ (c) You must retain, in the Source form of any Derivative Works
203
+ that You distribute, all copyright, patent, trademark, and
204
+ attribution notices from the Source form of the Work,
205
+ excluding those notices that do not pertain to any part of
206
+ the Derivative Works; and
207
+
208
+ (d) If the Work includes a "NOTICE" text file as part of its
209
+ distribution, then any Derivative Works that You distribute must
210
+ include a readable copy of the attribution notices contained
211
+ within such NOTICE file, excluding those notices that do not
212
+ pertain to any part of the Derivative Works, in at least one
213
+ of the following places: within a NOTICE text file distributed
214
+ as part of the Derivative Works; within the Source form or
215
+ documentation, if provided along with the Derivative Works; or,
216
+ within a display generated by the Derivative Works, if and
217
+ wherever such third-party notices normally appear. The contents
218
+ of the NOTICE file are for informational purposes only and
219
+ do not modify the License. You may add Your own attribution
220
+ notices within Derivative Works that You distribute, alongside
221
+ or as an addendum to the NOTICE text from the Work, provided
222
+ that such additional attribution notices cannot be construed
223
+ as modifying the License.
224
+
225
+ You may add Your own copyright statement to Your modifications and
226
+ may provide additional or different license terms and conditions
227
+ for use, reproduction, or distribution of Your modifications, or
228
+ for any such Derivative Works as a whole, provided Your use,
229
+ reproduction, and distribution of the Work otherwise complies with
230
+ the conditions stated in this License.
231
+
232
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
233
+ any Contribution intentionally submitted for inclusion in the Work
234
+ by You to the Licensor shall be under the terms and conditions of
235
+ this License, without any additional terms or conditions.
236
+ Notwithstanding the above, nothing herein shall supersede or modify
237
+ the terms of any separate license agreement you may have executed
238
+ with Licensor regarding such Contributions.
239
+
240
+ 6. Trademarks. This License does not grant permission to use the trade
241
+ names, trademarks, service marks, or product names of the Licensor,
242
+ except as required for reasonable and customary use in describing the
243
+ origin of the Work and reproducing the content of the NOTICE file.
244
+
245
+ 7. Disclaimer of Warranty. Unless required by applicable law or
246
+ agreed to in writing, Licensor provides the Work (and each
247
+ Contributor provides its Contributions) on an "AS IS" BASIS,
248
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
249
+ implied, including, without limitation, any warranties or conditions
250
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
251
+ PARTICULAR PURPOSE. You are solely responsible for determining the
252
+ appropriateness of using or redistributing the Work and assume any
253
+ risks associated with Your exercise of permissions under this License.
254
+
255
+ 8. Limitation of Liability. In no event and under no legal theory,
256
+ whether in tort (including negligence), contract, or otherwise,
257
+ unless required by applicable law (such as deliberate and grossly
258
+ negligent acts) or agreed to in writing, shall any Contributor be
259
+ liable to You for damages, including any direct, indirect, special,
260
+ incidental, or consequential damages of any character arising as a
261
+ result of this License or out of the use or inability to use the
262
+ Work (including but not limited to damages for loss of goodwill,
263
+ work stoppage, computer failure or malfunction, or any and all
264
+ other commercial damages or losses), even if such Contributor
265
+ has been advised of the possibility of such damages.
266
+
267
+ 9. Accepting Warranty or Additional Liability. While redistributing
268
+ the Work or Derivative Works thereof, You may choose to offer,
269
+ and charge a fee for, acceptance of support, warranty, indemnity,
270
+ or other liability obligations and/or rights consistent with this
271
+ License. However, in accepting such obligations, You may act only
272
+ on Your own behalf and on Your sole responsibility, not on behalf
273
+ of any other Contributor, and only if You agree to indemnify,
274
+ defend, and hold each Contributor harmless for any liability
275
+ incurred by, or claims asserted against, such Contributor by reason
276
+ of your accepting any such warranty or additional liability.
277
+
278
+ END OF TERMS AND CONDITIONS
279
+
280
+ APPENDIX: How to apply the Apache License to your work.
281
+
282
+ To apply the Apache License to your work, attach the following
283
+ boilerplate notice, with the fields enclosed by brackets "[]"
284
+ replaced with your own identifying information. (Don't include
285
+ the brackets!) The text should be enclosed in the appropriate
286
+ comment syntax for the file format. We also recommend that a
287
+ file or class name and description of purpose be included on the
288
+ same "printed page" as the copyright notice for easier
289
+ identification within third-party archives.
290
+
291
+ Copyright 2021 Philipp C. Heckel
292
+
293
+ Licensed under the Apache License, Version 2.0 (the "License");
294
+ you may not use this file except in compliance with the License.
295
+ You may obtain a copy of the License at
296
+
297
+ http://www.apache.org/licenses/LICENSE-2.0
298
+
299
+ Unless required by applicable law or agreed to in writing, software
300
+ distributed under the License is distributed on an "AS IS" BASIS,
301
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
302
+ See the License for the specific language governing permissions and
303
+ limitations under the License.
304
+ ```
305
+
306
+ </details>
@@ -10,6 +10,8 @@ overmux init
10
10
 
11
11
  The application is created in `$XDG_CONFIG_HOME/overmux` (default `~/.config/overmux`). See [storage locations](../300-storage-locations.md) for directory defaults and overrides.
12
12
 
13
- The command validates the toolchain before writing files. When Mise is installed, it must be [activated in the shell](https://mise.jdx.dev/getting-started.html#activate-mise); the generated `mise.toml` pins Node 22, pnpm 10, and the latest published Overmux version. Without Mise, pnpm 10 or newer must already be available and `mise.toml` is omitted.
13
+ The command validates the toolchain before writing files. When Mise is installed, it must be [activated in the shell](https://mise.jdx.dev/getting-started.html#activate-mise); the generated `mise.toml` pins Node 22, pnpm 10, and the latest published Overmux version. Without Mise, pnpm 10.5.0 or newer must already be available and `mise.toml` is omitted.
14
14
 
15
15
  The initializer pins the exact latest published `overmux` version in `package.json`, installs dependencies, generates `pnpm-lock.yaml`, and runs `overmux check`. Existing scaffold files cause the command to fail without changing them. Unrelated files are preserved.
16
+
17
+ The generated `pnpm-workspace.yaml` allows only `node-pty` to run dependency build scripts, including when you later add `@overmux/tmux`. This approval is project-local; global pnpm settings are unchanged. On Linux, building `node-pty` still requires `node-gyp`, Python, and a native compiler toolchain, which `overmux init` does not install.
@@ -21,7 +21,7 @@ First you need to install the `overmux` CLI.
21
21
  Prerequisites:
22
22
 
23
23
  - [Node.js 22](https://nodejs.org/en/download) or newer
24
- - [pnpm 10](https://pnpm.io/installation) or newer
24
+ - [pnpm 10.5.0](https://pnpm.io/installation) or newer
25
25
 
26
26
  Install Overmux globally:
27
27
 
@@ -5,7 +5,8 @@ title: Install Overmux PWA
5
5
  Overmux is a [progressive web app (PWA)](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps), so you can install it on a mobile device. The installed app gets its own home screen icon and opens in a standalone window.
6
6
 
7
7
  <Callout type="warning">
8
- PWAs must be hosted on HTTPS. See [Choose an HTTPS setup](./400-secure-with-https/100-choose-an-https-setup.md).
8
+ PWAs must be hosted on HTTPS. See [Choose an HTTPS
9
+ setup](./400-secure-with-https/100-choose-an-https-setup.md).
9
10
  </Callout>
10
11
 
11
12
  ## Chrome on Android
@@ -90,3 +91,216 @@ Open your Overmux URL in Safari, select **Share**, and then select **Add to Home
90
91
  </p>
91
92
 
92
93
  Screenshots adapted from the [ntfy PWA installation guide](https://docs.ntfy.sh/subscribe/pwa/).
94
+ The eight image files are displayed unmodified, at reduced sizes. They match
95
+ [ntfy's documentation sources](https://github.com/binwiederhier/ntfy/tree/10cb6506f836dbb00bb77e3b52669f6ace37f555/docs/static/img)
96
+ and are used under the project's [Apache 2.0 license](https://github.com/binwiederhier/ntfy/blob/10cb6506f836dbb00bb77e3b52669f6ace37f555/LICENSE).
97
+ Copyright 2021 Philipp C. Heckel. This does not imply endorsement by ntfy or the browser vendors.
98
+
99
+ <details>
100
+ <summary>Screenshot license (Apache 2.0)</summary>
101
+
102
+ ```text
103
+ Apache License
104
+ Version 2.0, January 2004
105
+ http://www.apache.org/licenses/
106
+
107
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
108
+
109
+ 1. Definitions.
110
+
111
+ "License" shall mean the terms and conditions for use, reproduction,
112
+ and distribution as defined by Sections 1 through 9 of this document.
113
+
114
+ "Licensor" shall mean the copyright owner or entity authorized by
115
+ the copyright owner that is granting the License.
116
+
117
+ "Legal Entity" shall mean the union of the acting entity and all
118
+ other entities that control, are controlled by, or are under common
119
+ control with that entity. For the purposes of this definition,
120
+ "control" means (i) the power, direct or indirect, to cause the
121
+ direction or management of such entity, whether by contract or
122
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
123
+ outstanding shares, or (iii) beneficial ownership of such entity.
124
+
125
+ "You" (or "Your") shall mean an individual or Legal Entity
126
+ exercising permissions granted by this License.
127
+
128
+ "Source" form shall mean the preferred form for making modifications,
129
+ including but not limited to software source code, documentation
130
+ source, and configuration files.
131
+
132
+ "Object" form shall mean any form resulting from mechanical
133
+ transformation or translation of a Source form, including but
134
+ not limited to compiled object code, generated documentation,
135
+ and conversions to other media types.
136
+
137
+ "Work" shall mean the work of authorship, whether in Source or
138
+ Object form, made available under the License, as indicated by a
139
+ copyright notice that is included in or attached to the work
140
+ (an example is provided in the Appendix below).
141
+
142
+ "Derivative Works" shall mean any work, whether in Source or Object
143
+ form, that is based on (or derived from) the Work and for which the
144
+ editorial revisions, annotations, elaborations, or other modifications
145
+ represent, as a whole, an original work of authorship. For the purposes
146
+ of this License, Derivative Works shall not include works that remain
147
+ separable from, or merely link (or bind by name) to the interfaces of,
148
+ the Work and Derivative Works thereof.
149
+
150
+ "Contribution" shall mean any work of authorship, including
151
+ the original version of the Work and any modifications or additions
152
+ to that Work or Derivative Works thereof, that is intentionally
153
+ submitted to Licensor for inclusion in the Work by the copyright owner
154
+ or by an individual or Legal Entity authorized to submit on behalf of
155
+ the copyright owner. For the purposes of this definition, "submitted"
156
+ means any form of electronic, verbal, or written communication sent
157
+ to the Licensor or its representatives, including but not limited to
158
+ communication on electronic mailing lists, source code control systems,
159
+ and issue tracking systems that are managed by, or on behalf of, the
160
+ Licensor for the purpose of discussing and improving the Work, but
161
+ excluding communication that is conspicuously marked or otherwise
162
+ designated in writing by the copyright owner as "Not a Contribution."
163
+
164
+ "Contributor" shall mean Licensor and any individual or Legal Entity
165
+ on behalf of whom a Contribution has been received by Licensor and
166
+ subsequently incorporated within the Work.
167
+
168
+ 2. Grant of Copyright License. Subject to the terms and conditions of
169
+ this License, each Contributor hereby grants to You a perpetual,
170
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
171
+ copyright license to reproduce, prepare Derivative Works of,
172
+ publicly display, publicly perform, sublicense, and distribute the
173
+ Work and such Derivative Works in Source or Object form.
174
+
175
+ 3. Grant of Patent License. Subject to the terms and conditions of
176
+ this License, each Contributor hereby grants to You a perpetual,
177
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
178
+ (except as stated in this section) patent license to make, have made,
179
+ use, offer to sell, sell, import, and otherwise transfer the Work,
180
+ where such license applies only to those patent claims licensable
181
+ by such Contributor that are necessarily infringed by their
182
+ Contribution(s) alone or by combination of their Contribution(s)
183
+ with the Work to which such Contribution(s) was submitted. If You
184
+ institute patent litigation against any entity (including a
185
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
186
+ or a Contribution incorporated within the Work constitutes direct
187
+ or contributory patent infringement, then any patent licenses
188
+ granted to You under this License for that Work shall terminate
189
+ as of the date such litigation is filed.
190
+
191
+ 4. Redistribution. You may reproduce and distribute copies of the
192
+ Work or Derivative Works thereof in any medium, with or without
193
+ modifications, and in Source or Object form, provided that You
194
+ meet the following conditions:
195
+
196
+ (a) You must give any other recipients of the Work or
197
+ Derivative Works a copy of this License; and
198
+
199
+ (b) You must cause any modified files to carry prominent notices
200
+ stating that You changed the files; and
201
+
202
+ (c) You must retain, in the Source form of any Derivative Works
203
+ that You distribute, all copyright, patent, trademark, and
204
+ attribution notices from the Source form of the Work,
205
+ excluding those notices that do not pertain to any part of
206
+ the Derivative Works; and
207
+
208
+ (d) If the Work includes a "NOTICE" text file as part of its
209
+ distribution, then any Derivative Works that You distribute must
210
+ include a readable copy of the attribution notices contained
211
+ within such NOTICE file, excluding those notices that do not
212
+ pertain to any part of the Derivative Works, in at least one
213
+ of the following places: within a NOTICE text file distributed
214
+ as part of the Derivative Works; within the Source form or
215
+ documentation, if provided along with the Derivative Works; or,
216
+ within a display generated by the Derivative Works, if and
217
+ wherever such third-party notices normally appear. The contents
218
+ of the NOTICE file are for informational purposes only and
219
+ do not modify the License. You may add Your own attribution
220
+ notices within Derivative Works that You distribute, alongside
221
+ or as an addendum to the NOTICE text from the Work, provided
222
+ that such additional attribution notices cannot be construed
223
+ as modifying the License.
224
+
225
+ You may add Your own copyright statement to Your modifications and
226
+ may provide additional or different license terms and conditions
227
+ for use, reproduction, or distribution of Your modifications, or
228
+ for any such Derivative Works as a whole, provided Your use,
229
+ reproduction, and distribution of the Work otherwise complies with
230
+ the conditions stated in this License.
231
+
232
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
233
+ any Contribution intentionally submitted for inclusion in the Work
234
+ by You to the Licensor shall be under the terms and conditions of
235
+ this License, without any additional terms or conditions.
236
+ Notwithstanding the above, nothing herein shall supersede or modify
237
+ the terms of any separate license agreement you may have executed
238
+ with Licensor regarding such Contributions.
239
+
240
+ 6. Trademarks. This License does not grant permission to use the trade
241
+ names, trademarks, service marks, or product names of the Licensor,
242
+ except as required for reasonable and customary use in describing the
243
+ origin of the Work and reproducing the content of the NOTICE file.
244
+
245
+ 7. Disclaimer of Warranty. Unless required by applicable law or
246
+ agreed to in writing, Licensor provides the Work (and each
247
+ Contributor provides its Contributions) on an "AS IS" BASIS,
248
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
249
+ implied, including, without limitation, any warranties or conditions
250
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
251
+ PARTICULAR PURPOSE. You are solely responsible for determining the
252
+ appropriateness of using or redistributing the Work and assume any
253
+ risks associated with Your exercise of permissions under this License.
254
+
255
+ 8. Limitation of Liability. In no event and under no legal theory,
256
+ whether in tort (including negligence), contract, or otherwise,
257
+ unless required by applicable law (such as deliberate and grossly
258
+ negligent acts) or agreed to in writing, shall any Contributor be
259
+ liable to You for damages, including any direct, indirect, special,
260
+ incidental, or consequential damages of any character arising as a
261
+ result of this License or out of the use or inability to use the
262
+ Work (including but not limited to damages for loss of goodwill,
263
+ work stoppage, computer failure or malfunction, or any and all
264
+ other commercial damages or losses), even if such Contributor
265
+ has been advised of the possibility of such damages.
266
+
267
+ 9. Accepting Warranty or Additional Liability. While redistributing
268
+ the Work or Derivative Works thereof, You may choose to offer,
269
+ and charge a fee for, acceptance of support, warranty, indemnity,
270
+ or other liability obligations and/or rights consistent with this
271
+ License. However, in accepting such obligations, You may act only
272
+ on Your own behalf and on Your sole responsibility, not on behalf
273
+ of any other Contributor, and only if You agree to indemnify,
274
+ defend, and hold each Contributor harmless for any liability
275
+ incurred by, or claims asserted against, such Contributor by reason
276
+ of your accepting any such warranty or additional liability.
277
+
278
+ END OF TERMS AND CONDITIONS
279
+
280
+ APPENDIX: How to apply the Apache License to your work.
281
+
282
+ To apply the Apache License to your work, attach the following
283
+ boilerplate notice, with the fields enclosed by brackets "[]"
284
+ replaced with your own identifying information. (Don't include
285
+ the brackets!) The text should be enclosed in the appropriate
286
+ comment syntax for the file format. We also recommend that a
287
+ file or class name and description of purpose be included on the
288
+ same "printed page" as the copyright notice for easier
289
+ identification within third-party archives.
290
+
291
+ Copyright 2021 Philipp C. Heckel
292
+
293
+ Licensed under the Apache License, Version 2.0 (the "License");
294
+ you may not use this file except in compliance with the License.
295
+ You may obtain a copy of the License at
296
+
297
+ http://www.apache.org/licenses/LICENSE-2.0
298
+
299
+ Unless required by applicable law or agreed to in writing, software
300
+ distributed under the License is distributed on an "AS IS" BASIS,
301
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
302
+ See the License for the specific language governing permissions and
303
+ limitations under the License.
304
+ ```
305
+
306
+ </details>
@@ -10,6 +10,8 @@ overmux init
10
10
 
11
11
  The application is created in `$XDG_CONFIG_HOME/overmux` (default `~/.config/overmux`). See [storage locations](../300-storage-locations.md) for directory defaults and overrides.
12
12
 
13
- The command validates the toolchain before writing files. When Mise is installed, it must be [activated in the shell](https://mise.jdx.dev/getting-started.html#activate-mise); the generated `mise.toml` pins Node 22, pnpm 10, and the latest published Overmux version. Without Mise, pnpm 10 or newer must already be available and `mise.toml` is omitted.
13
+ The command validates the toolchain before writing files. When Mise is installed, it must be [activated in the shell](https://mise.jdx.dev/getting-started.html#activate-mise); the generated `mise.toml` pins Node 22, pnpm 10, and the latest published Overmux version. Without Mise, pnpm 10.5.0 or newer must already be available and `mise.toml` is omitted.
14
14
 
15
15
  The initializer pins the exact latest published `overmux` version in `package.json`, installs dependencies, generates `pnpm-lock.yaml`, and runs `overmux check`. Existing scaffold files cause the command to fail without changing them. Unrelated files are preserved.
16
+
17
+ The generated `pnpm-workspace.yaml` allows only `node-pty` to run dependency build scripts, including when you later add `@overmux/tmux`. This approval is project-local; global pnpm settings are unchanged. On Linux, building `node-pty` still requires `node-gyp`, Python, and a native compiler toolchain, which `overmux init` does not install.
package/package.json CHANGED
@@ -1,6 +1,7 @@
1
1
  {
2
2
  "name": "overmux",
3
- "version": "0.0.6",
3
+ "version": "0.0.8",
4
+ "license": "MIT",
4
5
  "homepage": "https://github.com/richardgill/overmux",
5
6
  "repository": {
6
7
  "type": "git",
@@ -29,6 +30,7 @@
29
30
  }
30
31
  },
31
32
  "files": [
33
+ "LICENSE",
32
34
  "dist",
33
35
  "docs",
34
36
  "src",
@@ -51,8 +53,7 @@
51
53
  "typescript": "5.9.3",
52
54
  "web-push": "3.6.7",
53
55
  "ws": "8.21.3",
54
- "zod": "4.4.3",
55
- "@overmux/keybindings": "0.0.4"
56
+ "@overmux/keybindings": "0.0.6"
56
57
  },
57
58
  "devDependencies": {
58
59
  "@playwright/test": "1.58.0",
@@ -65,6 +66,7 @@
65
66
  "react-dom": "19.2.3",
66
67
  "vite": "8.2.2",
67
68
  "vitest": "4.1.10",
69
+ "zod": "4.6.5",
68
70
  "@overmux/ai-context": "0.0.1",
69
71
  "@overmux/lib": "0.0.1",
70
72
  "@overmux/shared": "0.0.1",
@@ -73,7 +75,8 @@
73
75
  "peerDependencies": {
74
76
  "react": "^19.0.0",
75
77
  "react-dom": "^19.0.0",
76
- "vite": "^8.2.1"
78
+ "vite": "^8.2.1",
79
+ "zod": "^4.6.5"
77
80
  },
78
81
  "publishConfig": {
79
82
  "access": "public"
@@ -7,6 +7,7 @@ export const initScaffoldPaths = [
7
7
  "mise.toml",
8
8
  "package.json",
9
9
  "pnpm-lock.yaml",
10
+ "pnpm-workspace.yaml",
10
11
  "overmux.config.ts",
11
12
  "src/server/index.ts",
12
13
  "src/ui/app.tsx",
@@ -31,6 +32,7 @@ const packageJson = (overmuxVersion: string) =>
31
32
  overmux: overmuxVersion,
32
33
  react: "^19.0.0",
33
34
  "react-dom": "^19.0.0",
35
+ zod: "^4.6.5",
34
36
  },
35
37
  devDependencies: {
36
38
  "@types/react": "^19.0.0",
@@ -65,6 +67,7 @@ pnpm = "10"
65
67
  }
66
68
  : {}),
67
69
  "package.json": packageJson(overmuxVersion),
70
+ "pnpm-workspace.yaml": "onlyBuiltDependencies:\n - node-pty\n",
68
71
  "overmux.config.ts": `import { defineOvermuxConfig } from "overmux";
69
72
 
70
73
  import server from "./src/server/index";
@@ -112,13 +112,21 @@ const detectToolchain = (dependencies: InitDependencies): InitToolchain => {
112
112
  }
113
113
 
114
114
  const pnpm = dependencies.runCommand("pnpm", ["--version"]);
115
- const major = Number.parseInt(pnpm.stdout.trim().split(".")[0] ?? "", 10);
116
- if (!commandExists(pnpm) || pnpm.status !== 0 || !Number.isFinite(major)) {
117
- throw new Error("pnpm 10 or newer is required when mise is not installed");
115
+ const [major = NaN, minor = NaN] = pnpm.stdout.trim().split(".").map(Number);
116
+ if (
117
+ !commandExists(pnpm) ||
118
+ pnpm.status !== 0 ||
119
+ !Number.isFinite(major) ||
120
+ !Number.isFinite(minor)
121
+ ) {
122
+ throw new Error(
123
+ "pnpm 10.5.0 or newer is required when mise is not installed",
124
+ );
118
125
  }
119
- if (major < 10) {
126
+ // pnpm 10.5 introduced build approval settings in pnpm-workspace.yaml.
127
+ if (major < 10 || (major === 10 && minor < 5)) {
120
128
  throw new Error(
121
- `pnpm 10 or newer is required when mise is not installed (found ${pnpm.stdout.trim()})`,
129
+ `pnpm 10.5.0 or newer is required when mise is not installed (found ${pnpm.stdout.trim()})`,
122
130
  );
123
131
  }
124
132
  return "pnpm";
@@ -161,8 +169,10 @@ const runProjectCommand = ({
161
169
  }
162
170
  };
163
171
 
172
+ // The generated workspace isolates the project and supplies its build allowlist.
173
+ // --ignore-workspace would also ignore that allowlist.
164
174
  const pnpmCommands = [
165
- ["install", "--ignore-workspace"],
175
+ ["install"],
166
176
  ["exec", "overmux", "check", "--config", "./overmux.config.ts"],
167
177
  ] as const;
168
178
 
@@ -4,6 +4,7 @@ import { init, parse } from "es-module-lexer";
4
4
  import {
5
5
  searchForWorkspaceRoot,
6
6
  type InlineConfig,
7
+ type Plugin,
7
8
  type UserConfig,
8
9
  type ViteDevServer,
9
10
  } from "vite";
@@ -216,6 +217,24 @@ export const watchTrustedFiles = async ({
216
217
  };
217
218
  };
218
219
 
220
+ // Android HMR connections were observed closing after ~60s without incoming data,
221
+ // triggering Vite's reconnect reload. Vite's heartbeat only sends browser -> server.
222
+ // Harmless server -> browser custom events keep HMR alive without disabling updates.
223
+ const hmrHeartbeatPlugin = (): Plugin => ({
224
+ name: "overmux:hmr-heartbeat",
225
+ apply: "serve",
226
+ configureServer(server) {
227
+ server.httpServer?.once("listening", () => {
228
+ const heartbeat = setInterval(() => {
229
+ server.ws.send("overmux:heartbeat", {});
230
+ }, 20_000);
231
+ heartbeat.unref();
232
+ // One timer per server, not per socket; Vite restarts get a fresh timer.
233
+ server.httpServer?.once("close", () => clearInterval(heartbeat));
234
+ });
235
+ },
236
+ });
237
+
219
238
  export const startManagedVite = async ({
220
239
  api,
221
240
  configPath,
@@ -238,6 +257,8 @@ export const startManagedVite = async ({
238
257
  const server = await api.createServer({
239
258
  configFile: configPath,
240
259
  root,
260
+ // Vite merges inline plugins with the user's vite.config plugins; it doesn't replace them.
261
+ plugins: [hmrHeartbeatPlugin()],
241
262
  server: {
242
263
  fs: { allow: [...new Set(allowedRoots)] },
243
264
  hmr: { path: viteHmrPath },