README.md
# Suitest JavaScript API
[](https://github.com/SuitestAutomation/suitest-js-api/blob/master/LICENSE)
[](https://www.npmjs.com/package/suitest-js-api)
[](https://circleci.com/gh/SuitestAutomation/suitest-js-api)
[](https://codeclimate.com/github/SuitestAutomation/suitest-js-api/test_coverage)
[](https://codeclimate.com/github/SuitestAutomation/suitest-js-api/maintainability)
[Suitest](https://suite.st) is a test automation and device manipulation tool
for living room devices and web browsers.
-------
With this JavaScript API you can create and run automated end-to-end tests
or write an automation plugin for other software.
[Detailed API docs][api docs] as well as other useful
resources about test automation are available on the
[Suitest website][docs]. To use the API you'll need a
[free Suitest account][registration].
## What is Suitest good for?
You can use Suitest for your end-to-end test automation, for operating physical
devices (like TV's or set-top boxes) in a remote office, for automating some of
your device maintenance tasks or for hunting down a nasty device-specific bug.
With Suitest you can:
- Control and execute commands on multiple devices at once.
- Schedule a particular action on a group of devices.
- Control local and remote devices with equal ease.
- Test and debug apps on local and remote devices.
- Easily create end-to-end automated tests for web apps and websites.
## Supported devices and platforms
Suitest currently supports the following types of devices:
- TV's and set-top boxes equipped with an infrared port. This includes most of
the currently available Smart TV's like Samsung, LG, Hisense, Philips, Panasonic, Sony,
Vizio etc.
- TV's, set-top boxes and mobile devices running Android (including FireTV)
- Microsoft Xbox One, Xbox Series S and X and Sony PlayStation 4 / 5 consoles
- Locally installed Chrome, Firefox, Safari and Edge
- Apple tvOS, iOS and iPadOS devices, including simulators
- Roku TVs, boxes and sticks
- Xfinity, XClass, Xumo and Sky devices
Suitest supports automating end-to-end testing of:
- HbbTV / Freeview Play apps
- Samsung Orsay and Tizen apps
- LG NetCast and webOS apps
- HTML apps for other TV's or set-top boxes
- Android TV and mobile apps (including FireTV)
- Apple TV (tvOS), iOS and iPadOS apps
- Xbox One and Xbox Series S and X apps
- PlayStation 4 / 5 apps
- Roku apps
- Sky apps
- VIDAA apps
- Vizio SmartCast apps
- Xfinity / XClass TV / Xumo TV apps
- Xumo (Entertainment OS) apps
- Traditional websites and web apps for desktop browsers.
## Contributing
Read our [contributing guide][] to learn about our development process, how to propose
bugfixes and improvements, and how to build and test your changes to Suitest JS API.
[api docs]: https://suite.st/docs/suitest-api/
[docs]: https://suite.st/docs/
[registration]: https://the.suite.st/registration
[contributing guide]: https://github.com/SuitestAutomation/suitest-js-api/blob/master/CONTRIBUTING.md