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

Uploaded Python 3Windows ARM64

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

Uploaded Python 3Windows x86-64

platynui_cli-0.13.0.dev2-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.dev2-py3-none-manylinux_2_34_aarch64.whl (5.9 MB view details)

Uploaded Python 3manylinux: glibc 2.34+ ARM64

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

File metadata

  • Download URL: platynui_cli-0.13.0.dev2-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.28 {"installer":{"name":"uv","version":"0.11.28","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.dev2-py3-none-win_arm64.whl
Algorithm Hash digest
SHA256 61c8a0fe057709a18c369e8ea926c2010f32739477240d4ffe6ed561f06863fc
MD5 a8a9da8f92ed767e71eb05e4d1c4b8dd
BLAKE2b-256 0daf020aa8ce2cb61fda4c5f1219252e74207dc0660dcac8b2b66cc56adfca8f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: platynui_cli-0.13.0.dev2-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.28 {"installer":{"name":"uv","version":"0.11.28","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.dev2-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 ad6b2b8b82f1fc0e96cdfdaf6e1af7f91c6f3c6c144ffec8e6397ad2bcdee56c
MD5 5a441ab22a1bc0ab858844ba0a514e0b
BLAKE2b-256 38df9df852a5c4d98623800307bb9aacf6f3b59c6618be3298d8d4d69ab13e91

See more details on using hashes here.

File details

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

File metadata

  • Download URL: platynui_cli-0.13.0.dev2-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.28 {"installer":{"name":"uv","version":"0.11.28","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.dev2-py3-none-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 e62d8d4475e3c6e9414c96d8574fce7aaf3232b4c4f990eb38090d01b4bedbf2
MD5 efc8ba49077ff12c318bb4c832ad63bc
BLAKE2b-256 2f300ac6cfe011bcee293ced4afd3c638b12b8a34ef4816a3f1b4b0b6d3985e8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: platynui_cli-0.13.0.dev2-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.28 {"installer":{"name":"uv","version":"0.11.28","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.dev2-py3-none-manylinux_2_34_aarch64.whl
Algorithm Hash digest
SHA256 89c6bde8905b197a71f475df7fe1a97a74df0b3d04e388298b4c35dbba919576
MD5 f33837f6bd177459d24f9e1c7343c133
BLAKE2b-256 cb606ff831665bfe7fe484db40874571c35d3f0cede457845847b39326b53a57

See more details on using hashes here.

File details

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

File metadata

  • Download URL: platynui_cli-0.13.0.dev2-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.28 {"installer":{"name":"uv","version":"0.11.28","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.dev2-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 6b4e57ef01e5fde233c98bae7b5278dbd677de54e9f15a82649e613c695087ff
MD5 ab9a62a5f8713d8093cafc638f1bf8f2
BLAKE2b-256 58ddc5b14f92a0807d78d4a920a67b3f5ea01a558b9a7883602857a106428649

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