LogoCua Documentation

Supported Commands

List of all commands supported by the Computer Server API (WebSocket and REST).

Commands Reference

This page lists all supported commands for the Computer Server, available via both WebSocket and REST API endpoints.

CommandDescription
versionGet protocol and package version info
run_commandRun a shell command
screenshotCapture a screenshot
get_screen_sizeGet the screen size
get_cursor_positionGet the current mouse cursor position
mouse_downMouse button down
mouse_upMouse button up
left_clickLeft mouse click
right_clickRight mouse click
double_clickDouble mouse click
move_cursorMove mouse cursor to coordinates
drag_toDrag mouse to coordinates
dragDrag mouse by offset
key_downKeyboard key down
key_upKeyboard key up
type_textType text
press_keyPress a single key
hotkeyPress a hotkey combination
scrollScroll the screen
scroll_downScroll down
scroll_upScroll up
copy_to_clipboardCopy text to clipboard
set_clipboardSet clipboard content
file_existsCheck if a file exists
directory_existsCheck if a directory exists
list_dirList files/directories in a directory
read_textRead text from a file
write_textWrite text to a file
read_bytesRead bytes from a file
write_bytesWrite bytes to a file
get_file_sizeGet file size
delete_fileDelete a file
create_dirCreate a directory
delete_dirDelete a directory
get_accessibility_treeGet accessibility tree (if supported)
find_elementFind element in accessibility tree
diorama_cmdRun a diorama command (if supported)