hyper

(★ 44,699)

A terminal built on web technologies

File Explorer

  • .editorconfig
  • .eslintignore
  • .eslintrc.json
  • .gitattributes
  • .gitignore
  • .npmrc
  • ava-e2e.config.js
  • ava.config.js
  • babel.config.json
  • electron-builder-linux-ci.json
  • electron-builder.json
  • LICENSE
  • package.json
  • PLUGINS.md
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • README.md
  • release.js
  • tsconfig.base.json
  • tsconfig.eslint.json
  • tsconfig.json
  • webpack.config.ts

# Installation Guide

node
Prerequisites

Setup Steps

corepack enable pnpm

Enable pnpm using Corepack.

pnpm install

Install project dependencies.

pnpm run dev

Build the code and watch for changes.

pnpm run app

Launch the Electron app.

Key Commands

pnpm install

Install all package dependencies required for the project.

pnpm run dev

Start build tasks in development mode and watch for file changes.

pnpm run app

Launch the Hyper terminal application being developed.

pnpm run dist

Generate binary packages for final distribution.

pnpm run rebuild-node-pty

Rebuild the node-pty module to resolve build issues.

On macOS, set export CXX=clang++ for compiler errors or export CSC_IDENTITY_AUTO_DISCOVERY=false for codesign issues if necessary.

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Release Timeline

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

brew install

View Details ▼

Install a Homebrew formula or cask.

brew install {{formula|cask}}

Install a formula/cask:

brew install {{[-s|--build-from-source]}} {{formula}}

Build and install a formula from source (dependencies will still be installed from bottles):

brew install {{[-n|--dry-run]}} {{formula|cask}}

Download the manifest, print what would be installed but don't actually install anything:

🔍

brew update

View Details ▼

Fetch the newest version of Homebrew and all formulae from GitHub using `git` and perform any necessary migrations.
To upgrade all installed formulae, use `brew upgrade`.

brew {{[up|update]}}

Fetch the newest version of Homebrew and all formulae:

🔍

corepack

View Details ▼

Zero-runtime-dependency package acting as bridge between Node projects and their package managers.

corepack enable

Add the Corepack shims to the Node.js installation directory to make them available as global commands:

corepack enable --install-directory {{path/to/directory}}

Add the Corepack shims to a specific directory:

corepack disable

Remove the Corepack shims from the Node.js installation directory:

🔍

nix-env

View Details ▼

Manipulate or query Nix user environments.

nix-env {{[-q|--query]}}

List all installed packages:

nix-env {{[-q|--query]}} {{search_pattern}}

Query installed packages (`regex` is supported):

nix-env {{[-qa|--query --available]}} {{search_pattern}}

Query available packages from the Nixpkgs registry:

🔍

pnpm

View Details ▼

Fast, disk space efficient package manager for Node.js.
Manage Node.js projects and their module dependencies.

pnpm init

Create a `package.json` file:

pnpm {{[i|install]}}

Download all the packages listed as dependencies in `package.json`:

pnpm add {{module_name}}@{{version}}

Download a specific version of a package and add it to the list of dependencies in `package.json`:

🔍

paru

View Details ▼

An AUR helper and pacman wrapper.
See also: `pacman`, `yay`.

paru {{package_name_or_search_term}}

Interactively search for and install a package:

paru

Synchronize and update all packages:

paru -Sua

Upgrade AUR packages:

🔍

codesign

View Details ▼

Create and manipulate code signatures for macOS.

codesign --sign "{{My Company Name}}" {{path/to/application_file.app}}

Sign an application with a certificate:

codesign --verify {{path/to/application_file.app}}

Verify the certificate of an application:

🔍

xcodebuild

View Details ▼

Build Xcode projects.

xcodebuild -workspace {{workspace_name.workspace}} -scheme {{scheme_name}} -configuration {{configuration_name}} clean build SYMROOT={{SYMROOT_path}}

Build workspace:

xcodebuild -target {{target_name}} -configuration {{configuration_name}} clean build SYMROOT={{SYMROOT_path}}

Build project:

xcodebuild -showsdks

Show SDKs:

🔍

choco install

View Details ▼

Install one or more packages with Chocolatey.

choco install {{package1 package2 ...}}

Install one or more packages:

choco install {{path\to\packages_file.config}}

Install packages from a custom configuration file:

choco install {{path\to\file}}

Install a specific `.nuspec` or `.nupkg` file:

// repository documentation