Skip to content

Latest commit

 

History

History
88 lines (64 loc) · 2.05 KB

CLI.md

File metadata and controls

88 lines (64 loc) · 2.05 KB

Apple Sharpener CLI

This document explains how to use the sharpener command‑line tool to control Apple Sharpener at runtime.

Quick Start

# Enable or disable
sharpener on
sharpener off

# Toggle
sharpener toggle

# Set window radius
sharpener -r 40
sharpener --radius=40

# Set dock radius
sharpener -d 20
sharpener --dock-radius=20

# Show current settings
sharpener -s
sharpener --status

# Show version
sharpener -v
sharpener --version

Commands

  • on — Enable window sharpening
  • off — Disable window sharpening
  • toggle — Toggle window sharpening on/off

Options

  • -r, --radius <value> — Set the window sharpening radius (integer >= 0)
  • --radius=<value> — Alternative syntax to set window radius
  • -d, --dock-radius <value> — Set the dock radius (integer >= 0)
  • --dock-radius=<value> — Alternative syntax to set dock radius
  • -s, --status — Show current window radius, dock radius, and status (on/off)
  • -v, --version — Show CLI version
  • -h, --help — Show built‑in help

Examples

# Set window radius to 0 for sharp (square) corners
sharpener -r 0

# Set dock radius to 15
sharpener -d 15

# Set window radius to 40 and enable immediately
sharpener on && sharpener -r 40

# Query current status
sharpener -s
# Output example:
# Current radius: 40
# Current dock radius: 15
# Status: on

# Show version
sharpener --version
# Output example:
# Apple Sharpener version: 0.1

Behavior Notes

  • Targets standard application windows only; menus, popovers, HUD/utility windows are preserved.
  • Fullscreen windows use a radius of 0 to avoid visual artifacts.
  • Changes apply live across open windows; no app relaunch required.
  • Enabled state and radius persist across apps via system notifications.

Installation Path

  • The installer places the CLI at /usr/local/bin/sharpener.
  • If building from source via make install, the CLI is installed to the same path.

Troubleshooting

  • Run sharpener -s to confirm status and radius.
  • Ensure system requirements from the main README are met.