Last updated
Was this helpful?
for manipulating the terminal
Set the absolute position of the cursor. x0 y0 is the top left of the screen.
Set the position of the cursor relative to its current position.
Move cursor up a specific amount of rows. Default is 1.
Move cursor down a specific amount of rows. Default is 1.
Move cursor forward a specific amount of columns. Default is 1.
Move cursor backward a specific amount of columns. Default is 1.
Move cursor to the left side.
Save cursor position.
Restore saved cursor position.
Get cursor position.
Move cursor to the next line.
Move cursor to the previous line.
Hide cursor.
Show cursor.
Erase from the current cursor position up the specified amount of rows.
Erase from the current cursor position to the end of the current line.
Erase from the current cursor position to the start of the current line.
Erase the entire current line.
Erase the screen from the current line down to the bottom of the screen.
Erase the screen from the current line up to the top of the screen.
Erase the screen and move the cursor the top left position.
Scroll display up one line.
Scroll display down one line.
Clear the terminal screen. (Viewport)
Clear the whole terminal, including scrollback buffer. (Not just the visible part of it)
Output a beeping sound.
Create a clickable link.
Display an image.
Currently only supported on iTerm2 >=3
Type: Buffer
Buffer of an image. Usually read in with fs.readFile().
Type: object
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
Type: string
Default: process.cwd()
Creates an escape code to display an "annotation" in iTerm2.
An annotation looks like this when shown:
Type: string
The message to display within the annotation.
The | character is disallowed and will be stripped.
Type: object
length
Type: number
Default: The remainder of the line
Nonzero number of columns to annotate.
x
Type: number
Default: Cursor position
Starting X coordinate.
Must be used with y and length.
y
Type: number
Default: Cursor position
Starting Y coordinate.
Must be used with x and length.
isHidden
Type: boolean
Default: false
Create a "hidden" annotation.
Annotations created this way can be shown using the "Show Annotations" iTerm command.
Use to detect link support.
See for a higher-level module.
of the current directory to help semantic history and enable .
See the for more information.
- ANSI escape codes for styling strings in the terminal
Tidelift helps make open source sustainable for maintainers while giving companies assurances about security, maintenance, and licensing for their dependencies.
