hyper
A terminal built on web technologies
File Explorer
- bug_report.md
- feature_request.md
- codeql-analysis.yml
- e2e_comment.yml
- nodejs.yml
- dependabot.yml
- pull_request_template.md
- .gitignore
- pre-push
- launch.json
- config-default.json
- import.ts
- init.ts
- migrate.ts
- open.ts
- paths.ts
- schema.json
- windows.ts
- darwin.json
- linux.json
- win32.json
- darwin.ts
- edit.ts
- help.ts
- shell.ts
- tools.ts
- view.ts
- window.ts
- menu.ts
- node-pty+1.0.0.patch
- extensions.ts
- install.ts
- icon.png
- icon96x96.png
- contextmenu.ts
- window.ts
- cli-install.ts
- colors.ts
- map-keys.ts
- renderer-utils.ts
- shell-fallback.ts
- system-context-menu.ts
- to-electron-background-color.ts
- window-utils.ts
- .npmrc
- auto-updater-linux.ts
- commands.ts
- config.ts
- index.html
- index.ts
- notifications.ts
- notify.ts
- package.json
- plugins.ts
- pnpm-lock.yaml
- pnpm-workspace.yaml
- rpc.ts
- session.ts
- tsconfig.json
- updater.ts
- icons.svg
- cp-snapshot.js
- download-mksnapshot.js
- mk-snapshot.js
- notarize.js
- rimraf-standalone.js
- snapshot-libs.js
- yarn-standalone.js
- after-install.tpl
- hyper
- entitlements.plist
- hyper
- hyper
- hyper.cmd
- installer.nsh
- canary.icns
- canary.ico
- icon.fig
- icon.icns
- icon.ico
- api.ts
- index.ts
- config.ts
- header.ts
- index.ts
- notifications.ts
- sessions.ts
- term-groups.ts
- ui.ts
- updater.ts
- header.tsx
- new-tab.tsx
- notification.tsx
- notifications.tsx
- searchBox.tsx
- split-pane.tsx
- style-sheet.tsx
- tab.tsx
- tabs.tsx
- term-group.tsx
- term.tsx
- terms.tsx
- header.ts
- hyper.tsx
- notifications.ts
- terms.ts
- index.ts
- sessions.ts
- term-groups.ts
- ui.ts
- configure-store.dev.ts
- configure-store.prod.ts
- configure-store.ts
- write-middleware.ts
- config.ts
- effects.ts
- file.ts
- ipc-child-process.ts
- ipc.ts
- notify.ts
- object.ts
- paste.ts
- plugins.ts
- rpc.ts
- term-groups.ts
- command-registry.ts
- index.tsx
- rpc.ts
- selectors.ts
- terms.ts
- v8-snapshot-util.ts
- is-hex-color.ts
- cli-api.test.ts
- to-electron-background-color.test.ts
- window-utils.test.ts
- index.ts
- config.d.ts
- index.d.ts
- notifications.d.ts
- sessions.d.ts
- tabs.d.ts
- term-groups.d.ts
- ui.d.ts
- updater.d.ts
- common.d.ts
- config.d.ts
- ext-modules.d.ts
- extend-electron.d.ts
- hyper.d.ts
- .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- Node.js
- pnpm
- GraphicsMagick (Linux)
- icnsutils (Linux Debian-based)
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.
# Use via CDN
jsDelivrjsDelivr 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
- 2023-07-13 4.0.0-canary.5 Pre-release
- 2023-07-01 4.0.0-canary.4 Pre-release
- 2023-01-29 4.0.0-canary.3 Pre-release
- 2023-01-07 4.0.0-canary.2 Pre-release
- 2023-01-08 V3.4.1
- 2023-01-01 4.0.0-canary.1 Pre-release
- 2023-01-01 3.4.0
- 2022-08-22 3.4.0-canary.1 Pre-release
- 2022-08-22 3.3.0
- 2022-04-15 3.2.3
Command Glossary
Commands referenced in this DOCs, explained below.
brew install
View Details ▼
brew install
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 ▼
brew update
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 ▼
corepack
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 ▼
nix-env
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 ▼
pnpm
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 ▼
paru
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 ▼
codesign
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 ▼
xcodebuild
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 ▼
choco install
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:
