Repository files navigation

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

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.

Download the latest release!

Hyper is available in theAUR. Use an AURpackage manager e.g.paru

paru -S hyper

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

nix-env -i hyper

UseHomebrew Cask to download the app by running these commands:

brew updatebrew install --cask hyper

Usechocolatey to install the app by running the following command (package information can be foundhere):

choco install hyper

Note: The version available onHomebrew Cask,Chocolatey,Snapcraft or theAUR may not be the latest. Please consider downloading it fromhere if that's the case.

Regardless of the platform you are working on, you will need to have Yarn installed. If you have never installed Yarn before, you can find out how at:https://yarnpkg.com/en/docs/install.

1. Install necessary packages:

• Windows
  • Be sure to runyarn global add windows-build-tools from an elevated prompt (as an administrator) to installwindows-build-tools.
• macOS
  • Once you have installed Yarn, you can skip this section!
• Linux (You can seehere 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 thenclone it to your local device
3. Install the dependencies:yarn
4. Build the code and watch for changes:yarn run dev
5. To runhyper

• yarn run app from another terminal tab/window/pane
• If you are usingVisual Studio Code, selectLaunch Hyper in debugger configuration to launch a new Hyper instance with debugger attached.
• If you interruptyarn 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 yarn run app or VSCode launch task.

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

yarn run dist

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

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

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

If you are getting compiler errors when runningyarn add the environment variableexport CXX=clang++

If you have issues in thecodesign step when runningyarn run dist on macOS, you can temporarily disable code signing locally by settingexport CSC_IDENTITY_AUTO_DISCOVERY=false for the current terminal session.

• Website
• Sample Extension
• Sample Theme
• Awesome Hyper