hyper/readme.md

![](https://github.com/zeit/art/blob/525bd1bb39d97dd3b91c976106a6d5cc5766b678/hyper/repo-banner.png)

[![Build Status](https://travis-ci.org/zeit/hyper.svg?branch=master)](https://travis-ci.org/zeit/hyper)
[![Build status](https://ci.appveyor.com/api/projects/status/txg5qb0x35h0h65p/branch/master?svg=true)](https://ci.appveyor.com/project/appveyor-zeit/hyper/branch/master)
[![Slack Channel](https://zeit-slackin.now.sh/badge.svg)](https://zeit.chat/)
[![Changelog #213](https://img.shields.io/badge/changelog-%23213-lightgrey.svg)](https://changelog.com/213)
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)

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

## Usage

[Download the latest release!](https://hyper.is/#installation)

If you're on macOS, you can also use [Homebrew Cask](https://caskroom.github.io/) to download the app by running these commands:

```bash
brew update
brew cask install hyper
```

If you're on windows, you can use [chocolatey](https://chocolatey.org/) to install the app by running the following command (package information can be found [here](https://chocolatey.org/packages/hyper/)):
```bash
choco install hyper
```
Note: the version of hyper available from chocolatey may not be the latest. Consider using the direct download link, https://hyper-updates.now.sh/download/win


## Contribute

1. Install the dependencies
  * If you are running Linux, install `icnsutils`, `graphicsmagick`, `xz-utils` and `rpm`
  * If you are running Windows, install `windows-build-tools` with `yarn global add windows-build-tools`.
2. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device
3. Install the dependencies: `yarn`
4. Build the code and watch for changes: `yarn run dev`
5. In another terminal tab/window/pane, run the app: `yarn run app`

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

```bash
yarn run dist
```

After that, you'll see the binary in the `./dist` folder!

### node-pty issues

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're 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).

## Related Repositories

- [Art](https://github.com/zeit/art/tree/master/hyper)
- [Website](https://github.com/zeit/hyper-website)
- [Sample Extension](https://github.com/zeit/hyperpower)
- [Sample Theme](https://github.com/zeit/hyperyellow)
Update repo banner (#794) * Update repo banner * Update link to new banner 2016-10-06 11:30:17 -08:00			`![](https://github.com/zeit/art/blob/525bd1bb39d97dd3b91c976106a6d5cc5766b678/hyper/repo-banner.png)`
Put logo on top 2016-07-27 05:31:13 -08:00
Update Travis CI badge URL (#793) * Update Travis CI badge URL * HyperTerm 👉 Hyper.app 2016-10-06 11:09:44 -08:00			`[![Build Status](https://travis-ci.org/zeit/hyper.svg?branch=master)](https://travis-ci.org/zeit/hyper)`
Show the status of the `master` build on AppVeyor Insted of the latest build, which can be a failed build from a PR 2017-01-31 02:23:18 -09:00			`[![Build status](https://ci.appveyor.com/api/projects/status/txg5qb0x35h0h65p/branch/master?svg=true)](https://ci.appveyor.com/project/appveyor-zeit/hyper/branch/master)`
Build badge is more important 2016-07-27 07:08:51 -08:00			`[![Slack Channel](https://zeit-slackin.now.sh/badge.svg)](https://zeit.chat/)`
Add Changelog episode badge to README (#543) Links to: https://changelog.com/213 2016-08-02 11:08:41 -08:00			`[![Changelog #213](https://img.shields.io/badge/changelog-%23213-lightgrey.svg)](https://changelog.com/213)`
Mention code style 2016-09-21 06:36:31 -08:00			`[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)`
Update README.md 2016-07-21 10:49:29 -08:00
New URL 2016-10-06 08:39:14 -08:00			`For more details, head to: https://hyper.is`
Update README.md 2016-07-15 08:22:55 -08:00
Clean up 2016-07-27 05:41:49 -08:00			`## Usage`
Update README.md 2016-07-15 08:22:55 -08:00
Avoid clicking on a word 2016-12-12 12:34:19 -09:00			`[Download the latest release!](https://hyper.is/#installation)`
Much more explicit 2016-07-27 07:12:16 -08:00
			`If you're on macOS, you can also use [Homebrew Cask](https://caskroom.github.io/) to download the app by running these commands:`
add homebrew cask install method (#273) 2016-07-19 09:44:44 -08:00
			```bash
tweak readme 2016-12-30 15:04:23 -09:00			`brew update`
			`brew cask install hyper`
add homebrew cask install method (#273) 2016-07-19 09:44:44 -08:00			```

Add instructions to install via Chocolatey (#1385) * add install via chocolatey * remove the empty line 2017-01-14 13:00:44 -09:00			`If you're on windows, you can use [chocolatey](https://chocolatey.org/) to install the app by running the following command (package information can be found [here](https://chocolatey.org/packages/hyper/)):`
			```bash
			`choco install hyper`
			```
update readme to warn that choco install gets an old version. (#1631) 2017-03-19 17:36:37 -08:00			`Note: the version of hyper available from chocolatey may not be the latest. Consider using the direct download link, https://hyper-updates.now.sh/download/win`

Add instructions to install via Chocolatey (#1385) * add install via chocolatey * remove the empty line 2017-01-14 13:00:44 -09:00
Minor improvements (#15) * Use caps * Comments for ignored stuff * Description added * Use start command for launch * Cosmetic changes 2016-07-02 11:03:45 -08:00			`## Contribute`
Readme: add dev build instructions (#3) 2016-07-02 09:57:32 -08:00
Add Windows support and first-class Linux support (#946) * `child_pty` => `pty.js` * Create a frameless window on Windows and Linux * Add a brand new UI for Linux and Windows :nail_care: * [Windows] Fix plugin installation * [Windows] Fix the `build` script * [Windows] Add a bigger `icon.ico` * [Mac] Add `WebKitAppRegion: drag` when running on macOS * Fix code style :thinking: * Add `appveyor.yml` * Fix code style (again) * [Windows] Fix AppVeyor's `install` script * [Windows] Try a new AppVeyor config * [Windows] Set the binary path so Spectron can run the tests * [Windows] Try to build on x64 * Try again to build on x64 * Try one more time :weary: * Throw an error to indicate that `pty.js` was built incorrectly * [Win/Linux] Add `display: hidden` to <Tabs /> if tabs.length === 1 * [Win/Linux] Reorganize SVGs – via @CodeTheory * [Win/Linux] Fix the hamburger menu height * Make the SVGs look better with `shape-rendering: crispEdges;` * [Win/Linux] Add config options for the window controls and the :hamburger: menu * Add `electron-squirrel-startup` dependency * [Win] Handle Squirrel commands * [Win/Linux] Fix default color for the :hamburger: and window controls – via @CodeTheory * [Win/Linux] Add some padding - via @CodeTheory * [Win/Linux] Add hover states – via @CodeTheory * [Win] Fix empty window/tab titles * [Win] Fix opening Preferences (#978) * [Win] Fix opening Preferences * Update ui.js * Update ui.js * Enhance messages and default editor * [Win] Add dependency instructions to the README.md [skip ci] * Fix code style * [Win/Linux] Check the number of open windows before quitting the app 2016-11-11 08:18:04 -09:00			`1. Install the dependencies`
Add `rpm` target 2016-11-19 11:56:04 -09:00			* If you are running Linux, install `icnsutils`, `graphicsmagick`, `xz-utils` and `rpm`
Use `yarn` for everything 2017-02-23 12:02:53 -09:00			* If you are running Windows, install `windows-build-tools` with `yarn global add windows-build-tools`.
doc: add platform specific build dependencies for electron (#660) These are all taken from: https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build 2016-08-29 14:32:06 -08:00			`2. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device`
Use `yarn` for everything 2017-02-23 12:02:53 -09:00			3. Install the dependencies: `yarn`
			4. Build the code and watch for changes: `yarn run dev`
			5. In another terminal tab/window/pane, run the app: `yarn run app`
Explain how to contribute in a more detailed way 2016-07-27 05:50:04 -08:00
Fixed gramatical errors should be using `this` as pointing to the next command not the previous command. 2016-10-09 09:25:34 -08:00			`To make sure that your code works in the finished application, you can generate the binaries like this:`
Readme: add dev build instructions (#3) 2016-07-02 09:57:32 -08:00
			```bash
Use `yarn` for everything 2017-02-23 12:02:53 -09:00			`yarn run dist`
Readme: add dev build instructions (#3) 2016-07-02 09:57:32 -08:00			```

Remove wrong info about builds (#682) 2016-09-05 03:57:30 -08:00			After that, you'll see the binary in the `./dist` folder!
doc: add platform specific build dependencies for electron (#660) These are all taken from: https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build 2016-08-29 14:32:06 -08:00
`pty.js` => `node-pty` 2017-01-15 06:34:07 -09:00			`### node-pty issues`
Update README.md 2017-01-06 17:14:52 -09:00
`pty.js` => `node-pty` 2017-01-15 06:34:07 -09:00			If after building during development you get an alert dialog related to `node-pty` issues,
Use `yarn` for everything 2017-02-23 12:02:53 -09:00			make sure its build process is working correctly by running `yarn run rebuild-node-pty`.
Update README.md 2017-01-06 17:14:52 -09:00
			`If you're 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).

Use links for related repos 2016-07-27 07:03:50 -08:00			`## Related Repositories`
Clean up 2016-07-27 05:41:49 -08:00
Make "Art" link to hyper dir in the art repo 2016-10-16 08:50:53 -08:00			`- [Art](https://github.com/zeit/art/tree/master/hyper)`
HyperTerm 👉 Hyper.app 2016-10-06 09:33:08 -08:00			`- [Website](https://github.com/zeit/hyper-website)`
Use links for related repos 2016-07-27 07:03:50 -08:00			`- [Sample Extension](https://github.com/zeit/hyperpower)`
Unneeded space 2016-08-08 07:28:08 -08:00			`- [Sample Theme](https://github.com/zeit/hyperyellow)`