Skip to content

Commit

Permalink
Update docs and website
Browse files Browse the repository at this point in the history
  • Loading branch information
sedwards2009 committed Jan 1, 2025
1 parent a2e83ef commit 0375dbd
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 33 deletions.
33 changes: 8 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,42 +4,31 @@

Main website: [extraterm.org](https://extraterm.org)

[![Build Status](https://dev.azure.com/simon0627/extraterm/_apis/build/status/sedwards2009.extraterm?branchName=master)](https://dev.azure.com/simon0627/extraterm/_build/latest?definitionId=1&branchName=master)

# About

Extraterm is an open source project to build a terminal emulator and expand it with new features to support modern workflows and do more than just act like a glorified teletype.

More background information is in the [Why document](https://extraterm.org/why.html).

* *Capture and reuse command output as new command input*
* *Manipulate and copy text without leaving the keyboard*
* *Slice and dice command output like a text editor*
* *Display images directly*
* *See the [Features list](https://extraterm.org/features.html) for more*

![Directly edit and execute command output](docs/edit_direct.gif)

See the [Features and Screenshots](https://extraterm.org/features.html)

The primary developer is [Simon Edwards](mailto:[email protected]). Extraterm logos were designed and provided by [Gabriel Harel](https://github.com/g-harel).

# Features

* Supports Linux and macOS, and on Windows WSL, CMD, and PowerShell
* Built in SSH client
* Images in terminal
* 24 bit color
* Color emoji on all platforms
* Font ligatures
* Keyboard friendly "Command Palette"
* Text zoom
* [Output colorizing](https://extraterm.org/guide.html#colorizer)
* [Multiple windows and tiling](https://extraterm.org/guide.html#splits-and-panes)
* [Configurable key bindings](https://extraterm.org/guide.html#keybindings)
* Global shortcuts
* Unicode support
* Search
* [Easily insert Emoji](https://extraterm.org/guide.html#insert-emoji)
* Search
* Unicode support
* Text zoom
* Global shortcuts
* Shell integration; can isolate and 'frame' command output. (bash, zsh and fish supported)
* Easy uploads and downloads using the shell integration
* Previous command output can be used as input for new commands
Expand All @@ -54,16 +43,10 @@ See the more detailed [features list](https://extraterm.org/features.html).

# Download

Extraterm is available in two flavours: the classic Extraterm is based on Electron, and the lighter faster Qt based version which is the future of Extraterm but is in development and lacking features. Both can run on Linux, Windows, and macOS.

* [Try the classic version here](https://github.com/sedwards2009/extraterm/releases/tag/v0.59.4) (versions before 0.60.0)
* [Try the latest Qt based version here](https://github.com/sedwards2009/extraterm/releases) (version 0.60.0 and later

Both can be installed at the same time, without problems.

:warning: Extraterm is in development and roughly 'beta' in quality. It is generally stable, but don't be too surprised if you encounter a few bugs. Use at your own risk. :warning:
* [Modern Qt based version](https://github.com/sedwards2009/extraterm/releases) (version 0.60.0 and later)
* [Classic Electron based version](https://github.com/sedwards2009/extraterm/releases/tag/v0.59.4) (versions before 0.60.0). It is pretty old.

With that out of the way, the primary author does use it as their main terminal emulator on a daily basis. The basics are in place and it will run most common terminal applications such as vi, emacs and joe without problems and even more demanding applications such as midnight commander.
Both can be installed at the same time without problems.

Nightly builds of the `master` branch can be [downloaded here](https://storage.googleapis.com/extraterm_builds/index.html).

Expand Down
Binary file removed docs/edit_direct.gif
Binary file not shown.
15 changes: 11 additions & 4 deletions docs/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ It is currently in steady development and although not at a 1.0 release yet, it
Note: Many of these features are currently only present in the older Electron based version of Extraterm.


# SSH Client

Extraterm can act as an SSH client to connect to remote servers. Yes, even on Windows.


# Command Palette

Extraterm is designed for keyboard use first. The Command Palette makes it easy to find and execute any command without leaving the keyboard.
Expand Down Expand Up @@ -36,10 +41,6 @@ The “from” command lets you use previous command output as input for termina

![From command](from_command.gif)

Or you can edit the command output directly in place and execute the selection with `Ctrl+Shift+Enter`.

![Directly edit and execute command output](edit_direct.gif)


# Easy Downloads and Uploads

Expand All @@ -48,6 +49,12 @@ The shell integration makes uploading and downloading files easy without requiri
![Download](download.png)


## Colorizer

Colorizer scans the terminal output for certain patterns and words and colors them. This is useful for highlighting important text in command output such as "error" or "warning".

![colorizer_example.png](colorizer_example.png)

# Compatible

Backwards compatibility with the decades of existing terminal based applications and your decades of workflows and habits is very important. Extraterm supports your existing applications and doesn't require you to change your habits.
Expand Down
8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ Extraterm is more than just a terminal emulator. It provides a toolbox for worki
* Color emoji on all platforms
* Font ligatures
* Keyboard friendly "Command Palette"
* Text zoom
* [Output colorizing](https://extraterm.org/guide.html#colorizer)
* [Multiple windows and tiling](https://extraterm.org/guide.html#splits-and-panes)
* [Configurable key bindings](https://extraterm.org/guide.html#keybindings)
* Global shortcuts
* Unicode support
* Search
* [Easily insert Emoji](https://extraterm.org/guide.html#insert-emoji)
* Search
* Unicode support
* Text zoom
* Global shortcuts
* Shell integration; can isolate and 'frame' command output. (bash, zsh and fish supported)
* Easy uploads and downloads using the shell integration
* Previous command output can be used as input for new commands
Expand Down

0 comments on commit 0375dbd

Please sign in to comment.