Easy-terminal NPM

Easy terminal

An easy to use web terminal without any dependency and minified.

Installation

npm i easy-terminal

Usage

see the example folder for a complete case.

import { EasyTerminal } from './node_modules/easy-terminal/index.js';
const terminalElement = window.document.getElementById('terminal'); // div where you want the terminal
new EasyTerminal({
    elementHtml: terminalElement,
    window: { show: true, title: 'EasyTerminal' },
    nativeCommands: true,
    welcome: 'Welcome to EasyTerminal',
    history: true,
    noEmptyCommand: true,
    customCommands: [
        {
            name: 'test',
            help: 'test command',
            method: async function (cmd) {
                return await cmd.select(objTest, true)
            }
        },
        {
            name: 'test2',
            help: 'test2 command',
            method: async function (cmd) {
                return await cmd.select(stringsTest, false)
            }
        },
        {
            name: 'askAge',
            help: 'ask age to user',
            method: async function (cmd) {
                const age = await cmd.ask('age ?', true);
                cmd.echo('Age: ' + age);
            }
        }
    ]
});

Config

Terminal Config

name	type	default	desc
window	Object	N/A	Some style for the termianal
welcome	String	null	Welcome message (first line)
elementHtml	HTMLElement	null	div where you want the terminal
data-ps	string	$	Char before command input
history	boolean	false	If yes you can access history with arrow up and down
noEmptyCommand	boolean	false	If true cancel empty command
nativeCommands	boolean	false	Native commands are help and clear
customCommands	ITerminalCommand	N/A	Pass you're commands here