Uniterm2

An evolution of Uniterm pseudo terminal emulator.

Difference between Uniterm2 and old Uniterm:

• Uniterm2 is based on xterm.js and the old one is Google's hterm.
• Uniterm2 has removed built-in MinSH component which exists in the old one.
• Uniterm2 is written with TypeScript and the old one is plain JavaScript.
• Uniterm2 supports dropping files that the old one does not.
• Uniterm2 built-in supports powerline decorations (via all-in-one patched Mononoki font with Nerd Fonts).
• Uniterm2 has a simple modding mechanism that does not exists in the old one. (see modding section below for details)
• Uniterm2 can launch a shell with privileged permission (administrator) if the user account you logging in permits you to do so. (Added after v0.12)

The features that exists in both Uniterm in Uniterm2:

• Cross platform pseudo terminal emulator
• Full Windows Subsystem for Linux intergration
• Tabs!
• Open source!

Building

1. Clone this repository and get into it.

$ git clone https://github.com/JLChnToZ/uniterm.git
$ cd uniterm

2. Install dependencies. (Assume you have installed Node.js, Yarn and other requirements for building Electron/Node.js native modules)

$ yarn

3. Build and package it.

$ yarn package

4. You will find your fresh build inside dist/ folder.

Or if you are lazy to do it/does not meet the requirements to build it, but you want to use/try it, you may go to releases and download the prebuilt binaries. (Currently Windows is available only, sorry for other platforms)

Using

Mainly, when you double-clicked the entry file (uniterm.exe for Windows, uniterm.app for OSX and uniterm for Linux), it launches the default shell of your system (cmd, bash, etc.), but if you want more control on how it launches (for example you want to launch a different shell, start from a specified directory, pass more environment variables, etc.), you can pass arguments to it (via any external shell or even the shell opened inside Uniterm).

Here is the command-line usage, that is, what you will get when you pass --help:

Usage: uniterm [options] [--] [shellargs..]

Options:
  --cwd, -c         Working directory to start shell.                   [string]
  --env, -e         Add/modify environment variable passed into the shell.
                                                                         [array]
  --new-window, -n  Open the shell in a new window                     [boolean]
  --pause, -p       Pauses after shell/program exits                   [boolean]
  --config          Opens the config file                              [boolean]
  --reset-config    Resets the config file                             [boolean]
  --version         Show version number                                [boolean]
  --help            Show help                                          [boolean]

Also, if you pass --show-hidden together with --help, you will find out more options (which are not very necessary for normal use).

Additionally, you can have full WSL integration if you launch WSL with Uniterm by pass wsl as the shell exactly like uniterm [options] [--] wsl [command] [args..], and the optional command and args in here is for putting what command should run inside automatically once the WSL bash has been launched. Your system's firewall may complain if you first time to launch the WSL with Uniterm, as Uniterm needs to seek a free TCP port and open it to localhost for communicate between Windows side and Linux side. When it asks for such permission, just allow it or it will not work.

You may also want to launch a shell in administrator mode. Even in Windows platform, you may use sudo prefix to do so (like uniterm [options] [--] sudo [shell] [args..]).

Since version 0.18, you can right-click on the + button to customize newly opened tab such as changing environment variable, working directory before launch anything new.

Modding

It is quite tricky but not very hard to try it yourself. The mod files themselves works like userscripts but without header and reloads everytime the config file has been updated. Also Uniterm is already make the necessary stuffs (including class declarations and some events) exposed to window namespace. To start modding, you may have a look to renderer.tsx and its imports to figure out what is it doing.

Once you created your mod or grabbed one from someone who made it, click on the gear icon at the top-right corner or type uniterm --config inside the Uniterm terminal, you should opened up a YAML config file with your favourite text editor, scroll to bottom and you will see the hints: save/put the mod script file into the folder it wrotes and add the filename under the mods field.

When you saved the config file, the terminal should immediately load/reloads all mod files.

Here has an example working mod, which displays terminal size at the corner: https://gist.github.com/JLChnToZ/7514cac109d5c3131acbac0b0523d9af

License

MIT