https://github.com/apertureless/wipfred
🚧Manage your wip.chat todos with alfred
https://github.com/apertureless/wipfred
alfred alfred-workflow alfred3-workflow wip
Last synced: 7 months ago
JSON representation
🚧Manage your wip.chat todos with alfred
- Host: GitHub
- URL: https://github.com/apertureless/wipfred
- Owner: apertureless
- Created: 2018-05-07T13:48:44.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-02-13T01:23:14.000Z (over 3 years ago)
- Last Synced: 2024-10-12T08:49:23.384Z (about 1 year ago)
- Topics: alfred, alfred-workflow, alfred3-workflow, wip
- Language: JavaScript
- Size: 1020 KB
- Stars: 21
- Watchers: 3
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
---
> Manage your [wip.chat](https://wip.chat/) todos with [Alfred](https://www.alfredapp.com/)
## 🔧 Installation
`WIPfred` requires [Alfred](https://www.alfredapp.com/) + [Powerpack](https://www.alfredapp.com/powerpack/) (Supports Alfred 4)
To install it simply run
```bash
npm install -g wipfred
```
## 👈 Configuration
In order to work properly you need to set your wip.chat private API key.
1. Visit [wip.chat/api](https://wip.chat/api)
2. Copy your private key
3. Toggle Alfred
4. Type in `wip` and press Enter
5. Select `API Key`
6. Type in your key and press Enter
## 📒 Commands
You can either type in `wip` and press Enter to see a list of available commands and select from one of them. Or you can use the command directly. However if you enter for exampel `wip done` you will be inside the `done` workflow. You have to press ESC to get out of it.
Right now directly creating or modifing todos with only one command is not possible. For example:
```
wip todo need to add this feature soon #wipfred
```
### wip key
Sets your private wip.chat API key.
### wip find
Type in `wip find` and press Enter. Then you can type in your todo and wipfred will filter all your pending wip.chat todos. After you select one and press Enter again, it will be marked as done.
### wip todo
Type in `wip todo` and press Enter. Then you can type in your todo and if you want your product and confirm with Enter.
**Example:**
```
fix a critical bug #productname
```
### wip done
Type in `wip done` and press Enter. Then you can type in your todo and if you want your product and confirm with Enter. It will create a new todo and mark it as done.
**Example:**
```
fix a critical bug #productname
```
## ⌨ Keyboard Sortcuts
You can access the workflows directly over keyboard shortcuts.
Because it is nearly impossible to set sane default what work for everyone, the default Shortcuts are empty.
You have to set them by your own. Press ⌘ , to open Alfred Preferences and select the `WIPfred` workflow.
Then you can set the shortcuts for the `find`, `done` and `todo` command.
## Support
