https://github.com/waydabber/betterdisplaycli

Simple CLI access for BetterDisplay
https://github.com/waydabber/betterdisplaycli

betterdisplay cli command display integration line macos management notification swift

Last synced: 23 days ago
JSON representation

Simple CLI access for BetterDisplay

• Host: GitHub
• URL: https://github.com/waydabber/betterdisplaycli
• Owner: waydabber
• License: mit
• Created: 2024-02-07T15:22:57.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-06-28T22:18:36.000Z (5 months ago)
• Last Synced: 2024-10-16T08:12:39.720Z (about 1 month ago)
• Topics: betterdisplay, cli, command, display, integration, line, macos, management, notification, swift
• Language: Swift
• Homepage: https://betterdisplay.pro
• Size: 19.5 KB
• Stars: 18
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# betterdisplaycli

A simple command line app to interact with [BetterDisplay](https://betterdisplay.pro).

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

## Installation and usage

### Prerequisites

- XCode or XCode Developer Tools must be installed (enter `xcode-select --install`).

- [BetterDisplay](https://betterdisplay.pro) v2.2.0 or later must be installed.

### Automated installation via Homebrew

1. Enter `brew install waydabber/betterdisplay/betterdisplaycli`

### Manual installation

1. Download source package `git clone https://github.com/waydabber/betterdisplaycli`

2. Enter the downloaded folder: `cd ./betterdisplaycli`

3. 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:

3. Compile by entering: `swiftc betterdisplaycli.swift`

4. 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.

1. Run `betterdisplaycli` for help.

1. 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:

- https://github.com/waydabber/BetterDisplay/wiki/Integration-features,-CLI

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