# terminal-control

> Terminal escape codes made easy. Get in full control.

Latest version **0.0.4** (published 2014-07-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install terminal-control
pnpm add terminal-control
yarn add terminal-control
bun add terminal-control
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2014-07-29 |
| First published | 2014-07-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Adam Paszke |
| Maintainers | wesolyromek |
| Keywords | terminal, ansi, escape, code |

## Links

- npm: https://www.npmjs.com/package/terminal-control
- Repository: https://github.com/wesolyromek/terminal-control
- Issues: https://github.com/wesolyromek/terminal-control/issues
- npm.io page: https://npm.io/package/terminal-control

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2014-07-29
- 0.0.3 — 2014-07-27
- 0.0.2 — 2014-07-27
- 0.0.1 — 2014-07-26

## README

terminal-control
================

Terminal escape codes made easy. Get in full control.

If your application runs in different environments, don't worry. The init function checks if the process runs in a tty. If it's not, no escape codes will be output even if you call the methods. You can override this behavior by calling ```init(true)```.

# Installation
Run the following commands to download and install the package:

```sh
$ npm install terminal-control
```

#Usage

```
var term = require('terminal-control').init().autoClean();

term.setBold(true);
term.moveCursorTo(5,5);
console.log('This text is displayed with an offset!');
```

#Docs

###Init

* **init([override])**                  - initialize and check if the programm runs in a tty (if override != true)
* **autoClean()**                       - automatically reset text style to default on process exit

###Text style

* **resetTextStyle()**                  - restore default text style
* **setBold([set])**                    - turn bold on or off (calling without argument toggles)
* **setLowIntensity([set])**            - turn low intensity on or off (calling without argument toggles)
* **setUnderline([set])**               - turn underline on or off (calling without argument toggles)
* **setBlinking([set])**                - turn blinking on or off (calling without argument toggles)
* **setInvisible([set])**               - turn invisible text on or off (calling without argument toggles)

###Window size

* **setWindowSize(top, bottom)**        - set top and bottom line of a window

###Cursor movement

* **moveCursorUp([lines])**             - move cursor up by a number of lines (default 1)
* **moveCursorDown([lines])**           - move cursor down by a number of lines (default 1)
* **moveCursorRight([columns])**        - move cursor right by number of columns (default 1)
* **moveCursorLeft([columns])**         - move cursor left by number of columns (default 1)
* **moveCursorToUpperLeft()**           - move cursor to the upper left corner
* **moveCursorTo(x,y)**                 - move cursor to desired position
* **scrollUp([lines])**                 - scroll up by a number of lines (default 1)
* **scrollDown([lines])**               - scroll down by a number of lines (default 1)
* **nextLine()**                        - go to new line
* **saveCursor()**                      - save cursor position and text attributes
* **restoreCursor()**                   - restore saved cursor position and text attributes

###Clear line

* **clearLineCursorRight()**            - clear text in a line on the right from the cursor
* **clearLineCursorLeft()**             - clear text in a line on the left from the cursor
* **clearLine()**                       - clear current line

###Clear screen

* **clearScreenCursorDown()**           - clear text upon cursor
* **clearScreenCursorUp()**             - clear text below cursor
* **clearScreen()**                     - clear whole screen (doesn't reset the position)

###Others

* **ringBell()**                        - ring the terminal bell

#License

See the [LICENSE](./LICENSE) file.

---
_Source: https://npm.io/package/terminal-control · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._