hyper README

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

Node CI Changelog #213

For more details, head to: https://hyper.is

Project goals

The goal of the project is to create a beautiful and extensible experience for command-line interface users, built on open web standards. In the beginning, our focus will be primarily around speed, stability and the development of the correct API for extension authors.

In the future, we anticipate the community will come up with innovative additions to enhance what could be the simplest, most powerful and well-tested interface for productivity.

Usage

Download the latest release!

Linux

Arch and derivatives

Hyper is available in the AUR. Use an AUR package manager e.g. paru

paru -S hyper

NixOS

Hyper is available as Nix package, to install the app run this command:

nix-env -i hyper

macOS

Use Homebrew Cask to download the app by running these commands:

brew update
brew install --cask hyper

Windows

Use chocolatey to install the app by running the following command (package information can be found here):

choco install hyper

Note: The version available on Homebrew Cask, Chocolatey, Snapcraft or the AUR may not be the latest. Please consider downloading it from here if that's the case.

Contribute

Regardless of the platform you are working on, you will need to have pnpm available. The recommended way is to enable it with Corepack: corepack enable pnpm.

  1. Install necessary packages:
  1. Fork this repository to your own GitHub account and then clone it to your local device
  2. Install the dependencies: pnpm install
  3. Build the code and watch for changes: pnpm run dev
  4. To run hyper

To make sure that your code works in the finished application, you can generate the binaries like this:

pnpm run dist

After that, you will see the binary in the ./dist folder!

Known issues that can happen during development

Error building node-pty

If after building during development you get an alert dialog related to node-pty issues, make sure its build process is working correctly by running pnpm run rebuild-node-pty.

If you are on macOS, this typically is related to Xcode issues (like not having agreed to the Terms of Service by running sudo xcodebuild after a fresh Xcode installation).

Error with C++ on macOS when running pnpm install

If you are getting compiler errors when running pnpm install add the environment variable export CXX=clang++

Error with codesign on macOS when running pnpm run dist

If you have issues in the codesign step when running pnpm run dist on macOS, you can temporarily disable code signing locally by setting export CSC_IDENTITY_AUTO_DISCOVERY=false for the current terminal session.

hyper (vercel/hyper)

terminal-emulators
Searching Database…

44.7K ·GitHub
Hyper
What is this?Hyper is a terminal emulator built with web technologies (HTML, CSS, JavaScript/TypeScript) on top of Electron, aiming to be a beautiful and extensible command-line interface.
Is this a terminal app or a library I'd embed in my own project?It is a standalone desktop terminal application (built on Electron and React), not a library you import into other code.
How do I install and run it?Download the latest release for your platform, or install via package managers: Homebrew Cask on macOS, Chocolatey on Windows, and AUR/Nix/Snapcraft on Linux.
Any known pitfalls when building it myself?Known issues include node-pty build failures (fixable with pnpm run rebuild-node-pty), C++ compiler errors on macOS install (needs CXX=clang++), and codesign errors when running pnpm run dist.
Which platforms does Hyper run on?Hyper runs on Linux, macOS, and Windows, with dedicated install instructions for each.
Can Hyper be extended with plugins and themes?Yes, Hyper supports an extension API with sample extensions and sample themes, and there's an 'Awesome Hyper' list of community plugins and themes referenced in the README.
Why build a terminal with web tech instead of a native app?The project's goal is to let web developers extend and customize the terminal using familiar open web standards (HTML/CSS/JS) rather than native toolkits, prioritizing extensibility and a consistent cross-platform UI.
What's the latest version always guaranteed to work?Package manager versions (Homebrew Cask, Chocolatey, Snapcraft, AUR) may lag behind, so the README recommends downloading the latest release directly from the project's releases page for the newest version.
What are similar projects?upterm, edex-ui, tabby, pear-desktop, wezterm, dsh-pet, nylas-mail, Motrix
Which topics is it in?terminal-emulator, terminal-emulators, electron, customization, css, html, plugin, gui, react, desktop-app, terminal, nodejs
Creator
vercel
Size
22.9 MB
Stars
44.7K
Updated
CommitAug 21Releasev3.4.1Jan 08
Age
10y
Commits · 90 Days