Skip to main content
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.

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

Uploaded Python 3Windows ARM64

platynui_cli-0.13.0.dev117-py3-none-win_amd64.whl (3.6 MB view details)

Uploaded Python 3Windows x86-64

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

Uploaded Python 3manylinux: glibc 2.34+ ARM64

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

File metadata

  • Download URL: platynui_cli-0.13.0.dev117-py3-none-win_arm64.whl
  • Upload date:
  • Size: 3.4 MB
  • Tags: Python 3, Windows ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","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.dev117-py3-none-win_arm64.whl
Algorithm Hash digest
SHA256 a1b28c56cc92d1436ab5edbbb6d48fa75c66c7ff162fb8010e65ce4870629681
MD5 4200250d0eaf73857937d74b852d45f8
BLAKE2b-256 28c60ee27ab6ad0ceb45f22a735e8946ee15af2274b14651dc4fb2092616df6a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: platynui_cli-0.13.0.dev117-py3-none-win_amd64.whl
  • Upload date:
  • Size: 3.6 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","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.dev117-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 e9c9b804e8b1a6feb30a4707ef19047240bd92470b54423ccd18745587e2f286
MD5 2139e8321a0837361c92b9edb872e4f0
BLAKE2b-256 21f675fc88da19fc5803036747a267e8e7e08723d285d90e8100b770fa07aed7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: platynui_cli-0.13.0.dev117-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.32 {"installer":{"name":"uv","version":"0.11.32","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.dev117-py3-none-manylinux_2_34_x86_64.whl
Algorithm Hash digest
SHA256 ccafd420994e588840461542c301e786d4600966503ace33622d692b966ab21f
MD5 521e5064c7ef92d648bd02ff9c7db756
BLAKE2b-256 d16dd06096162442c1a7814537f2b0139272e44223af38e533612cb7bdfb99ab

See more details on using hashes here.

File details

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

File metadata

  • Download URL: platynui_cli-0.13.0.dev117-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.32 {"installer":{"name":"uv","version":"0.11.32","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.dev117-py3-none-manylinux_2_34_aarch64.whl
Algorithm Hash digest
SHA256 6dad5eae4ec7ace53045f3851e1e3a602357b8d1dc76ed5f5c66988f0874efe3
MD5 646f0e40714f08f4019cb948bdeefb01
BLAKE2b-256 8fa807f34c09ec6dd9bdd636b1f643bfcb5ac416bc5d48e4ed4282e493c7a593

See more details on using hashes here.

File details

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

File metadata

  • Download URL: platynui_cli-0.13.0.dev117-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.32 {"installer":{"name":"uv","version":"0.11.32","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.dev117-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 d30714f8f85b9aa601a30d8b1fdea0cc6ef58e1b681694d39b1443dd4a39c898
MD5 66bf59becd92d53a836c857c8b6a887b
BLAKE2b-256 5dc053a26ae9c136abfda70f50d8c5d488a650b0b0020c40a952ed4b0029f28a

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