ansi-escapes 1.4.0

ANSI escape codes for manipulating the terminal

Homepage: https://github.com/sindresorhus/ansi-escapes

Platform: npm

Language: JavaScript

License: MIT

Keywords: ansi, terminal, console, cli, string, tty, escape, escapes, formatting, shell, xterm, log, logging, command-line, text, vt100, sequence, control, code, codes, cursor, iterm, iterm2

View on registry: https://www.npmjs.com/package/ansi-escapes

Direct download link: https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-1.4.0.tgz

Install: npm install [email protected]


ansi-escapes Build Status

ANSI escape codes for manipulating the terminal

Install

$ npm install --save ansi-escapes

Usage

const ansiEscapes = require('ansi-escapes');

// moves the cursor two rows up and to the left
process.stdout.write(ansiEscapes.cursorUp(2) + ansiEscapes.cursorLeft);
//=> '\u001b[2A\u001b[1000D'

API

cursorTo([x, [y]])

Set the absolute position of the cursor. x0 y0 is the top left of the screen.

Specify either both x & y, only x, or nothing.

cursorMove(x, [y])

Set the position of the cursor relative to its current position.

cursorUp(count)

Move cursor up a specific amount of rows. Default is 1.

cursorDown(count)

Move cursor down a specific amount of rows. Default is 1.

cursorForward(count)

Move cursor forward a specific amount of rows. Default is 1.

cursorBackward(count)

Move cursor backward a specific amount of rows. Default is 1.

cursorLeft

Move cursor to the left side.

cursorSavePosition

Save cursor position.

cursorRestorePosition

Restore saved cursor position.

cursorGetPosition

Get cursor position.

cursorNextLine

Move cursor to the next line.

cursorPrevLine

Move cursor to the previous line.

cursorHide

Hide cursor.

cursorShow

Show cursor.

eraseLines(count)

Erase from the current cursor position up the specified amount of rows.

eraseEndLine

Erase from the current cursor position to the end of the current line.

eraseStartLine

Erase from the current cursor position to the start of the current line.

eraseLine

Erase the entire current line.

eraseDown

Erase the screen from the current line down to the bottom of the screen.

eraseUp

Erase the screen from the current line up to the top of the screen.

eraseScreen

Erase the screen and move the cursor the top left position.

scrollUp

Scroll display up one line.

scrollDown

Scroll display down one line.

clearScreen

Clear the terminal screen.

beep

Output a beeping sound.

image(input, [options])

Display an image.

Currently only supported on iTerm >=2.9.

See term-img for a higher-level module.

input

Type: buffer

Buffer of an image. Usually read in with fs.readFile().

options

width
height

Type: string number

The width and height are given as a number followed by a unit, or the word "auto".

  • N: N character cells.
  • Npx: N pixels.
  • N%: N percent of the session's width or height.
  • auto: The image's inherent size will be used to determine an appropriate dimension.
preserveAspectRatio

Type: boolean
Default: true

iTerm.setCwd([path])

Type: string
Default: process.cwd()

Inform iTerm of the current directory to help semantic history and enable Cmd-clicking relative paths.

Related

  • ansi-styles - ANSI escape codes for styling strings in the terminal

License

MIT © Sindre Sorhus

Releases

  • 1.4.0 - April 17, 2016 20:37
  • 1.3.0 - March 09, 2016 09:33
  • 1.2.0 - March 05, 2016 09:29
  • 1.1.1 - January 10, 2016 01:16
  • 1.1.0 - August 17, 2015 08:54
  • 1.0.0 - August 14, 2015 15:26

Project Statistics

SourceRank 19
Dependencies 0
Dependent projects 94
Dependent repositories 7.81K
Total releases 6
Latest release
First release
Stars 94
Forks 3
Watchers 6
Contributors 1
Repo Size: 55.7 KB

Top Contributors See all

Sindre Sorhus

Something wrong with this page? Make a suggestion

Export .ABOUT file for this library

Last synced: 2016-12-05 06:04:58 UTC

Login to resync this project