local-terminal

[![xterm](https://img.shields.io/badge/local-xterm-blue.svg)](https://xtermjs.org/) [![typescript](https://img.shields.io/badge/language-typescript-blue.svg)](https://www.tslang.cn/index.html) ![](https://img.shields.io/badge/license-MIT-000000.svg)

Usage no npm install needed!

<script type="module">
  import localTerminal from 'https://cdn.skypack.dev/local-terminal';
</script>

README

xterm typescript

Local Terminal

为 xterm 打造本地终端模拟功能

由于直接使用 xterm 模拟本地终端十分困难,官方 demo 也很简单,不能满足复杂需求。

所以,该项目希望提供一套常用的终端操作,帮助快速模拟本地终端。

特性

  • 支持 xterm 4.x
  • 支持 ts
  • 支持多行输入
  • 支持历史命令记录

使用方法

$ npm install local-terminal

安装完成之后参考 demo 使用

API

constructor(xterm, option)

  • xterm: xterm.js 实例
  • option(可选): local-terminal 配置

option 的默认配置如下:

{
    historySize: 10
}

read(prompt, continuationPrompt) -> Promise

  • prompt: 命令行提示符
  • continuationPrompt(可选): 多行输入时的提示符

读取输入后的单行命令,返回一个 Promise 用于处理完成输入后的操作:

const local = new localTerminal(xterm)
local.read("~ ")
    .then(input => console.log("command line: " + input))
    .catch(error => console.error("error: " + error))

print(message)

输入命令

clear()

清屏