You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-4Lines changed: 28 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,16 +2,40 @@
2
2
3
3
Unlike most command-line tools for web services that require an API, Terminalwire streams terminal I/O between a web server and client over WebSockets. This means you can use your preferred command-line parser within your favorite web server framework to deliver a delightful CLI experience to your users.
4
4
5
+
## What's in this repo?
6
+
7
+
This is a monolithic repository with several Terminalwire components, including the Terminalwire thin-client and Ruby & Rails servers.
8
+
9
+
### Terminalwire Client
10
+
11
+
The Terminalwire thin-client is pacakged using Tebako and is installed on end-user workstations. The thin-client connects to a Terminalwire server and streams stdio, browser, filesystem, and other commands between the server and client via WebSockets through an entitlement-based security layer.
12
+
13
+
[Read the Terminalwire-client manual](https://terminalwire.com/docs/client)
14
+
15
+
### Terminalwire Ruby & Rails servers
16
+
17
+
Terminalwire servers can run on any platform or framework. This repo has source for the Ruby Terminalwire server, specifically targeting Ruby on Rails.
18
+
19
+
[Read the Terminalwire Ruby on Rails manual](https://terminalwire.com/docs/rails)
20
+
5
21
## Installation
6
22
7
-
Install the gem and add to the application's Gemfile by executing:
23
+
### Client
24
+
25
+
The Terminalwire thin-client may be installed by running:
8
26
9
-
$ bundle add terminalwire
27
+
$ curl -sSL https://terminalwire.sh/ | bash
10
28
11
-
If bundler is not being used to manage dependencies, install the gem by executing:
29
+
This installs the Tebako packaged version of the Terminalwire client, which is recommended for production use.
30
+
31
+
#### RubyGem client
32
+
33
+
The Terminalwire thin-client gem may be installed for development purposes by running:
12
34
13
35
$ gem install terminalwire
14
36
37
+
*This approach is not recommended for production use since developer workstations likely don't have the correct Ruby dependencies installed*
38
+
15
39
## Rails
16
40
17
41
Run the intallation command:
@@ -38,7 +62,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/termin
38
62
39
63
## License
40
64
41
-
The gem is available as a propietary license. Email[email protected] to discuss licensing.
65
+
The gem is available as a propietary license. The tl;dr is that it's free for personal use and for commercial use email[email protected] to discuss licensing.
0 commit comments