Quine's fork of "Hyper" by Vercel, A terminal built on web technologies
Find a file
Juan Campa c07700af49 Performance - Data batching (#3336)
* Bumping electron to 3.0.10

* Updating node version in travis and appveyor

* Fixing incorrect require of electron-fetch

* Fix zoom to match previous versions

Additionally I'm removing a call to disable pinch-zoom, it's disable by
default since Electron 2 (https://electronjs.org/releases#2.0.0)

* Bumping electron to 4.0.0-beta.8

* Bumping electron to 4.0.0-beta.9

* Work around for Copy accelerator not firing on electron v4

* Batch session data before sending it to renderer

* Fix linting issues

* Fixing header/titlebar in MacOS

* Upgrading to electron 4.0.0 and node-pty 0.8.0

* Adding yarn.lock changes for electron 4.0.0

* Adding comments for editor:copy workaround. Scaling issue is only on Linux

* Upgrading node-abi to support electron 4.0.0

* Adding isDestroyed check
2018-12-28 15:13:00 -08:00
.circleci CircleCI: Prevent repetitive build job when releasing (#2787) 2018-03-27 00:43:25 +02:00
.github Remove website (#2824) 2018-04-16 15:46:06 +02:00
.vscode CLI: use .hyper.js from repo root dir when running in dev mode (#2792) 2018-04-20 17:02:30 +02:00
app Performance - Data batching (#3336) 2018-12-28 15:13:00 -08:00
assets Windows titlebar improvements (#1307) 2017-01-10 21:45:49 -08:00
bin Update electron to v1.7.10 and other dependencies (#2583) 2018-01-21 10:21:41 +01:00
build Fix CLI tool with python3 (#3284) 2018-12-03 16:11:45 -08:00
cli [CLI] added 'version' command. (#3207) 2018-09-25 00:48:44 +02:00
lib WebGL renderer (using xterm.js fork) (#3368) 2018-12-28 14:42:05 -08:00
test CLI : Fix package existence check for scoped packages (#3044) 2018-05-23 23:32:38 +02:00
.editorconfig Fix for markdown files (#618) 2016-08-14 21:10:41 +02:00
.eslintignore Ignore dist dir in eslint (#2280) 2017-09-25 12:41:50 +02:00
.gitattributes git: always set js endline to lf (#2795) 2018-04-20 17:04:40 +02:00
.gitignore add yarn-error.log to gitignore (#2928) 2018-04-24 18:29:24 +02:00
.travis.yml Upgrade Electron to v4 (#3329) 2018-12-25 18:15:25 -08:00
.yarnrc Fix pining dependencies with .yarnrc (#2430) 2017-11-05 17:14:10 +00:00
appveyor.yml Upgrade Electron to v4 (#3329) 2018-12-25 18:15:25 -08:00
jsconfig.json Disable VSCode type chekcing (#2767) 2018-03-17 18:52:18 +01:00
LICENSE Point Spectrum badge to correct location (#3166) 2018-08-09 13:15:48 +02:00
package.json WebGL renderer (using xterm.js fork) (#3368) 2018-12-28 14:42:05 -08:00
PLUGINS.md Fix incorrect markdown links (#3243) 2018-10-08 00:40:52 +02:00
README.md Update outdated link to Homebrew Cask (#3235) 2018-10-03 15:18:48 +02:00
release.js Fix lint 2017-10-05 21:04:14 +02:00
webpack.config.js Add CLI tool to install/search plugins or launch app (#2375) 2018-01-09 16:05:19 +01:00
yarn.lock WebGL renderer (using xterm.js fork) (#3368) 2018-12-28 14:42:05 -08:00

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.