SwiftBar

[![GitHub license](https://img.shields.io/github/license/swiftbar/SwiftBar.svg)](https://github.com/swiftbar/SwiftBar/blob/master/LICENSE)
[![Latest Release](https://img.shields.io/github/v/release/swiftbar/SwiftBar)](https://github.com/swiftbar/SwiftBar/releases/latest)
[![Github all releases](https://img.shields.io/github/downloads/swiftbar/SwiftBar/total.svg)](https://github.com/swiftbar/SwiftBar/releases/)


<p align="center">
 <img width="155" alt="SwiftBar Logo" src="Resources/logo.png">
</p>

# SwiftBar

Add custom menu bar programs on macOS in three easy steps:
- Write a shell script
- Add it to SwiftBar
- ... there is no 3rd step!

You can get plugins from awesome [BitBar repository](https://github.com/matryer/bitbar-plugins), or in SwiftBar itself using the `Get Plugins...` menu item.

## How to get SwiftBar
Download from [GitHub Releases](https://github.com/swiftbar/SwiftBar/releases)

or Install with Homebrew

```
brew install swiftbar
```

Runs on macOS Monterey (12) and later.

## ...or build it from source
- Clone or download a copy of this repository
- Open `SwiftBar/SwiftBar.xcodeproj`
- Press play

## Plugin Repository

SwiftBar is bundled with a Plugin Repository. You can access it at Swiftbar → Get Plugins...

<p align="center">
 <img width="600" alt="A screenshot of SwiftBar’s Plugin Repository" src="https://user-images.githubusercontent.com/222100/110520713-d5058000-80dc-11eb-9b15-baa09cb445bf.png">
</p>

If you want to add\remove plugin or have other questions about repository content please refer to this [issue](https://github.com/swiftbar/swiftbar-plugins/issues/1).

## Creating Plugins

To add a new plugin to SwiftBar, you need to create an executable script following the required format (see below) and put it into `Plugin Folder`. 

### Plugin Folder

With the first launch, Swiftbar will ask you to set the `Plugin Folder`. SwiftBar will try to import every file in this folder as a plugin.

**Important**:
* hidden folders are ignored
* nested folders are traversed by SwiftBar, including symlinks
* `.swiftbarignore` file is supported, you can use it to exclude files from being imported as plugins.

You can hide a folder by prepending `.` or using this command `chflags hidden <folder name>`.

### Plugin Naming

Plugin files must adopt the following format:

```
{name}.{time}.{ext}
```

* **name** - Anything you want.
* **time** - Refresh interval (optional). Should be a number + duration modifier (see below)
* **ext** - File extension.

Duration modifiers:
* **ms** - milliseconds, e.g. 1ms - refresh every millisecond
* **s** - seconds, e.g. 1s - refresh every second
* **m** - minute, e.g. 10m - refresh every ten minutes
* **h** - hour, e.g. 3h - refresh every three hours
* **d** - day, e.g. 1d - refresh every day

Example filename: `date.1m.sh`

Whether you are using a plugin from the plugin repository, or creating your own, plugins will initially appear in the menu bar in no pre-determined order. However, you can reorder