Fork 0
mirror of https://github.com/vercel/hyper.git synced 2024-04-18 03:21:15 +02:00
Go to file
dependabot[bot] 5fdea9ee9c
Bump webpack from 5.90.3 to 5.91.0 (#7860)
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Labhansh Agrawal <labhansh.agrawal@gmail.com>
2024-04-10 17:04:44 +05:30
.github Bump dawidd6/action-download-artifact from 3.1.2 to 3.1.4 2024-03-20 18:10:15 +05:30
.husky add new lines at the end in husky gitignore and hook files 2021-02-25 15:40:24 +01:00
.vscode Update Electron to v6 (#3785) 2019-10-10 21:20:26 +02:00
app Bump recast from 0.23.4 to 0.23.6 in /app 2024-04-10 16:54:37 +05:30
assets search box overhaul 2022-12-31 03:09:32 -08:00
bin Bump react to v18 2023-07-24 13:42:19 +05:30
build fix windows context menu entry 2023-06-18 21:19:14 +05:30
cli fix lint errors 2023-11-15 11:51:22 +05:30
lib fix lint errors 2023-12-20 13:20:15 +05:30
test fix lint 2024-03-20 18:30:25 +05:30
typings split-pane > function component 2023-08-01 17:57:05 +05:30
.editorconfig Fix for markdown files (#618) 2016-08-14 21:10:41 +02:00
.eslintignore basic changes 2022-12-25 23:52:48 -08:00
.eslintrc.json sort imports 2023-07-26 00:16:14 +05:30
.gitattributes Add github actions 2020-01-12 08:36:51 +01:00
.gitignore ignore dev config schema 2023-01-01 03:01:36 +05:30
.yarnrc set npm registry in yarn config 2020-11-25 08:04:24 +01:00
ava-e2e.config.js Update ava config for v4 2022-01-05 21:27:40 +05:30
ava.config.js Update ava config for v4 2022-01-05 21:27:40 +05:30
babel.config.json Switch to Terser 2020-01-22 17:16:54 +01:00
electron-builder-linux-ci.json rebuild node-pty on chroot for linux arm builds 2023-06-14 23:37:32 +05:30
electron-builder.json Add os to artifact name on mac 2023-07-01 15:44:05 +05:30
LICENSE Update eslint and a few ZEIT references to Vercel 2020-07-13 15:05:34 +02:00
package.json Bump webpack from 5.90.3 to 5.91.0 (#7860) 2024-04-10 17:04:44 +05:30
PLUGINS.md basic changes 2022-12-25 23:52:48 -08:00
README.md capitalizing C++ 2022-05-04 09:00:45 +05:30
release.js fix prettier errors 2020-03-25 17:12:51 +01:00
tsconfig.base.json use node v18 2023-05-30 12:52:11 +05:30
tsconfig.eslint.json basic changes 2022-12-25 23:52:48 -08:00
tsconfig.json move constants to typings as well 2023-07-25 16:49:24 +05:30
webpack.config.ts sort imports 2023-07-26 00:16:14 +05:30
yarn.lock Bump webpack from 5.90.3 to 5.91.0 (#7860) 2024-04-10 17:04:44 +05:30

Node CI Changelog #213

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

Project goals

The goal of the project is to create a beautiful and extensible experience for command-line interface users, built on open web standards. In the beginning, our focus will be primarily around speed, stability and the development of the correct API for extension authors.

In the future, we anticipate the community will come up with innovative additions to enhance what could be the simplest, most powerful and well-tested interface for productivity.


Download the latest release!


Arch and derivatives

Hyper is available in the AUR. Use an AUR package manager e.g. paru

paru -S hyper


Hyper is available as Nix package, to install the app run this command:

nix-env -i hyper


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

brew update
brew install --cask hyper


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.


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.