JavaScript Other
Permalink
Failed to load latest commit information.
.circleci CircleCI: Prevent repetitive build job when releasing (#2787) Mar 26, 2018
.github Remove website (#2824) Apr 16, 2018
.vscode CLI: use .hyper.js from repo root dir when running in dev mode (#2792) Apr 20, 2018
app 2.1.0-canary.2 Jun 15, 2018
assets Windows titlebar improvements (#1307) Jan 11, 2017
bin Update electron to v1.7.10 and other dependencies (#2583) Jan 21, 2018
build fix a typo (#2945) Apr 27, 2018
cli CLI : Fix package existence check for scoped packages (#3044) May 23, 2018
lib Fix module hijacking (#3067) Jun 11, 2018
test CLI : Fix package existence check for scoped packages (#3044) May 23, 2018
.editorconfig Fix for markdown files (#618) Aug 14, 2016
.eslintignore Ignore dist dir in eslint (#2280) Sep 25, 2017
.gitattributes git: always set js endline to lf (#2795) Apr 20, 2018
.gitignore add yarn-error.log to gitignore (#2928) Apr 24, 2018
.travis.yml Electron 1.8 is out (#2663) Feb 12, 2018
.yarnrc Fix pining dependencies with .yarnrc (#2430) Nov 5, 2017
LICENSE Point Spectrum badge to correct location (#3166) Aug 9, 2018
PLUGINS.md Doc: fix broken link in PLUGINS.md (#3089) Jun 17, 2018
README.md Update README.md (#3167) Aug 9, 2018
appveyor.yml Update dependencies (#2416) Nov 1, 2017
jsconfig.json Disable VSCode type chekcing (#2767) Mar 17, 2018
package.json Update xterm to 3.4.1 (#3032) Jun 4, 2018
release.js Fix lint Oct 5, 2017
webpack.config.js Add CLI tool to install/search plugins or launch app (#2375) Jan 9, 2018
yarn.lock Fix module hijacking (#3067) Jun 11, 2018

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