Skip to content

Revise README for clarity and add project disclaimer #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cameroncooke merged 1 commit into from
May 13, 2026
Merged

Revise README for clarity and add project disclaimer #51

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<img src="banner.png" alt="AXe" width="600"/>

AXe is a comprehensive CLI tool for interacting with iOS Simulators using Apple's Accessibility APIs and HID (Human Interface Device) functionality.
AXe is a comprehensive CLI tool for interacting with iOS Simulators using Apple's HID (Human Interface Device) functionality.

[![CI](https://github.com/cameroncooke/AXe/actions/workflows/release.yml/badge.svg)](https://github.com/cameroncooke/AXe/actions/workflows/release.yml)
[![Licence: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
Expand Down Expand Up @@ -193,7 +193,7 @@ axe init --uninstall --client agents
axe tap -x 100 -y 200 --udid SIMULATOR_UDID
axe tap -x 100 -y 200 --pre-delay 1.0 --post-delay 0.5 --udid SIMULATOR_UDID

# Tap by accessibility element (uses describe-ui accessibility tree)
# Tap by element (uses describe-ui view tree)
axe tap --id "Safari" --udid SIMULATOR_UDID
axe tap --label "Safari" --udid SIMULATOR_UDID
axe tap --label "Weather Alerts" --udid SIMULATOR_UDID # Switches/toggles use their activation point and physical touch when matched
Expand Down Expand Up @@ -233,8 +233,6 @@ axe slider --id slider-value-slider --value 75 --udid SIMULATOR_UDID
axe slider --label "Volume" --value 40 --element-type Slider --udid SIMULATOR_UDID
```

`slider` resolves the real accessibility slider element, performs one calibrated low-level HID drag from its current AXValue-derived position toward the requested percentage using the same composite touch-move path as `drag`, and re-reads AXValue to verify the result. Since iOS slider controls quantize values to their rendered track resolution, AXe verifies that the observed value is within tolerance rather than retrying correction gestures to chase unreachable decimals. If the observed AXValue remains outside tolerance after that drag, the command fails clearly.

### **Gesture Presets**

```bash
Expand Down Expand Up @@ -447,6 +445,10 @@ For a full behavior-first explanation of every batch argument with practical exa

Contributions are welcome! Please feel free to submit a Pull Request.

## Disclaimer

AXe is an independent open-source iOS simulator automation project and is not affiliated with, endorsed by, or associated with Deque Systems or its axe® accessibility products.

## Licence

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Expand Down
Loading