SketchyBar

https://felixkratz.github.io/SketchyBar/config/bar
Admin
SketchyBar is a highly customizable macOS status bar application that allows users to configure and...
Tokens:1,307
Snippets:4
Trust Score:8.3
Update:7 months ago
Show doc for...
Tokens:
Raw
### Configure Bar Properties

Source: https://felixkratz.github.io/SketchyBar/config/bar

This endpoint allows you to configure various properties of the SketchyBar bar, such as its color, position, height, and more. Changes can be made on the command line while the bar is running and then saved to the `sketchybarrc` file for persistence.

```APIDOC
## POST /--bar

### Description
Allows configuration of global bar properties. These settings can be applied dynamically while the bar is running or set in the `sketchybarrc` file for persistence.

### Method
POST

### Endpoint
`sketchybar --bar <setting>=<value> ... <setting>=<value>`

### Parameters
#### Query Parameters
- **setting** (string) - Required - The name of the bar property to configure.
- **value** (string) - Required - The value to set for the specified property.

**Possible Settings and Values:**
- `color` (<argb_hex>) - Color of the bar. Default: `0x44000000`
- `border_color` (<argb_hex>) - Color of the bar's border. Default: `0xffff0000`
- `position` (top, bottom) - Position of the bar on the screen. Default: `top`
- `height` (<integer>) - Height of the bar. Default: `25`
- `notch_display_height` (<integer>) - Override of the height of the bar on notched displays. Default: `0`
- `margin` (<integer>) - Margin around the bar. Default: `0`
- `y_offset` (<integer>) - Vertical offset of the bar from its default position. Default: `0`
- `corner_radius` (<positive_integer>) - Corner radius of the bar. Default: `0`
- `border_width` (<positive_integer>) - Border width of the bar's border. Default: `0`
- `blur_radius` (<positive_integer>) - Blur radius applied to the background of the bar. Default: `0`
- `padding_left` (<positive_integer>) - Padding between the left bar border and the leftmost item. Default: `0`
- `padding_right` (<positive_integer>) - Padding between the right bar border and the rightmost item. Default: `0`
- `notch_width` (<positive_integer>) - The width of the notch to be accounted for on the internal display. Default: `200`
- `notch_offset` (<positive_integer>) - Additional `y_offset` exclusively applied to notched screens. Default: `0`
- `display` (main, all, <positive_integer list>) - Display to show the bar on. Default: `all`
- `hidden` (<boolean>, current) - If all / the current bar is hidden. Default: `off`
- `topmost` (<boolean>, window) - If the bar should be drawn on top of `everything`, or on top of all `window`s. Default: `off`
- `sticky` (<boolean>) - Makes the bar sticky during space changes. Default: `on`
- `font_smoothing` (<boolean>) - If fonts should be smoothened. Default: `off`
- `shadow` (<boolean>) - If the bar should draw a shadow. Default: `off`

### Request Example
```json
{
  "command": "sketchybar --bar color=0xffff0000 position=bottom height=30"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Configure Sketchybar Bar Properties

Source: https://felixkratz.github.io/SketchyBar/config/bar

This command allows you to set global properties for the Sketchybar bar. You can modify settings like color, position, height, and more directly from the command line. Changes made this way are temporary unless added to the `sketchybarrc` file.

```bash
sketchybar --bar <setting>=<value> ... <setting>=<value>
```
Tokens:
Raw