-
Notifications
You must be signed in to change notification settings - Fork 188
Command Line Arguments
Nudge offers a few command line arguments
In order to know what version of Nudge you are running, simply pass the -version
argument
/Applications/Utilities/Nudge.app/Contents/MacOS/Nudge \
-version
This shows both simpleMode and standardMode together in a single Nudge window. It is unlikely that anyone other than developers of Nudge will utilize this feature.
#### Demo Mode (-demo-mode)
In order to trigger Nudge in demo mode, simply pass the `-demo-mode` argument
/Applications/Utilities/Nudge.app/Contents/MacOS/Nudge
-demo-mode
This will open Nudge in the English localization and allow you to test the buttons, as well as Light/Dark mode.
If you'd like to trigger `simpleMode` in Demo mode, chain the both `-demo-mode` and `-simple-mode` arguments
/Applications/Utilities/Nudge.app/Contents/MacOS/Nudge
-demo-mode
-simple-mode
#### Simple Mode (-simple-mode)
If you'd like to force simple mode (and don't want to use the built in preferences configuration), simply pass the `-simple-mode` argument
/Applications/Utilities/Nudge.app/Contents/MacOS/Nudge
-simple-mode
#### JSON URL (-json-url)
In order to download a JSON from a website, simple pass the `-json-url` argument.
/Applications/Utilities/Nudge.app/Contents/MacOS/Nudge
-json-url
"https://raw.githubusercontent.com/macadmins/nudge/Example%20Assets/com.github.macadmins.Nudge.json"
While the `-json-url` argument is mainly designed for web urls, passing `file://` urls are also possible. This may be useful if you don't want to deploy a json to `/Library/Preferences` or simply want to test another json file.
/Applications/Utilities/Nudge.app/Contents/MacOS/Nudge
-json-url
"file:///path/to/your.json"`
#### Force Screenshot Icon (-force-screenshot-icon)
By default, if you do not pass a screenshot in the Nudge preferences, the Big Sur icon embedded within Nudge.app will not render. To force this behavior, pass the `-force-screenshot-icon` argument
/Applications/Utilities/Nudge.app/Contents/MacOS/Nudge
-force-screenshot-icon
While the `-json-url` argument is mainly designed for web urls, you can actually pass it a `file://` path as well if you don't want to deploy a json to `/Library/Preferences` or simply want to test your workflow.
/Applications/Utilities/Nudge.app/Contents/MacOS/Nudge
-json-url
"file:///Users/YOURUSERNAME/Downloads/nudge/Example%20Assets/com.github.macadmins.Nudge.json"`
** Note: ** Spaces must be converted to `%20`, just as a standard url. This is required both for web and local assets