@sailfish-ai/headless 5.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -0
- package/package.json +31 -0
package/README.md
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# [](https://xtermjs.org)
|
|
2
|
+
|
|
3
|
+
⚠ This package is experimental
|
|
4
|
+
|
|
5
|
+
`xterm-headless` is a headless terminal that can be run in node.js. This is useful in combination with the frontend [`xterm`](https://www.npmjs.com/package/xterm) for example to keep track of a terminal's state on a remote server where the process is hosted.
|
|
6
|
+
|
|
7
|
+
## Getting Started
|
|
8
|
+
|
|
9
|
+
First, you need to install the module, we ship exclusively through npm, so you need that installed and then add xterm.js as a dependency by running:
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
npm install xterm-headless
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Then import as you would a regular node package. The recommended way to load `xterm-headless` is with TypeScript and the ES6 module syntax:
|
|
16
|
+
|
|
17
|
+
```javascript
|
|
18
|
+
import { Terminal } from '@sailfish-ai/headless';
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## API
|
|
22
|
+
|
|
23
|
+
The full API for `xterm-headless` is contained within the [TypeScript declaration file](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm-headless.d.ts), use the branch/tag picker in GitHub (`w`) to navigate to the correct version of the API.
|
|
24
|
+
|
|
25
|
+
Note that some APIs are marked *experimental*, these are added to enable experimentation with new ideas without committing to support it like a normal [semver](https://semver.org/) API. Note that these APIs can change radically between versions, so be sure to read release notes if you plan on using experimental APIs.
|
|
26
|
+
|
|
27
|
+
### Addons
|
|
28
|
+
|
|
29
|
+
Addons in `xterm-headless` work the [same as in `xterm`](https://github.com/xtermjs/xterm.js/blob/master/README.md#addons) with the one caveat being that the addon needs to be packaged for node.js and not use any DOM APIs.
|
|
30
|
+
|
|
31
|
+
Currently no official addons are packaged on npm.
|
package/package.json
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@sailfish-ai/headless",
|
|
3
|
+
"description": "A headless terminal component that runs in Node.js",
|
|
4
|
+
"version": "5.5.0",
|
|
5
|
+
"main": "lib-headless/xterm-headless.js",
|
|
6
|
+
"module": "lib-headless/xterm-headless.mjs",
|
|
7
|
+
"types": "typings/xterm-headless.d.ts",
|
|
8
|
+
"exports": {
|
|
9
|
+
"types": "./typings/xterm-headless.d.ts",
|
|
10
|
+
"import": "./lib-headless/xterm-headless.mjs",
|
|
11
|
+
"require": "./lib-headless/xterm-headless.js"
|
|
12
|
+
},
|
|
13
|
+
"repository": "https://github.com/xtermjs/xterm.js",
|
|
14
|
+
"license": "MIT",
|
|
15
|
+
"keywords": [
|
|
16
|
+
"cli",
|
|
17
|
+
"command-line",
|
|
18
|
+
"console",
|
|
19
|
+
"pty",
|
|
20
|
+
"shell",
|
|
21
|
+
"ssh",
|
|
22
|
+
"styles",
|
|
23
|
+
"terminal-emulator",
|
|
24
|
+
"terminal",
|
|
25
|
+
"tty",
|
|
26
|
+
"vt100",
|
|
27
|
+
"webgl",
|
|
28
|
+
"xterm"
|
|
29
|
+
],
|
|
30
|
+
"commit": "92b8a5db459ea3c341c9c2a5c09ffbd1fe062caa"
|
|
31
|
+
}
|