tabby-eternal-terminal 1.0.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.
Files changed (4) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +94 -0
  3. package/dist/index.js +9039 -0
  4. package/package.json +70 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Tabby Developers
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,94 @@
1
+ # tabby-et
2
+
3
+ tabby-et adds [Eternal Terminal](https://eternalterminal.dev/)
4
+ as a first-class connection type in [Tabby](https://tabby.sh/).
5
+
6
+ Why ? We all use mobile devices. Mobile devices move around. Moving
7
+ around causes terminal reconnections. Terminal reconnections are a
8
+ pain. ET was created to solve this pain. Tabby was created to make
9
+ terminals good. Combine for more good, less pain.
10
+
11
+ Initial support for:
12
+
13
+ - Eternal Terminal connection profile (host, user, ports, auth via an SSH profile)
14
+ - Quick-connect with user@host from the profile selector or the CLI
15
+ - Forward the local SSH agent to the remote session
16
+ - Connect via an ET jump host
17
+
18
+ Key design decisions:
19
+
20
+ - Native terminal scroll-back
21
+ - Use local and remote port forwarding (configured per-profile or add live)
22
+ - ET client protocol natively in TypeScript (don't exec/shell out to et)
23
+ - Use Tabby's existing SSHSession from tabby-ssh (better for security, less maintenance and more inherited features over time)
24
+ - Use tweetnacl (nacl.secretbox / nacl.secretbox.open) for crypto. Pure JS, no native build step reqd and web safe
25
+ - TERM is always xterm-256color (can iterate on this if needed)
26
+ - Hand write the protobuf codec, no protobufjs. Less deps, its only 200 lines and the et protocol isn't a moving target
27
+ - Not resuming an ET session across a Tabby restart (requires persisting the passkey and both nonce counters and a replay buffer. This is asking for security problems, I'm not implementing this)
28
+ - Not using et client configuration file - all config sits inside Tabby
29
+
30
+ ## Compatibility
31
+
32
+ This plugin requires Tabby with the small SSH API changes in PR#11649.
33
+ That PR/branch exports `SSHSession` and its keyboard interactive
34
+ prompt, makes the prompt component available to plugins, and adds
35
+ `SSHSession.openExecChannel()`. A stock Tabby release will not load
36
+ the plugin correctly until those changes are accepted and released
37
+ upstream.
38
+
39
+ The ET server host must have `etserver` and `etterminal` installed. The plugin uses Tabby's SSH connection to start `etterminal`; it does not invoke a local ET binary.
40
+
41
+ ## Install
42
+
43
+ tabby-et is on npm as
44
+ [`tabby-eternal-terminal`](https://www.npmjs.com/package/tabby-eternal-terminal).
45
+ The earlier `tabby-et` package is deprecated in its favour. Uninstall
46
+ `tabby-et` before installing this one, because both provide the same
47
+ connection type.
48
+
49
+ You need a Tabby build with the SSH API changes described under
50
+ [Compatibility](#compatibility), for example one built from the
51
+ [`tabby-et-ssh-support`](https://github.com/qoke/tabby/tree/tabby-et-ssh-support)
52
+ branch of `qoke/tabby`. A stock Tabby release will install the plugin
53
+ but will not load it correctly. This requirement goes away once those
54
+ changes are released in mainstream Tabby.
55
+
56
+ ### From inside Tabby
57
+
58
+ 1. Open **Settings → Plugins → Available**.
59
+ 2. Find **eternal-terminal**. npm ranks new plugins low, so it may be
60
+ near the end of the list.
61
+ 3. Click **Get**.
62
+ 4. Restart Tabby.
63
+
64
+ Eternal Terminal is then offered as a connection type under
65
+ **Settings → Profiles & connections → New profile**.
66
+
67
+ ### With npm
68
+
69
+ Install the package into Tabby's plugin directory, then restart Tabby:
70
+
71
+ ```sh
72
+ npm install --prefix ~/.config/tabby/plugins tabby-eternal-terminal
73
+ ```
74
+
75
+ The plugin directory is `~/.config/tabby/plugins` on Linux,
76
+ `~/Library/Application Support/tabby/plugins` on macOS and
77
+ `%APPDATA%\tabby\plugins` on Windows.
78
+
79
+ The package has no dependencies of its own to install: what it needs
80
+ is either inside its bundle or provided by Tabby.
81
+
82
+ ## Build and try it locally
83
+
84
+ Use a Tabby checkout built from the support branch/PR above, then:
85
+
86
+ ```sh
87
+ git clone https://github.com/qoke/tabby-et.git
88
+ cd tabby-et
89
+ npm ci
90
+ npm run build
91
+ TABBY_PLUGINS="$PWD" /path/to/patched/tabby --debug
92
+ ```
93
+
94
+ This repository is licensed under MIT; see [LICENSE](LICENSE). Please report ET plugin issues here rather than in Tabby core.