For more details, head to: https://hyper.is
Usage
If you are on macOS, you can also use Homebrew Cask to download the app by running these commands:
brew update
brew cask install hyper
If you are on windows, you can 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 or Chocolatey 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 Yarn installed. If you have never installed Yarn before, you can find out how at: https://yarnpkg.com/en/docs/install.
- Install necessary packages:
- Windows
- Be sure to run
yarn global add windows-build-tools
to installwindows-build-tools
.
- Be sure to run
- macOS
- Once you have installed Yarn, you can skip this section!
- Linux
- RPM-based
GraphicsMagick
libicns-utils
xz
(Installed by default on some distributions.)
- Debian-based
graphicsmagick
icnsutils
xz-utils
- RPM-based
- Fork this repository to your own GitHub account and then clone it to your local device
- Install the dependencies:
yarn
- Build the code and watch for changes:
yarn run dev
- To run
hyper
yarn 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.
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!
Known issues that can happen during development
node-pty
Error building 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 yarn 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).
codesign
on macOS when running yarn run dist
Error with If you have issues in the codesign
step when running yarn run dist
on macOS, you can temporarily disable code signing locally by setting
export CSC_IDENTITY_AUTO_DISCOVERY=false
for the current terminal session.