/vncdotool

A command line VNC client and python library

Primary LanguagePythonMIT LicenseMIT

https://img.shields.io/pypi/v/vncdotool:alt:PyPI

vncdotool

vncdotool is a command line VNC client. It can be useful to automating interactions with virtual machines or hardware devices that are otherwise difficult to control.

It's under active development and seems to be working, but please report any problems you have.

Quick Start

To use vncdotool you will need a VNC server. Most virtualization products include one, or use RealVNC, TightVNC or clone your Desktop using x11vnc.

Once, you have a server running you can install vncdotool from pypi:

pip install vncdotool

and then send a message to the vncserver with:

vncdo -s vncserveraddress type "hello world"

You can also take a screen capture with:

vncdo -s vncservername capture screen.png

More documentation can be found on Read the Docs.

Feedback

Comments, suggestions and patches are welcome and appreciated. They can be sent to via GitHub, vncdotool@googlegroups.com or sibson+vncdotool@gmail.com.

If you are reporting a bug or issue please include the version of both vncdotool and the VNC server you are using it with.

Acknowledgements

Thanks to Chris Liechti, techtonik and Todd Whiteman for developing the RFB and DES implementations used by vncdotool. Also, to the TigerVNC project for creating a community focus RFB specification document