edouardelasalles / lua-term Goto Github PK

lua-term is a Lua module for manipulating a terminal.

lua-term is available on Luarocks.

lua-term is available as an OpenBSD package. Use the proper Lua flavour to get the package for your Lua version:

# For Lua 5.1
$ doas pkg_add -r lua-term
# For Lua 5.2
$ doas pkg_add -r lua52-term
# For Lua 5.3
$ doas pkg_add -r lua53-term

Or install from ports:

$ cd /usr/ports/devel/lua-term
$ env FLAVOR=lua51 doas make install

    local term   = require 'term'
    local colors = term.colors -- or require 'term.colors'

    print(term.isatty(io.stdout)) -- true if standard output goes to the terminal

    print(colors.red 'hello')
    print(colors.red .. 'hello' .. colors.reset)
    print(colors.red, 'hello', colors.reset)

    -- The following functions take an optional IO handle (like io.stdout);
    -- io.stdout is the default if you don't specify one
    term.clear()    -- clears the screen
    term.cleareol() -- clears from the cursor to the end of the line
    --term.cursor.goto(1, 1) -- It will fail in Lua >= 5.2 because goto is a reserved word.
    term.cursor['goto'](1, 1) -- This will work on Lua >= 5.2, please use jump instead
    term.cursor.jump(1, 1) -- jump is just an alias for goto
    term.cursor.jump(io.stdout, 1, 1)
    term.cursor.goup(1)
    term.cursor.godown(1)
    term.cursor.goright(1)
    term.cursor.goleft(1)
    term.cursor.save()    -- save position
    term.cursor.restore() -- restore position

Some functions in lua-term take an optional file handle argument; if this is not provided, io.stdout is used.

Clear the terminal's contents.

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

Returns true if file is a TTY; false otherwise.

NOTE: This function has been deprecated in favor of luaposix's implementation. If you would like this functionality in the future, please use luaposix.

The following values are available in term.colors:

• reset
• clear (a synonym for reset)
• default (a synonym for reset)
• bright
• dim
• underscore
• blink
• reverse
• hidden

• black
• red
• green
• yellow
• blue
• magenta
• cyan
• white

• onblack
• onred
• ongreen
• onyellow
• onblue
• onmagenta
• oncyan
• onwhite

Every value in term.colors may be used in several ways:

print(colors.red 'hello')

print(colors.red .. 'hello' .. colors.reset)
print(colors.red, 'hello', colors.reset)

Place the cursor at (x, y).

An alias for term.cursor.goto.

Moves the cursor up nlines lines.

Moves the cursor down nlines lines.

Moves the cursor right ncols columns.

Moves the cursor left ncols columns.

Saves the cursor position.

Restores the cursor position.

If you are looking to simply provide coloration to a terminal application and would like to use a more "tag-like" API (ex. colors '%{red}hello%{reset}'), there is a Lua rock named ansicolors: https://github.com/kikito/ansicolors.lua