CLI for Robot Framework PlatynUI
Project description
PlatynUI CLI
platynui-cli is the command-line tool for trying PlatynUI against the current desktop. Use it to check which providers are active, inspect the UI tree, test selectors, highlight targets, or capture quick diagnostic output.
[!WARNING] Preview package. Commands and output may still change.
Install
uv tool install --prerelease allow platynui-cli
Inside an existing virtual environment:
uv pip install --pre platynui-cli
# or
pip install --pre platynui-cli
Windows and Linux are the active targets. macOS packages currently contain stub backend support.
Try it
platynui-cli list-providers
platynui-cli info --format json
platynui-cli query "//control:Button[@Name='OK']"
platynui-cli highlight "//control:Button[@Name='OK']" --duration-ms 1200
platynui-cli screenshot screen.png
Useful command groups include query, snapshot, watch, focus, window, pointer, and keyboard. Run platynui-cli --help or platynui-cli <command> --help for the current command syntax.
Notes
- On Linux, make sure the accessibility stack is enabled and AT-SPI is running.
- Use
--format jsonon commands that support it when scripts need stable output. - Keyboard sequences use the same
<Ctrl+C>style syntax as the Python and Robot layers.
More information
- ../../docs/ - current working notes for CLI behavior, input handling, and platform details.
- ../../README.md - project overview.
The files in docs/ are working documentation for now and will be replaced or consolidated into proper user documentation later.
License
Apache-2.0. See the repository's LICENSE file.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file platynui_cli-0.12.0.dev330-py3-none-win_arm64.whl.
File metadata
- Download URL: platynui_cli-0.12.0.dev330-py3-none-win_arm64.whl
- Upload date:
- Size: 3.0 MB
- Tags: Python 3, Windows ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.9 {"installer":{"name":"uv","version":"0.11.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"CachyOS Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fce9c5e78eb02d782854d0534bab41b747ecb5450fc61514220831c30832fb63
|
|
| MD5 |
8b302257093b5c67e8117d21b19e2c96
|
|
| BLAKE2b-256 |
49f47b8c0161eaa07c1449a2b57e3d3c11c4ae26c0659350b0f50d6d77641588
|
File details
Details for the file platynui_cli-0.12.0.dev330-py3-none-win_amd64.whl.
File metadata
- Download URL: platynui_cli-0.12.0.dev330-py3-none-win_amd64.whl
- Upload date:
- Size: 3.1 MB
- Tags: Python 3, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.9 {"installer":{"name":"uv","version":"0.11.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"CachyOS Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4da483a1905994366f24237176e1a2a2a5b7591d7be260ebce525eb119803759
|
|
| MD5 |
0bd34088616b3578db0833f948e95db2
|
|
| BLAKE2b-256 |
db63f7a54e1df131f13d4f99a099f234f6afa15d6e112e1edea2b05527a04987
|
File details
Details for the file platynui_cli-0.12.0.dev330-py3-none-manylinux_2_34_x86_64.whl.
File metadata
- Download URL: platynui_cli-0.12.0.dev330-py3-none-manylinux_2_34_x86_64.whl
- Upload date:
- Size: 5.7 MB
- Tags: Python 3, manylinux: glibc 2.34+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.9 {"installer":{"name":"uv","version":"0.11.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"CachyOS Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f816e01c0a3a1c1fe2ea6b4c5cb61645cd663515767706f35f714c5cfc60ed47
|
|
| MD5 |
4c76812f61105cc7d49ee145b364ae33
|
|
| BLAKE2b-256 |
c6e0abe714df6bc1ab900b2457b1d9ff57742efd6cdaccaf6dd8c1ff926e4e4a
|
File details
Details for the file platynui_cli-0.12.0.dev330-py3-none-macosx_11_0_arm64.whl.
File metadata
- Download URL: platynui_cli-0.12.0.dev330-py3-none-macosx_11_0_arm64.whl
- Upload date:
- Size: 3.1 MB
- Tags: Python 3, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.9 {"installer":{"name":"uv","version":"0.11.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"CachyOS Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c4020801c29ed3c4d831c6068ef0865c0449daeb3c55cc08416c5fd51afa45d1
|
|
| MD5 |
c7b77ac07514ea7e29ddb3949dc22d15
|
|
| BLAKE2b-256 |
e303c3987801a9cd4e30dc6726c47b411d7cd5f3d977518ae7358b4957038dcc
|