Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 2.19 KB

README.md

File metadata and controls

55 lines (34 loc) · 2.19 KB
Raw

betterdisplaycli

A simple command line app to interact with BetterDisplay.

BetterDisplay must be running and configured to accept CLI commands (this is the default setting).

Installation and usage

Prerequisites

Installation

Method 1 - Direct download

  1. Download the compiled, signed, notarized, universal binary version: betterdisplaycli-v1.0.1.zip
  2. Optionally move the downloaded binary to its permanent location (recommended: /usr/local/bin).

Method 2 - Automated compile and installation using Homebrew

  1. Install XCode.
  2. Enter brew install waydabber/betterdisplay/betterdisplaycli

Method 3 - Manual compile and installation from source

  1. Install XCode.
  2. Download source package git clone https://github.com/waydabber/betterdisplaycli
  3. Enter the downloaded folder: cd ./betterdisplaycli
  4. Enter sudo make install. This will compile the app and install it under /usr/local/bin.

... or instead of the last step you can continue like this:

  1. Compile by entering: swiftc betterdisplaycli.swift
  2. Move the compiled betterdisplaycli binary to a location where it's easily available in $PATH.

Usage

  1. Make sure BetterDisplay 2.2.x and newer is running and is configured to accept CLI/notification requests.
  2. Run betterdisplaycli for help.
  3. Try betterdisplaycli set --brightness=80% to set the brightness level of all displays to 80% (note: you can use both single and double hyphen style for parameters).

Note

You can use the installed app itself to send CLI commands as well - the following prints help:

/Applications/BetterDisplay.app/Contents/MacOS/BetterDisplay help

CLI and integration documentation

More info and other integration options:

This app also serves as a demonstration of how to integrate your app with BetterDisplay using notification dispatch.