The goal of the project is to create a beautiful and customizable experience for command-line interface users, built on open web standards. We have picked up where Vercel left off, and intend to first offer stability, followed by a more tailored experience. We will still support customizability, but stability of theming APIs is not a goal.
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.
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.
- Install necessary packages:
- Windows
- Install Visual Studio (2022 or newer) with the Desktop development with C++ workload.
- In the VS Installer under Individual Components, also install Latest MSVC - VS C++ x64/x86 Spectre-mitigated libs (required for building native Node modules).
- Install Node.js >=22.20.0 (the native module build toolchain requires it).
- macOS
- Once you have installed Yarn, you can skip this section!
- Linux (You can see here what your Linux is based on.)
- RPM-based
GraphicsMagicklibicns-utilsxz(Installed by default on some distributions.)
- Debian-based
graphicsmagickicnsutilsxz-utils
- RPM-based
- Fork this repository to your own GitHub account and then clone it to your local device
- Install the dependencies:
yarn - Build the code and watch for changes:
yarn run dev - To run
hyper
yarn run appfrom another terminal tab/window/pane- If you are using Visual Studio Code, select
Launch Hyperin 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 distAfter that, you will see the binary in the ./dist folder!
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).
If you are getting compiler errors when running yarn add the environment variable export CXX=clang++
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.
If you'd like more details on the Plugin API, that much has not changed from the original Vercel Hyper yet. You can find it on the old Hyper's website.
These repositories are for the original Hyper.