https://github.com/zefirka/ohmyxbar
https://github.com/zefirka/ohmyxbar
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zefirka/ohmyxbar
- Owner: zefirka
- Created: 2022-04-15T09:29:50.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-07-06T12:52:05.000Z (almost 4 years ago)
- Last Synced: 2025-03-23T06:28:47.451Z (over 1 year ago)
- Language: TypeScript
- Size: 46.9 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Oh My Xbar
OhMyXbar is a all-in-one plugin for xBar which allows to show your tickets from Jira, activity in Github and custom links directly on Mac's menu bar.
### Requirements
- OSX >= 13
- [npx](https://www.npmjs.com/package/npx)
### Install
```bash
curl https://raw.githubusercontent.com/zefirka/ohmyxbar/master/install.sh | bash
```
### Configuration
Configuration by default stored in `~/.ohmyxbar.js`
- `header` - symbol to draw in header (🤔 by default)
- `quickLinks` - nested map of links, where key is title, value is link or other map
- `plugins` - plugins configs
#### Jira config
```ts
{
host: "jira-host.atlassian.net",
email: "your-email@example.com",
token: "jira token",
// custom user id, by default: currentUser()
userId?: "1234-20-32-30",
// custom JQL to grab tickets
jql?: "asignee = currentUser() and priority = High",
// order key
order?: "key",
// list of statuses to exclude
excludeStatuses?: ["closed"],
// statuses map
statuses?: {
groupTitle: string;
statuses: string[];
color: string;
}[] | [status: string, color: string][];
// make projects as links to project jql
linkToProjectFilter?: boolean;
// make statuses header as links to project jql
linkToStatusFilter?: boolean;
// count of tickets by status (by default: 10)
ticketsByStatus?: number;
// draw separators between groups (applicable only in flat mode)
useSeparators?: boolean;
// how to group tickets
groupDepth?: 'flat' | 'by-project' | 'by-status';
}
```