openmux 0.2.105 → 0.2.107
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 +29 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -75,6 +75,34 @@ bun start # Run from source
|
|
|
75
75
|
bun dev # Run with watch mode
|
|
76
76
|
```
|
|
77
77
|
|
|
78
|
+
## CLI
|
|
79
|
+
|
|
80
|
+
openmux ships a headless-style CLI that talks to the running UI for pane/layout
|
|
81
|
+
operations and uses on-disk session metadata for session listing/creation.
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
openmux --help
|
|
85
|
+
openmux pane --help
|
|
86
|
+
openmux pane capture --help
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
Examples:
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
openmux session list --json
|
|
93
|
+
openmux session create dev
|
|
94
|
+
openmux attach --session dev
|
|
95
|
+
openmux pane split --direction vertical --workspace 2
|
|
96
|
+
openmux pane send --pane focused --text "npm test\n"
|
|
97
|
+
openmux pane capture --pane focused --lines 200 --format ansi
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Notes:
|
|
101
|
+
|
|
102
|
+
- Pane commands require a running UI (control socket available).
|
|
103
|
+
- `pane send` supports C-style escapes like `\n`, `\t`, `\xNN`, `\uXXXX`.
|
|
104
|
+
- See [docs/user/cli.md](./docs/user/cli.md) for the full spec and exit codes.
|
|
105
|
+
|
|
78
106
|
## Architecture (High Level)
|
|
79
107
|
|
|
80
108
|
```
|
|
@@ -290,7 +318,7 @@ openmux loads `~/.config/openmux/config.toml` (or `$XDG_CONFIG_HOME/openmux/conf
|
|
|
290
318
|
|
|
291
319
|
Config changes are hot-reloaded while openmux is running (layout, theme, and keybindings update live).
|
|
292
320
|
|
|
293
|
-
See [
|
|
321
|
+
See [docs/user/config.md](./docs/user/config.md) for the full generated config.
|
|
294
322
|
|
|
295
323
|
Environment variables override the config file for layout values:
|
|
296
324
|
|