upterm README

The project's README from github.com/railsware/upterm. As one markdown file: README.md.

Join the chat at https://gitter.im/railsware/upterm Build Status

Deprecated

Upterm is deprecated. Project had lost maintainer and have zero activity to support it from community (only issues was created in repo).

I am no longer accepting pull requests and issues.

I recomended to check Hyper instead.

What Is It?

Upterm is looking for maintainers

Upterm (formerly Black Screen) is an IDE in the world of terminals. Strictly speaking, it's both a terminal emulator and an interactive shell based on Electron.

Autocompletion

Upterm shows the autocompletion box as you type and tries to be smart about what to suggest. Often you can find useful additional information on the right side of the autocompletion, e.g. expanded alias value, command descriptions, value of the previous directory (cd -), etc.

Compatibility

All command-line programs (including emacs, ssh and vim) should work as expected. If you experience any glitches, please create an issue.

Install

MacOS
brew cask install upterm

Beware that the version in Homebrew might be outdated. Visit the releases page to download the latest version.

Linux (Arch Linux)
yaourt -S upterm

As with macOS's brew install, the AUR may also be outdated. To install the latest version, refer to the install guide for Linux (Others).

Linux (Others)
Windows

Windows is not officially supported at the moment. The Windows Support Issue explains potential experimental support.

Technologies

More Screenshots

Development Setup

git clone https://github.com/railsware/upterm.git && cd upterm
npm start

Instructions are available for debugging the application in Visual Studio Code.

To create a standalone application, execute npm run pack in the project directory.

Contributing

See Contributing Guide.

License

The MIT License.

upterm (railsware/upterm)

Searching Database…

19K ·GitHub
archived
What is this?Upterm (formerly Black Screen) is a terminal emulator that is also an interactive shell — the README calls it an IDE in the world of terminals. It is a desktop app built on Electron.
Do I need to install anything else to use it?Nothing for everyday use — it installs as a self-contained Electron desktop app. Node.js and npm are only needed if you want to build or debug it from source.
Is Upterm still maintained?No. Upterm is deprecated and archived: it lost its maintainer and gets no community activity, and the author no longer accepts pull requests or issues. The README recommends checking out Hyper instead.
Can I run it on Windows?Not officially. Windows support is experimental at best — the README points to a Windows Support Issue that explains the potential workaround.
What makes Upterm's autocompletion smarter than a plain terminal's?An autocompletion box appears as you type, and its right side shows useful context: expanded alias values, command descriptions, even the value of your previous directory (cd -).
Will my usual command-line tools like vim and ssh work inside it?Yes — the README says all command-line programs, emacs, ssh and vim included, should work as expected; glitches were to be reported via issues.
What is Upterm built with?Electron, TypeScript and ReactJS — a typical web-tech desktop stack; the development setup also includes debugging instructions for Visual Studio Code.
What are similar projects?xterm.js, wezterm, hyper, terminalizer, edex-ui, rio, ttyd, lens
Creator
railsware
Size
7.6 MB
Stars
19K
Age
11y
Commits · 90 Days