TermAdaptor

Demo

Built on top of tmux and many other libraries, Cybergod is capable of understanding and interacting terminal interface with both text-only and multimodal modes. With the help of wcwidth, cursor is placed precisely at the right position even if there are multi-width unicode chars (CJK characters for example).

Code can be found here.

To interact with the environment programmatically, check out here

# env: TmuxEnvironment
env.send_key("vim")
env.send_key("Enter")

Terminal parsing (colorless):

Terminal parsing (colorful):

Terminal screenshot converted from HTML (cursor in red):

Terminal with dark theme and grayscale effects except for the cursor:

You can also have a block-styled cursor:

Change the cursor character to underline:

Override the cursor block style:

Usage

Terminal environment integration

First, install required binaries:

sudo apt install -y tmux tmuxp aha

Next, install the following dependencies:

pip install parse playwright beautifulsoup4

# setup playwright if you want to take terminal screenshots
playwright install chromium

Finally copy the lib.py, then run test_lib.py next to the lib.py.

The SESSION_COMMAND in test_lib.py is the initial terminal environment command to be executed. Change it according to your need.

To view the environment:

preview = session.preview_html(show_cursor=True,wrap_html=True, dark_mode=True, grayscale=True)

To interact with the environment:

# note that both special key and literal strings can be sent.
env.send_key("date")
env.send_key("Enter") # special key

A full mapping from conventional special keys to standard Tmux special keys can be generated by running generate_funckey_alias.py

You can read the test file for further integration.

Star History