Skip to content
A terminal built on web technologies
TypeScript JavaScript Other
Branch: canary
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci add app/node_modules to circleci persist list Dec 23, 2019
.github Add canary icon copy and limit push jobs for github actions Jan 13, 2020
.vscode Update Electron to v6 (#3785) Oct 10, 2019
app Fix autoUpdater error on Linux Jan 13, 2020
assets Windows titlebar improvements (#1307) Jan 11, 2017
bin Update yarn-standalone to v1.21.1 Dec 23, 2019
build Improve Hyper 3 Canary and Stable icons (#3466) Feb 9, 2019
cli remove duplicate aliases in cli commands Dec 26, 2019
lib add back the useCapture option in mousetrap Jan 15, 2020
test setup ava for ts, port test/ to ts Dec 15, 2019
.editorconfig Fix for markdown files (#618) Aug 14, 2016
.eslintignore Rename compiled_app to target and add target in eslintignore Oct 8, 2019
.eslintrc.json split package.json to separate config files Dec 31, 2019
.gitattributes Add github actions Jan 12, 2020
.gitignore add vscode workspace settings to .gitignore Nov 28, 2019
.huskyrc.json split package.json to separate config files Dec 31, 2019
.travis.yml Upgrade eslint to v6 and add TypeScript linting (#3843) Oct 3, 2019
.yarnrc Update Electron to v6 (#3785) Oct 10, 2019
LICENSE Point Spectrum badge to correct location (#3166) Aug 9, 2018
PLUGINS.md Document that plugins can require Electron Oct 3, 2019
README.md Add a way to fix macos compiler error to README.md (#3680) Jul 30, 2019
appveyor.yml update appveyor to VS 2019 Oct 16, 2019
ava.config.js split package.json to separate config files Dec 31, 2019
babel.config.json split package.json to separate config files Dec 31, 2019
electron-builder.json split package.json to separate config files Dec 31, 2019
package.json Bump @babel/preset-typescript from 7.7.7 to 7.8.0 Jan 13, 2020
release.js Upgrade eslint to v6 and add TypeScript linting (#3843) Oct 3, 2019
tsconfig.base.json update tsc target to es2018 Dec 18, 2019
tsconfig.json port cli/ to ts Dec 16, 2019
webpack.config.js port app/index and it's referenced files to ts Dec 20, 2019
yarn.lock Bump @babel/preset-typescript from 7.7.7 to 7.8.0 Jan 13, 2020

README.md

macOS CI Status Windows CI status Linux CI status Changelog #213 Join the community on Spectrum

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

Usage

Download the latest release!

Linux

Arch and derivatives

Hyper is available in the AUR. Use an AUR package manager like aurman

aurman -S hyper

macOS

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

brew update
brew cask install 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 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 run yarn global add windows-build-tools from an elevated prompt (as an administrator) to install windows-build-tools.
  • macOS
    • Once you have installed Yarn, 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
  1. Fork this repository to your own GitHub account and then clone it to your local device
  2. Install the dependencies: yarn
  3. Build the code and watch for changes: yarn run dev
  4. 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.
  • If you interrupt yarn 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!

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 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 yarn

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

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.

Related Repositories

You can’t perform that action at this time.