hyper README

The project's README from github.com/vercel/hyper. As one markdown file: README.md.

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.

Usage

Download the latest release!

Linux

Arch and derivatives

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

paru -S hyper

NixOS

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

nix-env -i hyper

macOS

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

brew update
brew install --cask 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, Snapcraft 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 pnpm available. The recommended way is to enable it with Corepack: corepack enable pnpm.

  1. Install necessary packages:
  1. Fork this repository to your own GitHub account and then clone it to your local device
  2. Install the dependencies: pnpm install
  3. Build the code and watch for changes: pnpm run dev
  4. To run hyper

To make sure that your code works in the finished application, you can generate the binaries like this:

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

If you are getting compiler errors when running pnpm install add the environment variable export CXX=clang++

Error with codesign on macOS when running pnpm run dist

If you have issues in the codesign step when running pnpm run dist on macOS, you can temporarily disable code signing locally by setting export CSC_IDENTITY_AUTO_DISCOVERY=false for the current terminal session.

hyper (vercel/hyper)

Searching Database…

44.7K ·GitHub
Hyper
这是什么？Hyper 是一款终端模拟器，基于 Electron，采用网页技术（HTML、CSS、JavaScript/TypeScript）构建，目标是成为一个美观且可扩展的命令行界面。
这是终端应用，还是我可以嵌入自己项目中的库？它是一款独立的桌面终端应用（基于 Electron 和 React 构建），而不是可以导入到其他代码中的库。
我该如何安装和运行它？请下载适用于你所用平台的最新版本，或通过包管理器安装：macOS 上使用 Homebrew Cask，Windows 上使用 Chocolatey，Linux 上使用 AUR、Nix 或 Snapcraft。
自己构建时有哪些已知的坑？已知问题包括：node-pty 构建失败（可用 pnpm run rebuild-node-pty 修复）、在 macOS 上安装时出现 C++ 编译器错误（需要设置 CXX=clang++），以及运行 pnpm run dist 时出现 codesign 错误。
Hyper 支持哪些平台？Hyper 支持 Linux、macOS 和 Windows，并为每个平台提供了单独的安装说明。
Hyper 能通过插件和主题进行扩展吗？可以。Hyper 提供扩展 API，并附带示例扩展和示例主题；README 中还提到了一份社区插件和主题列表，名为“Awesome Hyper”。
为什么要用网页技术而不是原生应用来开发终端？该项目的目标是让网页开发者能够借助熟悉的开放网页标准（HTML/CSS/JS）来扩展和定制终端，而不是使用原生工具包，重点在于可扩展性和跨平台的一致界面。
最新版本一定能正常使用吗？包管理器中的版本（Homebrew Cask、Chocolatey、Snapcraft、AUR）可能会滞后，因此 README 建议直接从项目的 releases 页面下载最新版本。
What are similar projects?upterm, edex-ui, tabby, pear-desktop, wezterm, dsh-pet, nylas-mail, Motrix
Which topics is it in?terminal-emulator, terminal-emulators, electron, customization, css, html, plugin, gui, react, desktop-app, terminal, nodejs
Creator
vercel
Size
22.9 MB
Stars
44.7K
Updated
CommitAug 21Releasev3.4.1Jan 08
Age
10y
Commits · 90 Days