Getting Started

Import input-terminal in your project:

import { Terminal, Command } from "input-terminal";
Copy

Or import specific components:

import { 
  Terminal, 
  Command, 
  ExitObject, 
  TermBin, 
  TermHistory, 
  TermOptions, 
  TermOutput, 
  built_ins 
} from "input-terminal";
Copy

Minimal Setup

The simplest way to get started is with just an <input> element:

<input type="text" id="terminal" />
Copy

Then, create a new Terminal instance targeting the element. This creates a functional terminal that can execute commands, though output will only be accessible programmatically or through event listeners.

import { Terminal, Command } from "input-terminal";

const input = document.getElementById("terminal") as HTMLInputElement;
const terminal = new Terminal(input);

terminal.bin.add(new Command("hello", (args, options, terminal) => {
  terminal.stdout("Hello, World!");
  return { message: "Hello, World!" };
}));

terminal.init();
Copy

Call terminal.init() to attach input listeners and initialize the input as a terminal.

Destroying the Terminal

Call terminal.destroy() when you want to stop the terminal without discarding its state. This detaches input and output listeners and marks the terminal as not started. It does not clear command history, registered commands, input text, or output contents.

terminal.destroy();

// Later, re-attach listeners and resume
terminal.init();
Copy

After destroy(), you can call init() again to reattach listeners. Built-in commands are only installed once, so re-initializing will not duplicate them.

With Output Element

If you want to render output to a DOM element, you can do so by passing the output element to the Terminal constructor:

<input type="text" id="terminal" />
<pre id="output"></pre>
Copy

const input = document.getElementById("terminal") as HTMLInputElement;
const output = document.getElementById("output") as HTMLElement;

const terminal = new Terminal(input, output);

terminal.init();
Copy

The terminal will render logs printed via stdout and stderr to the output element.