1
- # nmux
1
+ < h1 align = center >< img alt = " nmux " src = " assets/logo.png " ></ h1 >
2
2
3
3
` nmux ` is a multiplexer for [ Neovim] [ ] processes. It is very much a work in
4
4
progress at the moment.
@@ -10,33 +10,54 @@ rendered in a browser: https://youtu.be/mzfHBPHkT-E
10
10
The browser client was made mainly for prototyping. Native GUI clients for
11
11
Linux, macOS, and Windows are being worked on.
12
12
13
+ ## Requirements
14
+
15
+ [ Neovim] [ ] must be installed and ` nvim ` available in ` $PATH ` .
16
+
17
+
13
18
## Install
14
19
15
- Pre-built binaries will be made available once development has reached a certain
16
- point. However, if you want to try the browser client now, you will need
17
- make sure ` nvim ` is available in ` $PATH ` , then run:
20
+ There is an [ unstable] [ ] Darwin (macOS) binary available.
21
+ Windows and Linux builds will be available in the future.
22
+
23
+ You can also install it with Go:
18
24
19
25
```
20
26
$ go get -u github.com/tweekmonster/nmux/cmd/nmux
21
27
```
22
28
23
29
## Usage
24
30
31
+ To run the server:
32
+
25
33
```
26
- $ nmux --addr localhost:9999
34
+ $ nmux --server -- addr localhost:9999
27
35
```
28
36
29
- Then point your browser to [ http://localhost:9999/ ] ( http://localhost:9999/ )
37
+ To use Neovim in a browser, go to
38
+ [ http://localhost:9999/ ] ( http://localhost:9999/ )
39
+
40
+ ** Note** : The browser client has been tested and works in Google Chrome. The
41
+ keyboard currently doesn't work in Firefox or Safari. If you're using an
42
+ extension that gives you vi functionality, it will need to be disabled.
43
+
44
+ If you're using the Darwin release:
45
+
46
+ ```
47
+ $ nmux.app/Contents/MacOS/nmux --server --addr localhost:9999
48
+ ```
30
49
31
- ** Note** : The browser client has been tested and works in Google Chrome. The
32
- keyboard currently doesn't work in Firefox or Safari.
50
+ Then run ` nmux.app ` to connect to the server. If you're using a port other
51
+ than ` 9999 ` , you will need to run the client the same way, but without the
52
+ ` --server ` flag. A future release will allow you to configure a remote server
53
+ and optionally spawn a local server.
33
54
34
55
35
56
## Goals
36
57
37
58
- A server that manages multiple ` nvim ` processes.
38
59
- Allow clients to connect over TCP.
39
- - Shared unnamed buffer between all ` nvim ` processes.
60
+ - Shared unnamed register between all ` nvim ` processes.
40
61
- Native cross-platform client programs.
41
62
- Each ` nvim ` instance can be a tab or a split view.
42
63
- UI is always consistent. No platform-specific GUI elements, except for the
@@ -60,4 +81,5 @@ workspaces and resume where you left off after a reboot.
60
81
61
82
62
83
[ Neovim ] : https://github.com/neovim/neovim
84
+ [ unstable ] : https://github.com/tweekmonster/nmux/releases/tag/unstable
63
85
[ libvterm ] : https://github.com/neovim/libvterm
0 commit comments