Pre-release

This release is a pre-release and may not be stable for production use.

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 json on 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

The files in dev-docs/ are developer documentation for now and will be consolidated into user-facing docs (under docs/) later.

License

Apache-2.0. See the repository's LICENSE file.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.13.0.dev117)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for dbiehl from gravatar.com dbiehl

Credits

Author: Daniel Biehl

Requires

Python >=3.12

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

platynui_cli-0.13.0.dev1-py3-none-win_arm64.whl (3.0 MB view details)

Uploaded Python 3Windows ARM64

platynui_cli-0.13.0.dev1-py3-none-win_amd64.whl (3.1 MB view details)

Uploaded Python 3Windows x86-64

platynui_cli-0.13.0.dev1-py3-none-manylinux_2_34_x86_64.whl (5.8 MB view details)

Uploaded Python 3manylinux: glibc 2.34+ x86-64

platynui_cli-0.13.0.dev1-py3-none-manylinux_2_34_aarch64.whl (5.7 MB view details)

Uploaded Python 3manylinux: glibc 2.34+ ARM64

platynui_cli-0.13.0.dev1-py3-none-macosx_11_0_arm64.whl (3.1 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

File details

Details for the file platynui_cli-0.13.0.dev1-py3-none-win_arm64.whl.

File metadata

  • Download URL: platynui_cli-0.13.0.dev1-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.27 {"installer":{"name":"uv","version":"0.11.27","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

Hashes for platynui_cli-0.13.0.dev1-py3-none-win_arm64.whl
Algorithm Hash digest
SHA256 65c86ae6bab47e6ca3db2de12c4606ae9ac3f13f410a15ad620b7dae65f101b0
MD5 7d34c405ceb7b350eaf510c64ace6115
BLAKE2b-256 838f227450092a8299cda867002994224878ad17d77445f23c15559cba5da2c4

See more details on using hashes here.

File details

Details for the file platynui_cli-0.13.0.dev1-py3-none-win_amd64.whl.

File metadata

  • Download URL: platynui_cli-0.13.0.dev1-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.27 {"installer":{"name":"uv","version":"0.11.27","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

Hashes for platynui_cli-0.13.0.dev1-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 9732e0edb3121a17f286f19021f55a723557786800e1d9e09a9b84d8d8e7a2e6
MD5 256ecd5933ab05167596aadeaba2b979
BLAKE2b-256 013f2b535745ae7523309cd7f85b6c0d817d3a4c3faa98b11e3b972ea9653f79

See more details on using hashes here.

File details

Details for the file platynui_cli-0.13.0.dev1-py3-none-manylinux_2_34_x86_64.whl.

File metadata

  • Download URL: platynui_cli-0.13.0.dev1-py3-none-manylinux_2_34_x86_64.whl
  • Upload date:
  • Size: 5.8 MB
  • Tags: Python 3, manylinux: glibc 2.34+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.27 {"installer":{"name":"uv","version":"0.11.27","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

Hashes for platynui_cli-0.13.0.dev1-py3-none-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 1e01a9f5aa2607bf508c79431954dbb8bc433e3fcc6005203c28ee21d9184546
MD5 113c763275d0b65936a870a6c9f1ee79
BLAKE2b-256 1a9f34bb579d3120344a44ec0494526bcd74926d490ff27220dc3bae6c2b1bd4

See more details on using hashes here.

File details

Details for the file platynui_cli-0.13.0.dev1-py3-none-manylinux_2_34_aarch64.whl.

File metadata

  • Download URL: platynui_cli-0.13.0.dev1-py3-none-manylinux_2_34_aarch64.whl
  • Upload date:
  • Size: 5.7 MB
  • Tags: Python 3, manylinux: glibc 2.34+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.27 {"installer":{"name":"uv","version":"0.11.27","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

Hashes for platynui_cli-0.13.0.dev1-py3-none-manylinux_2_34_aarch64.whl
Algorithm Hash digest
SHA256 519f6ad0d90a9cfdffb31f49e82b8eb195c15fb019f7f61b595d19b0936c4c21
MD5 56c89217298831bd25ab50b95b7d0781
BLAKE2b-256 56fd3c94a3d578e534ea09d4bb3973b0ff00b815405caa1a7f505470c9e595af

See more details on using hashes here.

File details

Details for the file platynui_cli-0.13.0.dev1-py3-none-macosx_11_0_arm64.whl.

File metadata

  • Download URL: platynui_cli-0.13.0.dev1-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.27 {"installer":{"name":"uv","version":"0.11.27","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

Hashes for platynui_cli-0.13.0.dev1-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 9c7c19a244da11e34324ae14c289c3b663c9a98ded2626180f57b49e22e80c96
MD5 ee2bf40bdfb351dbb75efa485e9b66d5
BLAKE2b-256 cbe9568be005fda902c930029bf4cf1e4df52ff30ad78b4aae3d09c1530cc221

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page