https://github.com/lucenden/unix-terminal-emulator
A simple plugin for emulating the unix terminal in the browser!
https://github.com/lucenden/unix-terminal-emulator
bash npm react typescript unix
Last synced: about 2 months ago
JSON representation
A simple plugin for emulating the unix terminal in the browser!
- Host: GitHub
- URL: https://github.com/lucenden/unix-terminal-emulator
- Owner: LucEnden
- License: mit
- Created: 2022-07-08T07:20:33.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-07-14T09:41:32.000Z (12 months ago)
- Last Synced: 2025-07-23T06:44:59.975Z (11 months ago)
- Topics: bash, npm, react, typescript, unix
- Language: TypeScript
- Homepage:
- Size: 4.44 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> This package is no longer being maintained. Feel free to copy, modify and distribute all the files from this repository without restrictions!
> (PS: a small shoutout would be much appreasiated)
---
# Terminal Emulator
 -
Inspired by .
---
- [Installation](#installation)
- [Documentation](#documentation)
- [Example usage](#example-usage)
- [Browser](#browser)
- [React](#react)
- [Do's and don'ts](#dos-and-donts)
- [Performance](#performance)
## Installation
You can install it via your preferred package manager:
```shell
npm i --save unix-terminal-emulator
```
```shell
yarn add unix-terminal-emulator
```
You can use the CDN version for simple imports in HTML:
```html
```
## Documentation
Checkout [the wiki](https://github.com/LucEnden/unix-terminal-emulator/wiki) of this repository for the documentation.
Generated with [TypeDoc](https://typedoc.org/)!
## Example usage
For more advanced examples, please click [this link](https://codesandbox.io/s/unix-terminal-emulator-example-5n9ylu?file=index.html).
### Browser
```javascript
import UnixTerminalEmulator from "unix-terminal-emulator"
const terminal = new UnixTerminalEmulator()
const command = {
text: "echo Hello, World!",
writeSpeed: "neutral",
output: "Hello, World!",
pauseBeforeOutput: 500,
}
terminal.writeCommand(command).run(() => {
console.log("Done!")
})
```
### React
```javascript
import React from "react"
import UnixTerminalEmulator from "unix-terminal-emulator"
export default function App() {
const command = {
text: "echo Hello, World!",
writeSpeed: "neutral",
output: "Hello, World!",
pauseBeforeOutput: 500,
}
return (
{
emulator.writeCommand(command).run(() => {
console.log("Done!")
})
}}
/>
)
}
```
## Do's and don'ts
Below are a few examples of do's and don'ts regarding building a command sequence.
```javascript
const terminal = new UnixTerminalEmulator()
```
---
:heavy_check_mark: Chain the commands you want to run in sequence before calling run (this is by design):
```javascript
// Chaining commands is by design
terminal
.writeCommand({
text: "echo foo",
writeSpeed: "neutral",
output: "foo",
pauseBeforeOutput: 500,
})
.pause(1000)
.writeCommand({
text: "echo bar",
writeSpeed: "neutral",
output: "bar",
pauseBeforeOutput: 500,
})
.run()
```
---
:heavy_check_mark: Call the sequence building commands in a non-chain fashion, as long as the run method is called last (this is by design):
```javascript
terminal.writeCommand({
text: "echo foo",
writeSpeed: "neutral",
output: "foo",
pauseBeforeOutput: 500,
})
terminal.pause(1000)
terminal.writeCommand({
text: "echo bar",
writeSpeed: "neutral",
output: "bar",
pauseBeforeOutput: 500,
})
terminal.run()
```
---
:warning: Adding commands to the sequence BEFORE run has finished will queue them for the current sequence (this is timing dependent and not recommended).
```javascript
terminal
.writeCommand({
text: "echo foo",
writeSpeed: "neutral",
output: "foo",
pauseBeforeOutput: 500,
})
.run()
// The command added bellow will be added to the current sequence
terminal.writeCommand({
text: "echo bar",
writeSpeed: "neutral",
output: "bar",
pauseBeforeOutput: 500,
})
// The command bellow in the setTimeout will not run in the first sequence, a new call to the run method is required in order to run it
setTimeout(() => {
terminal.writeCommand({
text: "echo baz",
writeSpeed: "neutral",
output: "baz",
pauseBeforeOutput: 500,
})
}, 10000)
```
---
:x: Calling the run method on a terminal instance before the previous call has finished will result in unexpected behavior
```javascript
terminal
.writeCommand({
text: "echo foo",
writeSpeed: "neutral",
output: "foo",
pauseBeforeOutput: 500,
})
.writeCommand({
text: "echo bar",
writeSpeed: "neutral",
output: "bar",
pauseBeforeOutput: 500,
})
.run()
terminal.run() // this brakes the sequence and will result in unexpected behavior
```
---
:x: Creating 2 terminal instances with the same wrapper and cursor ID will result in unexpected behavior
```javascript
const terminal1 = new UnixTerminalEmulator({
wrapperId: "same-wrapper-id",
cursorId: "same-cursor-id",
})
const terminal2 = new UnixTerminalEmulator({
wrapperId: "same-wrapper-id",
cursorId: "same-cursor-id",
})
terminal1
.writeCommand({
text: "echo foo",
writeSpeed: "neutral",
output: "foo",
pauseBeforeOutput: 500,
})
.run()
terminal2
.writeCommand({
text: "echo foo",
writeSpeed: "neutral",
output: "foo",
pauseBeforeOutput: 500,
})
.run()
```
## Performance
Bellow are performance charts based on different versions of the app. [Click here](tests/performance/performance_testing.md) for a detailed explanation about how the performance was tested. [Click here](https://docs.google.com/spreadsheets/d/e/2PACX-1vSAKSUTB6fm6-PQNgSEpBtxe9h_v1m2JiYnl--0hHiyvHMK8Yrdz16e5Y8X9kPmBm0HvIJPgchSufp4/pubhtml) for an interactive version of the graphs.
| Time per Run in MS | Time per Command in MS |
| ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
|  |  |