State commands extract information from UI elements without modifying them.
get text Extract text content from an element.
agent-native get text < targe t > [options]
Arguments Target element: @ref (from snapshot) or app name
Options Filter by accessibility role
Which matching element to read (0-indexed)
Examples Get by reference
Get by filter
JSON output
agent-native get text @n15
Output Operation completed successfully
The command reads from AXValue, AXTitle, or AXDescription attributes in that order, returning the first available value.
get value Get the current value of an input element.
agent-native get value < targe t > [options]
Arguments and options Identical to get text.
Examples Get text field value
Get slider value
Get checkbox value
agent-native get value @n10
Output For checkboxes and numeric controls:
Checkboxes return 0 (unchecked) or 1 (checked). Sliders and steppers return their numeric value.
get attr Retrieve a specific accessibility attribute.
agent-native get attr < targe t > < attribut e > [options]
Arguments Target element: @ref or app name
Attribute name (e.g., AXRole, AXEnabled, AXFrame, AXPosition)
Options Standard filter options: --role, --title, --label, --index, --json
Examples Get role
Get enabled state
Get position
Get description
agent-native get attr @n20 AXRole
Output For position/size:
For arrays:
Common attributes Identity
State
Layout
Content
AXRole - Element typeAXRoleDescription - Human-readable roleAXTitle - Element titleAXDescription - Accessibility descriptionAXIdentifier - Unique identifier
AXEnabled - Whether element is enabledAXFocused - Whether element has focusAXValue - Current valueAXSelected - Whether element is selectedAXExpanded - Whether element is expanded
AXPosition - Screen coordinatesAXSize - Width and heightAXFrame - Position and size combinedAXParent - Parent elementAXChildren - Child elements
AXLabel - Accessibility labelAXHelp - Help textAXPlaceholderValue - Placeholder textAXMaxValue - Maximum valueAXMinValue - Minimum value Use inspect to see all available attributes for an element.
get title Get the title of the frontmost window of an application.
agent-native get title < ap p > [options]
Arguments Application name or bundle identifier
Options Examples Get Safari window
Get Terminal
JSON output
agent-native get title Safari
Output is enabled Check if an element is enabled (interactive).
agent-native is enabled < targe t > [options]
Arguments Target element: @ref or app name
Options Standard filter options: --role, --title, --label, --index, --json
Examples Check by reference
Check button
JSON output
agent-native is enabled @n12
Output or
Use this in scripts to conditionally perform actions based on element availability.
is focused Check if an element currently has keyboard focus.
agent-native is focused < targe t > [options]
Arguments and options Identical to is enabled.
Examples Check by reference
Check text field
agent-native is focused @n8
Output or
Workflow examples #!/bin/bash # Fill form agent-native fill @n5 "[email protected] " agent-native fill @n6 "password123" # Check if submit button is enabled if [ "$( agent-native is enabled @n7)" = "true" ]; then agent-native click @n7 echo "Form submitted" else echo "Submit button is disabled" exit 1 fi # Wait and verify agent-native wait MyApp --role StaticText --label "Success" --timeout 5 MESSAGE = $( agent-native get text MyApp --role StaticText --label "Success" ) echo "Result: $MESSAGE "
Monitor dynamic content #!/bin/bash # Check current value OLD_VALUE = $( agent-native get value @n10 ) echo "Current value: $OLD_VALUE " # Trigger update agent-native click @n5 # Wait for change while true ; do NEW_VALUE = $( agent-native get value @n10 ) if [ " $NEW_VALUE " != " $OLD_VALUE " ]; then echo "Value changed to: $NEW_VALUE " break fi sleep 0.5 done
#!/bin/bash # Get window title TITLE = $( agent-native get title MyApp ) # Get multiple field values NAME = $( agent-native get value @n5 ) EMAIL = $( agent-native get value @n6 ) STATUS = $( agent-native get text @n10 ) # Check states ENABLED = $( agent-native is enabled @n15 ) FOCUSED = $( agent-native is focused @n6 ) # Output as JSON-like structure cat << EOF { "window": " $TITLE ", "name": " $NAME ", "email": " $EMAIL ", "status": " $STATUS ", "saveEnabled": $ENABLED , "emailFocused": $FOCUSED } EOF
Validation checks #!/bin/bash # Take snapshot agent-native snapshot MyApp --interactive > snapshot.txt # Verify required elements exist if ! grep -q "Button \" Submit \" " snapshot.txt ; then echo "Error: Submit button not found" exit 1 fi # Check element states if [ "$( agent-native is enabled @n10)" = "false" ]; then echo "Warning: Next button is disabled" fi # Verify values EMAIL = $( agent-native get value @n5 ) if [[ ! " $EMAIL " =~ @.+ \. ]]; then echo "Error: Invalid email format: $EMAIL " exit 1 fi echo "All validation checks passed"
Compare states #!/bin/bash # Capture before state agent-native get value @n5 > before.txt agent-native get text @n10 >> before.txt agent-native is enabled @n15 >> before.txt # Perform action agent-native click @n8 sleep 1 # Capture after state agent-native get value @n5 > after.txt agent-native get text @n10 >> after.txt agent-native is enabled @n15 >> after.txt # Compare if diff before.txt after.txt > /dev/null ; then echo "No state changes detected" else echo "State changes:" diff before.txt after.txt fi