README.md 4.7 KB
Newer Older
E
Eugene Pankov 已提交
1
![](https://github.com/Eugeny/terminus/raw/master/docs/readme.png)
A
allcontributors[bot] 已提交
2
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors)
E
Eugene Pankov 已提交
3

E
Eugene Pankov 已提交
4
<p align="center">
E
Eugene 已提交
5 6
  <a href="https://raw.githubusercontent.com/Eugeny/terminus/master/LICENSE"><img alt="GitHub" src="https://img.shields.io/github/license/eugeny/terminus.svg?label=License&style=flat-square"></a> <a href="https://travis-ci.org/Eugeny/terminus"><img alt="Travis (.org)" src="https://img.shields.io/travis/Eugeny/terminus.svg?label=CI&logo=travis&logoColor=white&style=flat-square"></a>
  <a href="https://ci.appveyor.com/project/Eugeny/terminus"><img alt="AppVeyor" src="https://img.shields.io/appveyor/ci/eugeny/terminus.svg?label=CI&logo=appveyor&logoColor=white&style=flat-square"></a>
E
Eugene Pankov 已提交
7
</p>
E
docs  
Eugene Pankov 已提交
8

E
Eugene Pankov 已提交
9
<p align="center">
E
Eugene 已提交
10
  <a href="https://github.com/Eugeny/terminus/releases/latest"><img alt="GitHub All Releases" src="https://img.shields.io/github/downloads/eugeny/terminus/total.svg?label=DOWNLOAD&logo=github&style=for-the-badge"></a> <a href="https://ci.appveyor.com/project/Eugeny/terminus/build/artifacts"><img src="https://img.shields.io/badge/download-nightly%20build-magenta.svg?logo=appveyor&style=for-the-badge"/></a> <a href="https://gitter.im/terminus-terminal/community"><img alt="Gitter" src="https://img.shields.io/gitter/room/terminus/community.svg?color=blue&logo=gitter&style=for-the-badge"></a> 
E
Eugene Pankov 已提交
11
</p>
E
Eugene Pankov 已提交
12

E
docs  
Eugene Pankov 已提交
13 14
----

E
Eugene 已提交
15
**Terminus** is a highly configurable terminal emulator for Windows, macOS and Linux
E
docs  
Eugene Pankov 已提交
16 17

  * Theming and color schemes
E
Eugene Pankov 已提交
18
  * Fully configurable shortcuts
E
Eugene 已提交
19
  * Split panes
E
Eugene 已提交
20
  * Remembers your tabs
E
Eugene 已提交
21
  * PowerShell (and PS Core), WSL, Git-Bash, Cygwin, Cmder and CMD support
E
Eugene 已提交
22
  * Integrated SSH client and connection manager
E
Eugene 已提交
23 24 25
  * Full Unicode support including double-width characters
  * Doesn't choke on fast-flowing outputs
  * Proper shell experience on Windows including tab completion (via Clink)
E
docs  
Eugene Pankov 已提交
26

E
Eugene Pankov 已提交
27 28 29

[![Buy me a coffee](https://github.com/Eugeny/terminus/raw/master/docs/kofi.png)](https://ko-fi.com/eugeny)

E
Eugene 已提交
30 31 32 33 34
---

* **Terminus is** an alternative to Windows' standard terminal (conhost), PowerShell ISE, PuTTY or iTerm

* **Terminus is not** a new shell or a MinGW or Cygwin replacement. Neither is it lightweight - if RAM usage is of importance, consider [Conemu](https://conemu.github.io) or [Alacritty](https://github.com/jwilm/alacritty) 
E
Eugene Pankov 已提交
35

E
docs  
Eugene Pankov 已提交
36 37
---

E
docs  
Eugene Pankov 已提交
38 39
# Plugins

E
Eugene 已提交
40
Plugins and themes can be installed directly from the Settings view inside Terminus.
E
docs  
Eugene Pankov 已提交
41 42

  * [clickable-links](https://github.com/Eugeny/terminus-clickable-links) - makes paths and URLs in the terminal clickable
E
Eugene Pankov 已提交
43
  * [shell-selector](https://github.com/Eugeny/terminus-shell-selector) - a quick shell selector pane
D
Domain 已提交
44
  * [title-control](https://github.com/kbjr/terminus-title-control) - allows modifying the title of the terminal tabs by providing a prefix, suffix, and/or strings to be removed
S
Scott Kirkpatrick 已提交
45
  * [quick-cmds](https://github.com/Domain/terminus-quick-cmds) - quickly send commands to one or all terminal tabs
E
Eugene Pankov 已提交
46
  * [save-output](https://github.com/Eugeny/terminus-save-output) - record terminal output into a file
E
Eugene 已提交
47 48
  * [scrollbar](https://github.com/kbjr/terminus-scrollbar) - adds a scrollbar to hterm tabs

E
Eugene 已提交
49 50
# Themes

E
Eugene 已提交
51 52 53 54 55 56
  * [hype](https://github.com/Eugeny/terminus-theme-hype) - a Hyper inspired theme
  * [relaxed](https://github.com/Relaxed-Theme/relaxed-terminal-themes#terminus) - the Relaxed theme for Terminus
  * [gruvbox](https://github.com/porkloin/terminus-theme-gruvbox)
  * [windows10](https://www.npmjs.com/package/terminus-theme-windows10)
  * [altair](https://github.com/yxuko/terminus-altair)
  
E
docs  
Eugene Pankov 已提交
57 58
---

E
docs  
Eugene Pankov 已提交
59 60
# Contributing

E
Eugene Pankov 已提交
61
Pull requests and plugins are welcome!
E
docs  
Eugene Pankov 已提交
62

E
Eugene 已提交
63
See [HACKING.md](https://github.com/Eugeny/terminus/blob/master/HACKING.md) and [API docs](http://ajenti.org/terminus-docs/) for information of how the project is laid out, and a very brief plugin development tutorial.
F
fossabot 已提交
64 65

## License
E
Eugene Pankov 已提交
66
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FEugeny%2Fterminus.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FEugeny%2Fterminus?ref=badge_large)
A
allcontributors[bot] 已提交
67 68 69 70 71 72 73 74 75 76 77 78

## Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
<table><tr><td align="center"><a href="http://www.russellmyers.com"><img src="https://avatars2.githubusercontent.com/u/184085?v=4" width="100px;" alt="Russell Myers"/><br /><sub><b>Russell Myers</b></sub></a><br /><a href="https://github.com/Eugeny/terminus/commits?author=mezner" title="Code">💻</a></td></tr></table>

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!