Skip to content

Commit ad00fe1

Browse files
committed
Updated readme section about macOS permissions
1 parent 5fa1da7 commit ad00fe1

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -160,17 +160,24 @@ You can install them by running
160160
xcode-select --install
161161
```
162162

163-
**Attention**:
163+
**Permissions**:
164+
165+
nut.js requires the executing application, e.g. your terminal, to be given both `Accessibility` and `Screen Recording` permissions.
164166

165-
In case you're experiencing problems like your mouse not moving or your keyboard not typing,
166-
please make sure to give the process you're executing your tests with accessibility permissions.
167+
Starting with release `2.3.0`, nut.js will check for and request these permissions automatically:
167168

168-
nut.js will give you a subtle hint in case permissions are lacking:
169+
<p align="center">
170+
<img src="https://github.com/nut-tree/nut.js/raw/develop/.gfx/permissions_popup.png" alt="Popup requesting screen recording permissions"/>
171+
</p>
169172

170-
`##### WARNING! The application running this script is not a trusted process! Please visit https://github.com/nut-tree/nut.js#macos #####`
173+
It will also give you a subtle hint in case permissions are lacking:
174+
175+
- Accessibility: `##### WARNING! The application running this script is not a trusted process! Please visit https://github.com/nut-tree/nut.js#macos #####`
176+
- Screen Recording: `##### WARNING! The application running this script is not allowed to capture screen content! Please visit https://github.com/nut-tree/nut.js#macos #####`
177+
178+
**Attention**:
171179

172-
When an application wants to use accessibility features, a permission pop-up should be shown.
173-
If not, you could try to manually add the application you're running the script from.
180+
Prior to release `2.3.0` you'll have to grant these permissions manually.
174181

175182
`Settings -> Security & Privacy -> Privacy tab -> Accessibility -> Add...`
176183

0 commit comments

Comments
 (0)