/hyper

A terminal built on web technologies
  1. JavaScript 97.6%
  2. HTML 2.4%
JavaScript HTML
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP
Find file
Switch branches/tags
Nothing to show
Latest commit bbb1cae Jan 4, 2018 @dcalhoun dcalhoun committed with leo Always notify watchers of plugin updates (#2508) 
During plugin updates, each `plugin.onUnload` is invoked regardless of
whether the plugin changed. This commit ensures that each `plugin.onApp`
is invoked once all plugins have been updated. Fixes #2415.
Permalink
Failed to load latest commit information.
.github Unify wording and spelling in config and other places (#2422) Nov 4, 2017
.vscode Add vscode debug config, update readme (#2181) Sep 7, 2017
app Always notify watchers of plugin updates (#2508) Jan 4, 2018
assets Windows titlebar improvements (#1307) Jan 11, 2017
bin Ship yarn with hyper (#381) Aug 14, 2017
build Add canary icons and setup CIs Sep 19, 2017
lib Added keymap to rebind the 'break' command - Issue #2432 (#2531) Dec 18, 2017
test Merge branch 'master' into canary Sep 19, 2017
website Doc: Fix mixed-up tags in component hierarchy (#2389) Oct 25, 2017
.editorconfig Fix for markdown files (#618) Aug 14, 2016
.eslintignore Ignore dist dir in eslint (#2280) Sep 25, 2017
.gitattributes Ensure line endings are correct on Windows (#1230) Jan 2, 2017
.gitignore Make builds work again and catch squirrel errors on windows (#2078) Aug 13, 2017
.travis.yml Fix branch detection when setting the canary icon (#2499) Dec 5, 2017
.yarnrc Fix pining dependencies with .yarnrc (#2430) Nov 5, 2017
appveyor.yml Update dependencies (#2416) Nov 1, 2017
circle.yml Update dependencies (#2416) Nov 1, 2017
jsconfig.json Type checking configuration (#2291) Sep 26, 2017
license.md Tell Yarn to cache dependencies (#2113) Aug 21, 2017
package.json Dependency updates (#2533) Dec 12, 2017
readme.md Unify wording and spelling in config and other places (#2422) Nov 4, 2017
release.js Fix lint Oct 5, 2017
webpack.config.js Restore lost commits from v2 branch (#2275) Sep 25, 2017
yarn.lock Dependency updates (#2533) Dec 12, 2017

readme.md

macOS CI Status Windows CI status Linux CI status Slack Channel Changelog #213 XO code style

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

Usage

Download the latest release!

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.

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

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