ansi-escape-sequences

A simple library containing all known terminal ansi escape codes and sequences. Useful for adding colour to your command-line output, or building a dynamic text user interface.

Command-line usage

Format text in the terminal (bold red, in this case):

$ echo yeah | ansi format bold red
yeah

API Reference

Example

var ansi = require("ansi-escape-sequences");

• ansi-escape-sequences
  • .style : enum
  • .cursor
    • .up([lines]) ⇒ string
    • .down([lines]) ⇒ string
    • .forward([lines]) ⇒ string
    • .back([lines]) ⇒ string
    • .nextLine([lines]) ⇒ string
    • .previousLine([lines]) ⇒ string
    • .horizontalAbsolute(n) ⇒ string
    • .position(n, m) ⇒ string
  • .erase
    • .display(n) ⇒ string
    • .inLine(n) ⇒ string
  • .styles(effectArray) ⇒ string
  • .format(str, styleArray) ⇒ string

ansi.style : enum

Various formatting styles (aka Select Graphic Rendition codes).

Kind: static enum property of ansi-escape-sequences
Properties

Example

console.log(ansi.style.red + "this is red" + ansi.style.reset);

ansi.cursor

cursor-related sequences

Kind: static property of ansi-escape-sequences

• .cursor
  • .up([lines]) ⇒ string
  • .down([lines]) ⇒ string
  • .forward([lines]) ⇒ string
  • .back([lines]) ⇒ string
  • .nextLine([lines]) ⇒ string
  • .previousLine([lines]) ⇒ string
  • .horizontalAbsolute(n) ⇒ string
  • .position(n, m) ⇒ string

cursor.up([lines]) ⇒ string

Moves the cursor lines cells up. If the cursor is already at the edge of the screen, this has no effect

Kind: static method of cursor

cursor.down([lines]) ⇒ string

Moves the cursor lines cells down. If the cursor is already at the edge of the screen, this has no effect

Kind: static method of cursor

cursor.forward([lines]) ⇒ string

Moves the cursor lines cells forward. If the cursor is already at the edge of the screen, this has no effect

Kind: static method of cursor

cursor.back([lines]) ⇒ string

Moves the cursor lines cells back. If the cursor is already at the edge of the screen, this has no effect

Kind: static method of cursor

cursor.nextLine([lines]) ⇒ string

Moves cursor to beginning of the line n lines down.

Kind: static method of cursor

cursor.previousLine([lines]) ⇒ string

Moves cursor to beginning of the line n lines up.

Kind: static method of cursor

cursor.horizontalAbsolute(n) ⇒ string

Moves the cursor to column n.

Kind: static method of cursor

cursor.position(n, m) ⇒ string

Moves the cursor to row n, column m. The values are 1-based, and default to 1 (top left corner) if omitted.

Kind: static method of cursor

ansi.erase

erase sequences

Kind: static property of ansi-escape-sequences

• .erase
  • .display(n) ⇒ string
  • .inLine(n) ⇒ string

erase.display(n) ⇒ string

Clears part of the screen. If n is 0 (or missing), clear from cursor to end of screen. If n is 1, clear from cursor to beginning of the screen. If n is 2, clear entire screen.

Kind: static method of erase

erase.inLine(n) ⇒ string

Erases part of the line. If n is zero (or missing), clear from cursor to the end of the line. If n is one, clear from cursor to beginning of the line. If n is two, clear entire line. Cursor position does not change.

Kind: static method of erase

ansi.styles(effectArray) ⇒ string

Returns an ansi sequence setting one or more effects

Kind: static method of ansi-escape-sequences

Example

> ansi.styles("green")
'\u001b[32m'
> ansi.styles([ "green", "underline" ])
'\u001b[32;4m'

ansi.format(str, styleArray) ⇒ string

A convenience function, applying the provided styles to the input string and then resetting.

Kind: static method of ansi-escape-sequences

Example

> ansi.format("what?", "green")
'\u001b[32mwhat?\u001b[0m'
> ansi.format("what?", ["green", "bold"])
'\u001b[32;1mwhat?\u001b[0m'

Install

As a library:

$ npm install ansi-escape-sequences --save

As a command-line tool:

$ npm install -g ansi-escape-sequences

© 2015 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.