| .github | ||
| .vscode | ||
| app | ||
| assets | ||
| bin | ||
| build | ||
| lib | ||
| test | ||
| website | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .travis.yml | ||
| .yarnrc | ||
| appveyor.yml | ||
| circle.yml | ||
| license.md | ||
| package.json | ||
| readme.md | ||
| webpack.config.js | ||
| yarn.lock | ||
For more details, head to: https://hyper.is
Usage
If you're on macOS, you can also use Homebrew Cask to download the app by running these commands:
brew update
brew cask install hyper
If you're 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
- Install the dependencies
- If you are running Linux, install
icnsutils,graphicsmagick,xz-utils,npm,rpmandyarn - If you are running Windows, install
yarn(If you use the MSI installer you will need to install npm), andwindows-build-toolswithyarn global add windows-build-tools. - Yarn installation instructions: https://yarnpkg.com/en/docs/install
- 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 appfrom another terminal tab/window/pane- If you are using Visual Studio Code, select
Launch Hyperin 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'll 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 yarn run rebuild-node-pty.
If you're 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 codesign on macOS when running yarn run dist
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.