README

!


  
    
  
 
  



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

sh
paru -S hyper


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

sh
nix-env -i hyper


 macOS

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

bash
brew update
brew install --cask hyper


 Windows

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

bash
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:
   Windows
    - Be sure to run pnpm add --global windows-build-tools from an elevated prompt (as an administrator) to install windows-build-tools.
   macOS
    - Once you have enabled pnpm, you can skip this section!
   Linux (You can see here what your Linux is based on.)
    - RPM-based
        + GraphicsMagick
        + libicns-utils
        + xz (Installed by default on some distributions.)
    - Debian-based
        + graphicsmagick
        + icnsutils
        + xz-utils
2. Fork this repository to your own GitHub account and then clone it to your local device
3. Install the dependencies: pnpm install
4. Build the code and watch for changes: pnpm run dev
5. To run hyper
   pnpm run app from another terminal tab/window/pane
   If you are using Visual Studio Code, select Launch Hyper in debugger configuration to launch a new Hyper instance with debugger attached.
   If you interrupt pnpm run dev, you'll need to relaunch it each time you want to test something. Webpack will watch changes and will rebuild renderer code when needed (and only what have changed). You'll just have to relaunch electron by using pnpm run app or VSCode launch task.

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

bash
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

Top issues

Discussions

Latest release

V3.4.1

Based on some reports of errors with node-pty, reverting it to a stable version.

|   OS    | Installer |                                                                                                 |                                                                                                  |
| :-----: | :-------: | :---------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------: |
|   Mac   |    dmg    | x64 (Intel) | arm64 (M1) |
|  Linux