CLI reference
This reference reproduces the CLI help from BetterDisplay 5.0.6, imported on 2026-09-29. For setup and worked examples, see the Integration overview and CLI examples. Run betterdisplaycli help for the help belonging to your installed app version.
General overview and syntax
The app supports the following integration methods:
- Command line integration
- Custom URL scheme based integration
- HTTP integration
- Notification based integration - for more details on this, see: https://betterdisplay.pro/integration
- macOS Shortcuts (App Intents)
The various integration methods can be separately enabled and disabled under Settings in the application UI.
An integration command might receive one or more operations and zero or more parameters. A parameter might or might not have a value associated with it.
Syntax for command line access:
./BetterDisplay operation [operation] [-parameter[=value]] [-parameter[=value]]
Notes:
- The app binary
BetterDisplayis available in the installed macOS app bundle (the full path when installed underApplicationsis/Applications/BetterDisplay.app/Contents/MacOS/BetterDisplay). - You can use both single and double hyphen parameter style.
You can also use betterdisplaycli for simpler access. Installation via Homebrew:
brew install waydabber/betterdisplay/betterdisplaycli
Examples (both commands set the brightness of a display with the name MyDisplay to 80%):
./BetterDisplay set -name=MyDisplay -brightness=0.8
betterdisplaycli set --name=MyDisplay --brightness=80%
Syntax for custom URL scheme integration:
BetterDisplay://operation[/operation (…)][?parameter[=value]][¶meter[=value]]
Example (raw URL and scripted access using open command with proper escaping):
BetterDisplay://set?name=MyDisplay&brightness=0.8
open BetterDisplay://set\?name=MyDisplay\&brightness=0.8
To safeguard access, a special token can optionally be defined in Settings which must then be present in the URL via a token= parameter. The custom URL scheme integration supports x-callback-url to report back success or error and results. More information: https://x-callback-url.com/specification/
Syntax for HTTP based integration:
http://<hostname>:55777/command/[command/][?parameter[=value]][¶meter[=value]]
Example (raw URL and scripted access using curl command with proper escaping):
http://localhost:55777/set?name=MyDisplay&brightness=0.8
curl http://localhost:55777/set\?name=MyDisplay\&brightness=0.8
The listening port can be customized under Settings. Example uses local access via localhost - use the appropriate hostname with remote calls. To safeguard access, a special token can optionally be defined in Settings which must then be present in the URL via a token= parameter.
With URLs you can use %20 to substitute for space.
Operations
Operations define how a command will be interpreted. Some operations can be combined (for example set or toggle with get to both set and get a value.
perform- Perform a command. Used for features that do not expect any value.set- Sets a value. Can be used for features that excpect a value to set.get- Gets a value. Useful for features that can report some kind of value (and optionally minimum and maximum values for features where a range makes sense).toggle- Toggle a bool value. Can be used for on/off (togglable) features.feed- Updates the value of a custom control without performing a set operation. Can be used to feed/synchronize data to the custom control from an external source.create- Create a device. You need to specifytype=VirtualScreen. You can add othersetoperation parameters to configure the virtual screen or alter its identifiers from default. If an identifier is not provided, the app will provide a default or (if it makes sense) random value.discard- Discard a device. Use various device identifiers using identification parameters to narrow the devices you want to discard. Warning: without identifiers, the app will discard all discardable devices without question and any ability to undo - be careful with this!help- Provides help about general usage or a specified operation, feature or parameter.exit- Closes the console window without producing output. Console only.clear- Clears the console window without producing output. Console only.
Parameters
Parameters affect how an operation is carried out. Some parameters can be mixed with each other. Parameters may or may not have values. Some parameters require additional parameters to function.
Device identification and device listing
tagID- Identify a device or group via tagID which is a BetterDisplay provided unique numeric ID specific to this app installation.UUID- Identify a device via the display's UUID assigned by this macOS installation.displayID- Identify a device using the displayID issued by macOS. This ID might change from time-to-time.name- Identify a device or group using its displayed name in BetterDisplay.nameLike(orn) - Identify a device or group using a part of its displayed name in BetterDisplay (case insensitive).originalName- Identify a device using its name in BetterDisplay.originalNameLike- Identify a device using a part of its name in BetterDisplay (case insensitive).productName- Identify a device using its product name (as recorded in the display EDID).productNameLike- Identify a device using a part of its name (as recorded in the display EDID, case insensitive).vendor- Identify a device using its vendor code (numeric value).model- Identify a device using its model number.serial- Identify a device using its serial number.alphanumericSerial- Identify a device using its alphanumerical serial identifier.yearOfManufacture- Identify a device using the year of manufacture.weekOfManufacture- Identify a device using the week of manufacture.registryLocation- Identify a device using its I/O registry location string.type(ordeviceType) - Identify a device or group based on its type. Can beDisplayorVirtualScreen orDisplayGroup``.displayWithMouse- Identify the display with mouse.displayWithFocus- Identify the display with the focused window.displayWithMainStatus- Identify the display set as main.displayWithNonMainStatus- Identify display(s) set as non-main.
Setting or getting values
value- Provides value when required for a feature or operation. Depending on the feature, the value may be an integer number, real number, percentage,onoroff(for togglable features) or string. For most parameters you can use a more direct-<feature_name>=[value]syntax instead). When used with thegetoperation, provide this if you explicitly want the current value returned alongside minimumminor maximummaxvalues.offset- Signifies that any of the specified values are offset values (positive or negative) for features where it makes sense (these usually expect some real number or percentage as value). For example, providing-10%as value for a parameter will decrease the value of a feature (let's saybrightness) by 10%.min- If added without a value, thegetoperation will return the minimum value if it makes sense for the accessed feature. If added with a value for a set or get operation, it acts as a normalizaton tool to specify the lower bound of the value range on which the provided value must be interpreted or the requested value to be returned.max- If added without a value, thegetoperation will return the maximum value if it makes sense for the accessed feature. If added with a value for a set or get operation, it acts as a normalizaton tool to specify the upper bound of the value range on which the provided value must be interpreted or the requested value to be returned.
Parameters invoking an app feature
brightness- Brightness. Selects the most appropriate brightness control method if more than one is available. A contiguous range of values are accepted. Device (display) specific feature.combinedBrightness- Combined brightness (hardware + software). Should only be used if auto-selection usingbrightnessis not adequate. A contiguous range of values are accepted. Device (display) specific feature.hardwareBrightness- Hardware brightness (DDC or Apple). Should only be used if auto-selection usingbrightnessis not adequate. A contiguous range of values are accepted. Device (display) specific feature.softwareBrightness- Software brightness/dimming. Should only be used if auto-selection usingbrightnessis not adequate. A contiguous range of values are accepted. Device (display) specific feature.volume- Volume. Affects only devices with hardware volume control (DDC volume). A contiguous range of values are accepted. Device (display) specific feature.hardwareContrast- Hardware contrast. Works on displays with DDC contrast control. A contiguous range of values are accepted. Device (display) specific feature.redHardwareBlackLevel- Hardware black level for RGB red component. Works on displays with proper DDC control. A contiguous range of values are accepted. Device (display) specific feature.greenHardwareBlackLevel- Hardware black level for RGB green component. Works on displays with proper DDC control. A contiguous range of values are accepted. Device (display) specific feature.blueHardwareBlackLevel- Hardware black level for RGB blue component. Works on displays with proper DDC control. A contiguous range of values are accepted. Device (display) specific feature.redHardwareGain- Hardware video gain for RGB red component. Works on displays with proper DDC control. A contiguous range of values are accepted. Device (display) specific feature.greenHardwareGain- Hardware video gain for RGB green component. Works on displays with proper DDC control. A contiguous range of values are accepted. Device (display) specific feature.blueHardwareGain- Hardware video gain for RGB blue component. Works on displays with proper DDC control. A contiguous range of values are accepted. Device (display) specific feature.gain- Software video gain. Works on displays with color table manipulation support. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.gamma- Software gamma. Works on displays with color table manipulation support. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.rGamma- Software gamma for RGB red component. Works on displays with color table manipulation support. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.gGamma- Software gamma for RGB green component. Works on displays with color table manipulation support. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.bGamma- Software gamma for RGB blue component. Works on displays with color table manipulation support. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.rGain- Software gain for RGB red component. Works on displays with color table manipulation support. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.gGain- Software gain for RGB green component. Works on displays with color table manipulation support. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.bGain- Software gain for RGB blue component. Works on displays with color table manipulation support. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.temperature- Software color temperature. Works on displays with color table manipulation support. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.quantization- Software color quantization. Works on displays with color table manipulation support. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.contrast- Software contrast. Works on displays with color table manipulation support. A contiguous range of values are accepted. Device (display) specific feature.underscan- Underscan. Works on displays with backling framebuffers that have underscan control support. A contiguous range of values are accepted. Device (display) specific feature.gaussianBlur- Software gaussian blur. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.saturation- Software saturation. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.hue- Software color quantization. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterHighlight- Software highlight adjustment. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterShadow- Software shadow adjustment. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterVibrance- Software vibrance adjustment. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterSepia- Software sepia filter. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterVignette- Software vignette filter. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterPixellateScale- Software pixellate filter. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterCrystallizeRadius- Software crystallize filter. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterHexagonalPixellate- Software hexagonal pixellate filter. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterPointillize- Software pointillize filter. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterEdges- Software edges filter. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterEdgeWorkRadius- Software edge work filter. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterCMYKHalftone- Software CMYK halftone filter. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterDotScreen- Software dot screen filter. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterHatchedScreen- Software hatched screen filter. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterLineScreen- Software line screen filter. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterNoiseReduction- Software noise reduction filter. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterMotionBlur- Software motion blur filter. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterUnsharpMask- Software unsharp mask filter. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterSharpenLuminance- Software sharpness filter. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterBloomIntensity- Software bloom filter. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.filterGloomIntensity- Software gloom filter. Works on displays with compositor filter configured. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.brightnessNits- Display brightness in nits. A contiguous range of values are accepted. Device (display) specific feature.softwareBrightnessNits- Current software brightness control level in nits (if hardware brightness is taken as 100%). A contiguous range of values are accepted. Device (display) specific feature. Information retrieval feature.hardwareBrightnessNits- Current hardware brightness control level in nits according to current hardware and software brightness settings. A contiguous range of values are accepted. Device (display) specific feature. Information retrieval feature.ambientLight- Returns the current ambient light level for the display when a supported sensor output method is available. Use with get. Pro feature. A contiguous range of values are accepted. Device (display) specific feature.ddc- Sends a direct DDC command to the display. Requires a natively connected display with DDC enabled. Specifysetandgetfor DDC write and read. Use thevcpparameter to specify the DDC control code. Usevalueto provide value for asetoperation. Specific values must be provided. Device (display) specific feature.ddcAlt- Sends a direct DDC command to the display using an alternate addressing (mostly used by some LG displays to control input source). Requires a natively connected display with DDC enabled. Use thevcpparameter to specify the DDC control code. Usevalueto provide value for asetorfeedoperation. Specific values must be provided. Device (display) specific feature.control- Invokes a custom (or predefined) control by its CLI designation. Use thespecifierparameter to specify the (custom) control name. Usevalueto provide value (if relevant) for asetoperation. A contiguous range of values are accepted. Bool value (onoroff) is accepted. No value must be specified. Device (display) specific feature.virtualScreenName- Defines the name of the virtual screen Virtual screen management feature.virtualScreenSerial- Defines the serial number of the virtual screen Virtual screen management feature.virtualScreenVendorNumber- Defines the vendor number of the virtual screen Virtual screen management feature.virtualScreenModelNumber- Defines the model number of the virtual screen Virtual screen management feature.aspectWidth- Aspect width of the virtual screen. Virtual screen management feature. A contiguous range of values are accepted.aspectHeight- Aspect height of the virtual screen. Virtual screen management feature. A contiguous range of values are accepted.sizeInch- Diameter of the virtual screen in inch. Virtual screen management feature. A contiguous range of values are accepted.multiplierStep- Multiplier step of the generated resolutions (multiples of aspect width and height). Virtual screen management feature. A contiguous range of values are accepted.limitMultiplierSize- Enable/disable multiplier limits. Virtual screen management feature. A contiguous range of values are accepted.multiplierMinWidth- Multiplier limit - height width. Virtual screen management feature. A contiguous range of values are accepted.multiplierMinHeight- Multiplier limit - height minimum. Virtual screen management feature. A contiguous range of values are accepted.multiplierMaxWidth- Multiplier limit - width maximum. Virtual screen management feature. A contiguous range of values are accepted.multiplierMaxHeight- Multiplier limit - height maximum. Virtual screen management feature. A contiguous range of values are accepted.flipped- Virtual screen flipping. Virtual screen management feature. Bool value (onoroff) is accepted.virtualScreenHiDPI- Enable HiDPI resolutions in the resolution list of a virtual screen. Virtual screen management feature. Bool value (onoroff) is accepted.useResolutionList- Use custom resolution list instead of generated resolutions based on the aspect ratio and multiplier. Virtual screen management feature. Bool value (onoroff) is accepted.resolutionList- Resolution list inWIDTHxHEIGHT,[WIDTHxHEIGHT[,…]]format. Virtual screen management feature.rotation- Display rotation. Valid values are0,90,180,270. Works on display framebuffers with rotation support. Pro feature. Specific values must be provided. Device (display) specific feature.favoriteMode- Set display mode to the one recorded in the specified favorite slot. Valid values are1to5. Pro feature. Specific values must be provided. Device (display) specific feature.saveFavoriteMode- Records current display mode to a specified favorite slot. Valid values are1to5. Pro feature. Specific values must be provided. Device (display) specific feature.colorProfileURL- Color profile setting for a display. Specific values must be provided. Device (display) specific feature.xdrPreset- Apple Display Preset setting for a display. Specific values must be provided. Device (display) specific feature.displayModeNumber- Display mode number. Specific values must be provided. Device (display) specific feature.connectionMode- Low level connection mode. For valid mode numbers to specify withset, useconnectionModeList. You can also specify a mode using the formatbpc:[8|10|12|16]+range:[limited|full]+encoding:[rgb|ycbcr]+chroma:[444|422|420]+hdrmode:[sdr|hdr10|dolby]- if components are missing, current value is assumed, so for example specifyingbpc:8will simply switch to 8bpc mode. Modeswitch happens only if there is a suitable mode in the compatible connection mode list. Available on Apple silicon Macs for natively connected displays. Please note that changing the connection mode is a risky operation! Specific values must be provided. Device (display) specific feature.resolution- Display/screen resolution (in WIDTHxHEIGHT) format. Specific values must be provided. Device (display) specific feature.refreshRate- Refresh rate (in Hz). Can be used in conjunction with traditional display mode selectors, likeresolution,hiDPIas well. Specific values must be provided. Device (display) specific feature.colorDepth- Color depth (typically: 8 or 10 bits per channel). Specific values must be provided. Device (display) specific feature.placement- Display placement in the global coordinate space of the display layout (inXxYformat). Uses logical pixels. Specific values must be provided. Device (display) specific feature.moveTo- Move display next to another display in the display layout using direction specifiers. A target display (relative to which the display is moved) must be specified. Specific values must be provided. No value must be specified. Device (display) specific feature. Pro feature. Available values:topLeftCorner,topLeft,top,topRight,topRightCorner,leftTop,left,leftBottom,rightTop,right,rightBottom,bottomLeftCorner,bottomLeft,bottom,bottomRight,bottomRightCorner.framebufferBoolProperty- Set a boolean framebuffer property. Usespecifierto specify the framebuffer property name. Available on Apple silicon Macs only. Bool value (onoroff) is accepted. Device (display) specific feature.framebufferNumericProperty- Set a numeric framebuffer property. Usespecifierto specify the framebuffer property name. Available on Apple silicon Macs only. Specific values must be provided. Device (display) specific feature.sendRemoteKey- Send device remote key event if supported by the device. Usespecifierto specify the controller if multiple controllers support virtual remotes. Specific values must be provided. Device (display) specific feature. No value must be specified.sendRemoteKeyPress- Send device remote key press event if supported by the device. Usespecifierto specify the controller if multiple controllers support virtual remotes. Specific values must be provided. Device (display) specific feature. No value must be specified.sendRemoteKeyRelease- Send device remote key release event if supported by the device. Usespecifierto specify the controller if multiple controllers support virtual remotes. Specific values must be provided. Device (display) specific feature. No value must be specified.changeInputSource- Switch input source on the device. Usespecifierto specify the controller if multiple controllers support input source change. Specific values must be provided. Device (display) specific feature. No value must be specified.mute- Display mute. Works on devices with volume control (DDC volume and optionally DDC mute). Bool value (onoroff) is accepted. Device (display) specific feature.hardwareBacklight- Turns the screen on or off. Works on displays with compatible DDC or smart protocol support. Bool value (onoroff) is accepted. Device (display) specific feature.hiDPI- Turns HiDPI rendering on or off. Works with resolutions that have both LoDPI and HiDPI alternatives. Bool value (onoroff) is accepted. Device (display) specific feature.hdr- Turns HDR mode on or off. Requires third party HDR capable display. Pro feature. Bool value (onoroff) is accepted. Device (display) specific feature.brightnessUpscaling- Turns software brightness upscaling on or off. Requires XDR or HDR display. Pro feature. Bool value (onoroff) is accepted. Device (display) specific feature.directBrightnessUpscaling- Turns direct brightness upscaling on or off. Requires a built-in XDR display. Pro feature. Bool value (onoroff) is accepted. Device (display) specific feature.connected- Connects or disconnects a display or virtual screen. For displays, connection management capable connection and Pro is required. Bool value (onoroff) is accepted. Device (display) specific feature.autoBrightness- Turns auto brightness on or off. Requires an Apple display. Bool value (onoroff) is accepted. Device (display) specific feature.notch- Turns the Apple Liquid Retina Display "ears" and "notch" area on or off. Requires a compatible display and works with certain resolutions only that have notched and notchless alternatives. Pro feature. Bool value (onoroff) is accepted. Device (display) specific feature.main- Sets a display as a main display (unsetting is only possible by designating another display as main) or get its main status. Bool value (onoroff) is accepted. Device (display) specific feature.gpuDithering- GPU dithering. Available on Apple silicon Macs only. Bool value (onoroff) is accepted. Device (display) specific feature.inverted- Invert colors using the available image adjustment controller. Bool value (onoroff) is accepted. Device (display) specific feature.filterMonochrome- Software monochrome filter. Works on displays with compositor filter configured. Pro feature. Bool value (onoroff) is accepted. Device (display) specific feature.filterThermal- Software thermal filter. Works on displays with compositor filter configured. Pro feature. Bool value (onoroff) is accepted. Device (display) specific feature.filterXRay- Software X-Ray filter. Works on displays with compositor filter configured. Pro feature. Bool value (onoroff) is accepted. Device (display) specific feature.filterMedian- Software median filter. Works on displays with compositor filter configured. Pro feature. Bool value (onoroff) is accepted. Device (display) specific feature.filterComic- Software comic effect filter. Works on displays with compositor filter configured. Pro feature. Bool value (onoroff) is accepted. Device (display) specific feature.suspendImageAdjustments- Suspend various software image adjustments (except for brightness) for the display. Bool value (onoroff) is accepted. Device (display) specific feature.mirror- Mirror display. One or more target display must be specified. Bool value (onoroff) is accepted. Device (display) specific feature.stream- Enable/disable streaming for a display or alter stream settings by providing additional parameters. Usespecifierto specify the appropriate stream (or omit for the default stream1). Bool value (onoroff) is accepted. Device (display) specific feature. Pro feature.pip- Enable/disable picture in picture for a specified display or alter PIP settings by providing additional parameters. Usespecifierto specify the appropriate PIP window (or omit for the default window1). Must also be specified (without value) if a stream specific setting is changed. Bool value (onoroff) is accepted. Device (display) specific feature. Pro feature.videoFilterWindow- Enable/disable video filter window or alter its settings by providing additional parameters. Usespecifierto specify the appropriate video filter window (or omit for the default window1). Must also be specified (without value) if a stream specific setting is changed. Bool value (onoroff) is accepted. Pro feature.contentStreamWindow- Enable/disable selected content streaming or alter its settings by providing additional parameters. Usespecifierto specify the appropriate selected content stream window (or omit for the default window1). Source selection and configuration management are available in the app menu. Must also be specified (without value) if a stream specific setting is changed. Bool value (onoroff) is accepted. Pro feature.protectResolution- Enable/disable resolution protection. Setting it toonprotects current setting. Bool value (onoroff) is accepted. Device (display) specific feature. Pro feature.protectRefreshRate- Enable/disable refresh rate protection. Setting it toonprotects current setting. Bool value (onoroff) is accepted. Device (display) specific feature. Pro feature.protectHDR- Enable/disable HDR state protection. Setting it toonprotects current setting. Bool value (onoroff) is accepted. Device (display) specific feature. Pro feature.protectRotation- Enable/disable rotation protection. Setting it toonprotects current setting. Bool value (onoroff) is accepted. Device (display) specific feature. Pro feature.protectAsMain- Enable/disable main status protection. Setting it toonworks only if the display is main display. Bool value (onoroff) is accepted. Device (display) specific feature. Pro feature.protectSDRProfile- Enable/disable SDR profile protection. Setting it toonprotects current setting and works only if the display is in SDR mode. Bool value (onoroff) is accepted. Device (display) specific feature. Pro feature.protectHDRProfile- Enable/disable HDR profile protection. Setting it toonprotects current setting and works only if the display is in HDR mode. Bool value (onoroff) is accepted. Device (display) specific feature. Pro feature.protectSDRColorMode- Enable/disable SDR color mode protection. Setting it toonprotects current setting and works only if the display is in SDR mode. Requires Apple silicon. Bool value (onoroff) is accepted. Device (display) specific feature. Pro feature.protectHDRColorMode- Enable/disable HDR color mode protection. Setting it toonprotects current setting and works only if the display is in HDR mode. Requires Apple silicon. Bool value (onoroff) is accepted. Device (display) specific feature. Pro feature.protectAll- Enable/disable all protection. Setting it toonturns on all protections that can be activated for a display. Bool value (onoroff) is accepted. Device (display) specific feature. Pro feature.hardwarePowerOff- Turns a display off. Requires a DDC compatible external display that supports this feature. No value must be specified. Device (display) specific feature.hardwareFactoryReset- Reset factory settings for a display. Requires a DDC compatible external display that supports this feature. No value must be specified. Device (display) specific feature.sendCEC- Sends an HDMI-CEC command through DisplayPort AUX DPCD CEC tunneling where supported. Use withperform, for example-sendCEC=volumeUp. The target can be selected withCECAddressand defaults totv. Usevolume+Xorvolume-Xto change volume by multiple steps, for example-sendCEC=volume+5. Use-sendCEC=inputorinput:macto ask the TV to switch to this Mac's HDMI input, orinput:2/input:1.2/input:2.0.0.0to broadcast a specific HDMI-CEC physical address. Available on Apple silicon Macs only. Device (display) specific feature. Available values:volumeUp,volumeDown,mute,standby,wake,input,select,up,down,left,right,rootMenu,setupMenu,contentsMenu,exit.resetColorAdjustments- Reset software image adjustments. No value must be specified. Device (display) specific feature.reinitialize- Reinitialize display connection and reload custom configuration. Works with natively connected displays on Apple silicon Macs. No value must be specified. Device (display) specific feature.colorProfileReset- Reset color profile to factory setting for a display. No value must be specified. Device (display) specific feature.xdrPresetReset- Reset Apple Display Preset to factory setting for a display. No value must be specified. Device (display) specific feature.standardFramebuffer- Set framebuffer color mapping to normal. Available on Apple silicon Macs only. No value must be specified. Device (display) specific feature.invertedFramebuffer- Set framebuffer color mapping to inverted. Available on Apple silicon Macs only. No value must be specified. Device (display) specific feature.grayscaleFramebuffer- Set framebuffer color mapping to grayscale. Available on Apple silicon Macs only. No value must be specified. Device (display) specific feature.invertedGrayscaleFramebuffer- Set framebuffer color mapping to inverted grayscale. Available on Apple silicon Macs only. No value must be specified. Device (display) specific feature.customEDID- Custom EDID binary in Base64 format. Usesetandgetto set and retrieve the currently configured data. Volatile custom EDID application is available on Apple silicon Macs only. Specific values must be provided. Device (display) specific feature.applyCustomEDID- Apply custom EDID. usecustomEDIDto set the EDID data to be applied. Works on Apple silicon Macs only. No value must be specified. Device (display) specific feature. Pro feature.applyFactoryEDID- Restore the factory EDID. Works on Apple silicon Macs only. No value must be specified. Device (display) specific feature. Pro feature.autoApplyCustomEDID- Configures custom EDID auto-apply. Bool value (onoroff) is accepted. Device (display) specific feature. Pro feature.i2cEDID- Reads the display's EDID using I2C. Device (display) specific feature.osEDID- Shows the display EDID recorded by the OS. Device (display) specific feature.EDIDReport- Gets an Extended Display Identification Data (EDID) report for the display. Use withget. Provides decoded display identity, timing, color, CTA extension and raw EDID information. Information retrieval feature. Device (display) specific feature.rawDPCD- Dumps raw DisplayPort Configuration Data (DPCD) bytes as a 16-byte-per-line hex dump. Use withget. Optional value sets the start address and size, for example-rawDPCD=0x1000+4K. Full zero lines are omitted unless+0is added, for example-rawDPCD=+4K+0. Available on Apple silicon Macs only. Information retrieval feature. Device (display) specific feature.DPCDReport- Gets a DisplayPort Configuration Data (DPCD) report for the display. Use withget. Provides decoded DPCD register information, HDMI-CEC tunneling capability information and non-zero raw DPCD blocks. Available on Apple silicon Macs only. Information retrieval feature. Device (display) specific feature.CECReport- Gets an HDMI-CEC report through DisplayPort AUX DPCD CEC tunneling where supported. Use withget. Probes basic device information such as power status, physical address, vendor ID and OSD name. Available on Apple silicon Macs only. Information retrieval feature. Device (display) specific feature.DSCReport- Gets a Display Stream Compression (DSC) report for the display. Use withget. Provides the current DSC PPS payload and decoded DSC stream fields. Available on Apple silicon Macs only. Information retrieval feature. Device (display) specific feature.identifier- Returns the specified identifier's value. Works withtagID,UUID,displayID,originalName,name,productName,vendor,model,serial,alphanumericSerial,yearOfManufacture,weekOfManufacture,registryLocation. Use with thegetoperation. Information retrieval feature. Device (display) specific feature.identifiers- Lists display, virtual screen and display group identifiers in a JSON structure. Use with thegetoperation. Information retrieval feature. Device (display) specific feature.xdrPresetList- List Apple Display Presets suitable for a display. Use with thegetoperation. Use with thegetoperation. Information retrieval feature. Device (display) specific feature.displayModeList- Lists available display modes. Use with thegetoperation. Information retrieval feature. Device (display) specific feature.installedColorProfileURLs- List installed color profiles. Use with thegetoperation. Information retrieval feature. Not a device (display) specific feature.displayInformation- Gets the detailed display information report. Use withget. Provides the same text output as the Display Information export. Information retrieval feature. Device (display) specific feature.appleBrightnessReport- Gets an Apple brightness report for Apple displays. Use withget. Provides useful Apple display brightness data such as brightness capability, brightness state, color adaptation, HDR/EDR and high-brightness boost state when available. Information retrieval feature. Device (display) specific feature.ddcCapabilities- Explores DDC capabilities by parsing the DDC capabilities string and attempting to read supported commands. Use withget. Provides a brief report. Device (display) specific feature.ddcCapabilitiesString- Gets the DDC capabilities string from the display. Use withget. Provides the unparsed string. Device (display) specific feature.preferredConnectionMode- Shows preferred connection mode. Available on Apple silicon Macs for natively connected displays. Use with thegetoperation. Information retrieval feature. Device (display) specific feature.connectionModeListAll- Lists all available connection modes. Available on Apple silicon Macs for natively connected displays. Use with thegetoperation. Information retrieval feature. Device (display) specific feature.connectionModeList- Lists available connection modes matching current mode (in terms of resolution, refresh rate, HDR state). Available on Apple silicon Macs for natively connected displays. Use with thegetoperation. Information retrieval feature. Device (display) specific feature.refreshRateList- Lists available refresh rate and VRR state options matching current display mode (in terms of resolution, HDR state), including unexposed (NTSC) timings on Apple silicon. Use with thegetoperation. Information retrieval feature. Device (display) specific feature.remoteKeyList- List known remote key codes if supported by the device. Usespecifierto specify the controller if multiple controllers support virtual remotes. Information retrieval feature. Device (display) specific feature.inputSourceList- List input sources if the device supports input source change. Usespecifierto specify the controller if multiple controllers support virtual remotes. Use thechangeInputSourcecommand to switch to an input source. Information retrieval feature. Device (display) specific feature.configuredControllerList- Lists the configured controllers for a device. Controller names can be used withspecifierfor certain operations to specify the controller when the operation is supported by multiple controllers. Information retrieval feature. Device (display) specific feature.enabled- Enable or disable a display group. Bool value (onoroff) is accepted. Display group management feature.active- Get the activation status of a display group. Bool value (onoroff) is accepted. Display group management feature. Information retrieval feature.activationPolicy- Display group activation policy. Possible values:always,allMembersPresent,anyMembersPresent,anyTwoMembersPresent,anySyncSourceWithTargetMembersPresent. Specific values must be provided. Display group management feature.synchronization- Display group synchronization. Bool value (onoroff) is accepted. Display group management feature.layoutProtection- Display group layout protection. Bool value (onoroff) is accepted. Display group management feature.uiScaleMatching- Display group UI scale matching. Bool value (onoroff) is accepted. Display group management feature.nightShiftValue- Specifies Night Shift value. Pro feature. A contiguous range of values are accepted. Not a device (display) specific feature.nightShift- Turns Night Shift on or off. Pro feature. Bool value (onoroff) is accepted. Not a device (display) specific feature.trueTone- Turns True Tone on or off. Pro feature. Bool value (onoroff) is accepted. Not a device (display) specific feature.darkMode- Turns Dark Mode on or off. Pro feature. Bool value (onoroff) is accepted. Not a device (display) specific feature.disableNightShiftInHDR- Toggles the feature on or off that toggles Night Shift when an external display is put to HDR or SDR mode using the app. Pro feature. Bool value (onoroff) is accepted. Not a device (display) specific feature.proAvailable- Returns whether Pro features are available or not. Use withgetoperation. Bool value (onoroff) is accepted. Not a device (display) specific feature.osdShowBasic- Turns showing basic native OSD (brightness, volume) on/off (useful for third party OSD app integration). Bool value (onoroff) is accepted. Not a device (display) specific feature.osdShowCustom- Turns showing custom OSD on/off (useful for third party OSD app integration). Bool value (onoroff) is accepted. Not a device (display) specific feature.osdIntegrationNotification- Turns third party OSD integration app notifications on/off. Bool value (onoroff) is accepted. Not a device (display) specific feature.appMenu- Show app menu. Bool value (onoroff) is accepted. Not a device (display) specific feature.settingsWindow- Show Settings. Bool value (onoroff) is accepted. Not a device (display) specific feature.consoleLog- Show app logs in the console. Bool value (onoroff) is accepted. Not a device (display) specific feature.reconfigure- Redetect/reconfigure displays. No value must be specified. Not a device (display) specific feature.disconnectAllButMain- Disconnects all displays except the current main display. Pro feature. No value must be specified. Not a device (display) specific feature.connectAllDisplays- Connects all displays (even unlisted ones). Pro feature. No value must be specified. Not a device (display) specific feature.swapIdenticalDisplays- Swap identical displays. Pro feature. No value must be specified. Not a device (display) specific feature.resetVMM7100- Reset VMM7100 HDMI adapter if present. Available on Apple silicon Macs only. No value must be specified. Not a device (display) specific feature.restartApp- Restart app. No value must be specified. Not a device (display) specific feature.sidecarList- List Sidecar display names and UUIDs. Information retrieval feature. Not a device (display) specific feature.sidecarConnected- Connect a Sidecar display specify Sidecar display's name or UUID usingspecifierBool value (onoroff) is accepted. Not a device (display) specific feature.quitApp- Quit app. No value must be specified. Not a device (display) specific feature.appMenuIcon- Configure app menu icon by providing an SF Symbol name likeface.smiling. Provide no value to reset default. Specific values must be provided. Not a device (display) specific feature.
Parameters specific for various features
addConfiguration- Add an additional configuration. Configuration ID needs to be specified, otherwise the first available slot will be used as ID. Used by the following:stream,pip,videoFilterWindow. No value must be specified. Pro feature.removeConfiguration- Remove a configuration. Configuration ID needs to be specified. Used by the following:stream,pip,videoFilterWindow. No value must be specified. Pro feature.freeAspect- Free aspect ratio. Used by the following:stream,pip,contentStreamWindow. Bool value (onoroff) is accepted. Pro feature.integerScaling- Integer scaling. Used by the following:stream,pip,contentStreamWindow. Bool value (onoroff) is accepted. Pro feature.directPixelMapping- Direct (1:1) pixel mapping. Used by the following:stream. Bool value (onoroff) is accepted. Pro feature.rotateBy- Rotate image. Valid values are0,90,180,270. Used by the following:stream,pip,contentStreamWindow. Specific values must be provided. Pro feature.flipHorizontal- Flip horizontally. Used by the following:stream,pip,contentStreamWindow. Bool value (onoroff) is accepted. Pro feature.flipVertical- Flip vertically. Used by the following:stream,pip,contentStreamWindow. Bool value (onoroff) is accepted. Pro feature.horizontalLocation- Horizontal alignment. Used by the following:stream,contentStreamWindow. Specific values must be provided. Pro feature. Available values:left,center,right.verticalLocation- Vertical alignment. Used by the following:stream,contentStreamWindow. Specific values must be provided. Pro feature. Available values:top,center,bottom.cursorShown- Show mouse cursor. Used by the following:stream,pip,contentStreamWindow. Bool value (onoroff) is accepted. Pro feature.streamUnderscan- Stream underscan. Used by the following:stream. A contiguous range of values are accepted. Pro feature.zoom- Zoom level. Used by the following:stream,contentStreamWindow. A contiguous range of values are accepted. Pro feature.videoFilters- Enable/disable built-in video filter processing. UsevideoFilterto adjust an individual filter. Used by the following:stream,pip,contentStreamWindow. Bool value (onoroff) is accepted. Pro feature.videoFilter- Select video adjustments using stable, case-insensitive names. Specify exactly one output type and usespecifierfor its configuration ID (default1). Usesetwithvalue(or a value on the output parameter, such as-pip=0.2) to adjust,getto read, ortogglefor boolean filters. For a batch, use-videoFilter="brightness=0.2,invert=on",-videoFilter -value="brightness=0.2,invert=on", or-pip="brightness=0.2,invert=on" -videoFilter. Inline assignments cannot accompany a separate main value. Every set entry requires a value; get and toggle accept comma-separated names and return query results in that order. Duplicate filters are rejected and the entire batch is validated before applying. Numeric values use the app slider ranges (hue in radians, temperature in kelvin);minandmaxquery or rescale these ranges andoffsetapplies relative numeric changes to a numeric-only batch. Percentages are divided by 100 (20%equals0.2); a sign alone does not imply an offset. Usecustom:<name>to enable, disable, or query an existing custom filter.photoEffectaccepts none, noir, chrome, instant, fade, transfer, process;blendModeaccepts none, multiply, screen, overlay, softLight, hardLight, difference, exclusion, color, hue, saturation, luminosity. Their enable switches arephotoEffectEnabledandblendModeEnabled. Other output settings can be changed in the same command; built-in adjustments do not enablevideoFiltersor start/stop the output. Existingfilter...controller commands are unaffected. Example:set -pip -specifier=2 -videoFilter=brightness -value=0.2. Used by the following:stream,pip,videoFilterWindow,contentStreamWindow. Specific values must be provided. Pro feature. Available values:blendMode,blendModeEnabled,blendStrength,bloomIntensity,brightness,cmykHalftone,colorPosterize,comic,contrast,crystallizeRadius,dotScreen,edgeWorkRadius,edges,exposure,gamma,gaussianBlur,gloomIntensity,hatchedScreen,hexagonalPixellate,highlight,hue,invert,lineScreen,median,monochrome,motionBlur,noiseReduction,photoEffect,photoEffectEnabled,pixellateScale,pointillize,saturation,sepia,shadow,sharpenLuminance,temperature,thermal,unsharpMask,vibrance,vignette,xRay,custom:<name>.renderHDR- HDR rendering for video filters. Used by the following:stream,pip,contentStreamWindow. Bool value (onoroff) is accepted. Pro feature.alpha- Stream window alpha (transparency, percentage value expected). Used by the following:stream,pip,videoFilterWindow,contentStreamWindow. A contiguous range of values are accepted. Pro feature.fpsTarget- Target frame rate for stream capture. Use0for unlimited or an integer value from1to200frames per second. Used by the following:stream,pip,videoFilterWindow,contentStreamWindow. A contiguous range of values are accepted. Pro feature.partial- Crop image. Used by the following:stream,pip. Bool value (onoroff) is accepted. Pro feature.partialOriginX- Crop window origin X (percentage value, relative to the display size). Used by the following:stream,pip. A contiguous range of values are accepted. Pro feature.partialOriginY- Crop window origin Y (percentage value, relative to the display size). Used by the following:stream,pip. A contiguous range of values are accepted. Pro feature.partialWidth- Crop window width (percentage value, relative to the display size). Used by the following:stream,pip. A contiguous range of values are accepted. Pro feature.partialHeight- Crop window height (percentage value, relative to the display size). Used by the following:stream,pip. A contiguous range of values are accepted. Pro feature.resume- Resume stream on connect. Used by the following:stream. Bool value (onoroff) is accepted. Pro feature.priority- Window priority. Used by the following:pip,videoFilterWindow,contentStreamWindow. Specific values must be provided. Pro feature. Available values:normal,topmost,absolute,absoluteLockScreen.unmovable- Lock window position. Used by the following:pip,videoFilterWindow,contentStreamWindow. Bool value (onoroff) is accepted. Pro feature.clickthrough- Mouse click-through window. Used by the following:pip,videoFilterWindow,contentStreamWindow. Bool value (onoroff) is accepted. Pro feature.showTitlebar- Show window titlebar. Used by the following:pip,videoFilterWindow,contentStreamWindow. Bool value (onoroff) is accepted. Pro feature.showShadow- Show window shadow. Used by the following:pip,videoFilterWindow,contentStreamWindow. Bool value (onoroff) is accepted. Pro feature.excludePipWindow- Exclude PIP window. Used by the following:pip. Bool value (onoroff) is accepted. Pro feature.magnification- Magnification. Used by the following:pip,contentStreamWindow. A contiguous range of values are accepted. Pro feature.autoStart- Start automatically. Used by the following:pip,videoFilterWindow,contentStreamWindow. Bool value (onoroff) is accepted. Pro feature.originX- Window origin X (percentage value, relative to the target display size). Used by the following:pip,videoFilterWindow. A contiguous range of values are accepted. Pro feature.originY- Window origin Y (percentage value, relative to the target display size, zero is the bottom of the screen). Used by the following:pip,videoFilterWindow. A contiguous range of values are accepted. Pro feature.width- Window width (percentage value, relative to the target display size). Used by the following:pip,videoFilterWindow. A contiguous range of values are accepted. Pro feature.height- Window height (percentage value, relative to the target display size). Used by the following:pip,videoFilterWindow. A contiguous range of values are accepted. Pro feature.vcp- Specifies the DDC coontrol code (VCP - Virtual Control Panel) that is being accessed when sending a DDC command. Use VCP name, decimal or a hexadecimal number (supplied with0xprefix). Used by the following:ddc,ddcAlt. Specific values must be provided. Available values:unknown,horizontalFrequency,verticalFrequency,sourceColorCoding,displayUsageTime,displayControllerId,displayFirmwareLevel,osdLanguage,powerMode,imageMode,vcpVersion,horizontalPosition,horizontalSize,horizontalPincushion,horizontalPincushionBalance,horizontalConvergenceRB,horizontalConvergenceMG,horizontalLinearity,horizontalLinearityBalance,verticalPosition,verticalSize,verticalPincushion,verticalPincushionBalance,verticalConvergenceRB,verticalConvergenceMG,verticalLinearity,verticalLinearityBalance,horizontalParallelogram,verticalParallelogram,horizontalKeystone,verticalKeystone,rotation,topCornerFlare,topCornerHook,bottomCornerFlare,bottomCornerHook,horizontalMirror,verticalMirror,displayScaling,windowPositionTopLeftX,windowPositionTopLeftY,windowPositionBottomRightX,windowPositionBottomRightY,scanMode,degauss,newControlValue,softControls,activeControl,performancePreservation,inputSelect,inputSelectAlt,ambientLightSensor,remoteProcedureCall,displayIdentificationOnDataOperation,tvChannelUpDown,flatPanelSubPixelLayout,displayTechnologyType,displayDescriptorLength,transmitDisplayDescriptor,enableDisplayOfDisplayDescriptor,applicationEnableKey,displayEnableKey,statusIndicator,auxiliaryDisplaySize,auxiliaryDisplayData,outputSelect,assetTag,auxiliaryPowerOutput,scratchPad,audioSpeakerVolume,speakerSelect,audioMicrophoneVolume,audioJackConnectionStatus,audioMuteScreenBlank,audioTreble,audioBass,audioBalanceLR,audioProcessorMode,osd,sixAxisHueControlBlue,sixAxisHueControlCyan,sixAxisHueControlGreen,sixAxisHueControlMagenta,sixAxisHueControlRed,sixAxisHueControlYellow,sixAxisSaturationControlBlue,sixAxisSaturationControlCyan,sixAxisSaturationControlGreen,sixAxisSaturationControlMagenta,sixAxisSaturationControlRed,sixAxisSaturationControlYellow,adjustZoom,autoColorSetup,autoSetup,autoSetupOnOff,backlightControlLegacy,backlightLevelWhite,backlightLevelRed,backlightLevelGreen,backlightLevelBlue,blockLutOperation,clock,clockPhase,colorSaturation,colorTemperatureIncrement,colorTemperatureRequest,contrast,displayApplication,fleshToneEnhancement,focus,gamma,grayScaleExpansion,horizontalMoire,hue,luminance,lutSize,screenOrientation,selectColorPreset,sharpness,singlePointLutOperation,stereoVideoMode,tvBlackLevel,tvContrast,tvSharpness,userColorVisionCompensation,velocityScanModulation,verticalMoire,videoBlackLevelBlue,videoBlackLevelGreen,videoBlackLevelRed,videoGainBlue,videoGainGreen,videoGainRed,windowBackground,windowControlOnOff,windowSelect,windowSize,windowTransparency,restoreFactoryDefaults,restoreFactoryLuminanceContrastDefaults,restoreFactoryGeometryDefaults,restoreFactoryColorDefaults,restoreFactoryTvDefaults,settings,blackStabilizer,colorPresetC,powerControl,topLeftScreenPurity,topRightScreenPurity,bottomLeftScreenPurity,bottomRightScreenPurity.CECAddress- Specifies the HDMI-CEC logical destination address forsendCEC. Use a number from 0 to 15 or a descriptive name. Defaults totv. Used by the following:sendCEC. Specific values must be provided. Available values:tv (0),recording1 (1),recording2 (2),tuner1 (3),playback1 (4),audioSystem (5),tuner2 (6),tuner3 (7),playback2 (8),recording3 (9),tuner4 (10),playback3 (11),reserved1 (12),reserved2 (13),freeUse (14),broadcast (15).specifier- Specifies additional information for a feature. Used by the following:framebufferBoolProperty,framebufferNumericProperty,sidecarConnected. Specific values must be provided.targetTagID- Identify a target device via the display's tagID which is a BetterDisplay provided unique numeric ID specific to this app installation. Used by the following:moveTo,mirror,stream,pip,videoFilterWindow.targetUUID- Identify a target device via the display's UUID assigned by this macOS installation. Used by the following:moveTo,mirror,stream,pip,videoFilterWindow.targetDisplayID- Identify a target device using the displayID issued by macOS. This ID might change from time-to-time. Used by the following:moveTo,mirror,stream,pip,videoFilterWindow.targetName(ortargetN) - Identify a target device using its displayed name in BetterDisplay. Used by the following:moveTo,mirror,stream,pip,videoFilterWindow.targetNameLike- Identify a target using a part of its displayed name in BetterDisplay (case insensitive). Used by the following:moveTo,mirror,stream,pip,videoFilterWindow.targetOriginalName- Identify a target device using its name in BetterDisplay. Used by the following:moveTo,mirror,stream,pip,videoFilterWindow.targetOriginalNameLike- Identify a target device using a part of its name in BetterDisplay (case insensitive). Used by the following:moveTo,mirror,stream,pip,videoFilterWindow.targetSelf- Can be used to initiate the self-stream with video filters feature for streams. Used by the following:stream.