Skip to content

Commit 967455f

Browse files
committed
Improved docs about accessibility permissions on macOS
1 parent 4ecf0c0 commit 967455f

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

.gfx/permissions.png

71 KB
Loading

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,14 @@
1010

1111
[![Downloads per month](https://img.shields.io/npm/dm/@nut-tree/nut-js)](https://www.npmjs.com/package/@nut-tree/nut-js)
1212

13+
<p align="center">
14+
Please visit
15+
</p>
1316
<h1 align="center"><a href="https://nutjs.dev">nutjs.dev</a></h1>
14-
1517
<p align="center">
16-
Native UI testing / automation with Node.js
18+
for detailed documentation and tutorials
1719
</p>
20+
1821
<br/>
1922

2023
# About
@@ -154,10 +157,21 @@ xcode-select --install
154157
In case you're experiencing problems like your mouse not moving or your keyboard not typing,
155158
please make sure to give the process you're executing your tests with accessibility permissions.
156159

157-
If an application wants to use accessibility features, a permission pop-up should be shown.
160+
nut.js will give you a subtle hint in case permissions are lacking:
161+
162+
`##### WARNING! The application running this script is not a trusted process! Please visit https://github.com/nut-tree/nut.js#macos #####`
163+
164+
When an application wants to use accessibility features, a permission pop-up should be shown.
158165
If not, you could try to manually add the application you're running the script from.
159166

160-
`Settings -> Security & Privacy -> Privacy -> Accessibility -> Add...`
167+
`Settings -> Security & Privacy -> Privacy tab -> Accessibility -> Add...`
168+
169+
For example, if you want to execute your node script in e.g. `iTerm2`, you'd have to add `iTerm.app` to the list.
170+
When running your script from a built-in terminal in e.g. `VSCode` or `IntelliJ`, you'd have to add the respective IDE.
171+
172+
<p align="center">
173+
<img src="https://github.com/nut-tree/nut.js/raw/develop/.gfx/permissions.png" alt="accessibility permissions screen"/>
174+
</p>
161175

162176
#### Linux
163177

0 commit comments

Comments
 (0)