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.dev25-py3-none-win_arm64.whl (3.2 MB view details)

Uploaded Python 3Windows ARM64

platynui_cli-0.13.0.dev25-py3-none-win_amd64.whl (3.3 MB view details)

Uploaded Python 3Windows x86-64

platynui_cli-0.13.0.dev25-py3-none-manylinux_2_34_x86_64.whl (5.9 MB view details)

Uploaded Python 3manylinux: glibc 2.34+ x86-64

platynui_cli-0.13.0.dev25-py3-none-manylinux_2_34_aarch64.whl (5.9 MB view details)

Uploaded Python 3manylinux: glibc 2.34+ ARM64

platynui_cli-0.13.0.dev25-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.dev25-py3-none-win_arm64.whl.

File metadata

  • Download URL: platynui_cli-0.13.0.dev25-py3-none-win_arm64.whl
  • Upload date:
  • Size: 3.2 MB
  • Tags: Python 3, Windows ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","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.dev25-py3-none-win_arm64.whl
Algorithm Hash digest
SHA256 ee94ce7ca5a3c9e423d1d78fcf9944c5c4133f7c748c54490e01374eec9a7441
MD5 ba7606caedef5557c1913ce39e78efd9
BLAKE2b-256 314cb95fac1f97fd23e838ce40da3c4ae1099e8e3707b8731ca3c37c77f0ca0a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: platynui_cli-0.13.0.dev25-py3-none-win_amd64.whl
  • Upload date:
  • Size: 3.3 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","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.dev25-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 5c3a77a984e4d432840af6d265bc75770946e286aca550c606f7e83eb6bf07a8
MD5 bed4f94db34c41ac6fd547607b9f4867
BLAKE2b-256 e9a61cc74cf4d79fa1a5b25567a05306cc99a097f1dd20b1ba146275554f25ec

See more details on using hashes here.

File details

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

File metadata

  • Download URL: platynui_cli-0.13.0.dev25-py3-none-manylinux_2_34_x86_64.whl
  • Upload date:
  • Size: 5.9 MB
  • Tags: Python 3, manylinux: glibc 2.34+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","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.dev25-py3-none-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 06de7aae6d94aed7a2dc4c8ae5e05df591499038d66d15f3f76dee785e189cc7
MD5 4dde372f8ae4e07c6abe84df5fb86eb9
BLAKE2b-256 6c6beff309ea3467c64981d73c213bbc5916dfcc9f80eaa31642cca8156d7491

See more details on using hashes here.

File details

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

File metadata

  • Download URL: platynui_cli-0.13.0.dev25-py3-none-manylinux_2_34_aarch64.whl
  • Upload date:
  • Size: 5.9 MB
  • Tags: Python 3, manylinux: glibc 2.34+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","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.dev25-py3-none-manylinux_2_34_aarch64.whl
Algorithm Hash digest
SHA256 239b07bdea1fe72167c870b4855ba1f69b13f151966bd279f0b253cf320c5a92
MD5 8512483915a101fbc77a4d4a1517907b
BLAKE2b-256 93da134f6efa2bae27c250da293dbffbfaf973c51942208e80a7cabe4712491c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: platynui_cli-0.13.0.dev25-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.29 {"installer":{"name":"uv","version":"0.11.29","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.dev25-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 11efb67bd0db3d29b82c9b9f266728f0225d8f00fa32da490655fa106ee69f37
MD5 ecfb7b00cda2b1514433d58cfa1d9449
BLAKE2b-256 984b42e37921e9e221cb671289ff81357976898e6c67014c4d0829c2aba2c902

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