Metadata-Version: 2.4
Name: platynui-cli
Version: 0.12.0.dev330
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Rust
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Framework :: Robot Framework
Classifier: Framework :: Robot Framework :: Library
Summary: CLI for Robot Framework PlatynUI
Author-email: Daniel Biehl <daniel.biehl@imbus.de>
Requires-Python: >=3.12
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Changelog, https://github.com/imbus/robotframework-PlatynUI/blob/main/CHANGELOG.md
Project-URL: Documentation, https://github.com/imbus/robotframework-PlatynUI#readme
Project-URL: Homepage, https://github.com/imbus/robotframework-PlatynUI
Project-URL: Issues, https://github.com/imbus/robotframework-PlatynUI/issues
Project-URL: Source, https://github.com/imbus/robotframework-PlatynUI

# 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

```sh
uv tool install --prerelease allow platynui-cli
```

Inside an existing virtual environment:

```sh
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

```sh
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

- [../../docs/](../../docs/) - current working notes for CLI behavior, input handling, and platform details.
- [../../README.md](../../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.

