Skip to content

Commit d1d9bc8

Browse files
docs: Update CLI.md to document dock radius commands
- Add -d, --dock-radius options for controlling dock corner radius - Update examples and status output to include dock radius - Clarify distinction between window and dock radius commands
1 parent edb8a3c commit d1d9bc8

File tree

1 file changed

+20
-28
lines changed

1 file changed

+20
-28
lines changed

CLI.md

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,14 @@ sharpener off
1212
# Toggle
1313
sharpener toggle
1414

15-
# Set radius
15+
# Set window radius
1616
sharpener -r 40
1717
sharpener --radius=40
1818

19+
# Set dock radius
20+
sharpener -d 20
21+
sharpener --dock-radius=20
22+
1923
# Show current settings
2024
sharpener -s
2125
sharpener --status
@@ -33,25 +37,31 @@ sharpener --version
3337

3438
## Options
3539

36-
- `-r, --radius <value>` — Set the sharpening radius (integer `>= 0`)
37-
- `--radius=<value>` — Alternative syntax to set radius
38-
- `-s, --status` — Show current radius and status (`on`/`off`)
40+
- `-r, --radius <value>` — Set the window sharpening radius (integer `>= 0`)
41+
- `--radius=<value>` — Alternative syntax to set window radius
42+
- `-d, --dock-radius <value>` — Set the dock radius (integer `>= 0`)
43+
- `--dock-radius=<value>` — Alternative syntax to set dock radius
44+
- `-s, --status` — Show current window radius, dock radius, and status (`on`/`off`)
3945
- `-v, --version` — Show CLI version
4046
- `-h, --help` — Show built‑in help
4147

4248
## Examples
4349

4450
```bash
45-
# Set radius to 0 for sharp (square) corners
51+
# Set window radius to 0 for sharp (square) corners
4652
sharpener -r 0
4753

48-
# Set radius to 40 and enable immediately
54+
# Set dock radius to 15
55+
sharpener -d 15
56+
57+
# Set window radius to 40 and enable immediately
4958
sharpener on && sharpener -r 40
5059

5160
# Query current status
5261
sharpener -s
5362
# Output example:
5463
# Current radius: 40
64+
# Current dock radius: 15
5565
# Status: on
5666

5767
# Show version
@@ -62,14 +72,10 @@ sharpener --version
6272

6373
## Behavior Notes
6474

65-
- **Crash-resistant**: v0.0.3+ includes fixes for application crashes, especially with Zoom and other complex apps
66-
- **Smart targeting**: Only affects standard application windows with title bars and minimum size requirements
67-
- **System UI preservation**: Intelligently excludes context menus, tooltips, HUD/utility windows, and floating panels
68-
- **Window level awareness**: Respects macOS window hierarchy to avoid affecting system overlays
69-
- **Notification-based updates**: Uses safe window lifecycle events for corner radius application
70-
- Fullscreen windows use a radius of `0` to avoid visual artifacts
71-
- Changes apply live across open windows; no app relaunch required
72-
- Enabled state and radius persist across apps via system notifications
75+
- Targets standard application windows only; menus, popovers, HUD/utility windows are preserved.
76+
- Fullscreen windows use a radius of `0` to avoid visual artifacts.
77+
- Changes apply live across open windows; no app relaunch required.
78+
- Enabled state and radius persist across apps via system notifications.
7379

7480
## Installation Path
7581

@@ -78,19 +84,5 @@ sharpener --version
7884

7985
## Troubleshooting
8086

81-
### Common Issues
82-
83-
**Application crashes (especially Zoom)**: Fixed in v0.0.3+ with crash-resistant design and improved window detection.
84-
85-
**Corner radius not applying to specific apps**:
86-
- Some applications may require a restart after Apple Sharpener installation
87-
- Run `sharpener -s` to verify Apple Sharpener is enabled
88-
- Check that the application uses standard titled windows
89-
90-
**System UI elements affected**:
91-
- v0.0.3+ intelligently excludes context menus, tooltips, and system overlays
92-
- If issues persist, please report with your macOS version and affected application
93-
94-
### General Troubleshooting
9587
- Run `sharpener -s` to confirm status and radius.
9688
- Ensure system requirements from the main README are met.

0 commit comments

Comments
 (0)