Page MenuHomeSealhub

README.md
No OneTemporary

README.md

<center><h1>Roficator</h1></center>
Powerful extension to [rofi](https://github.com/davatorium/rofi) which allows to fetch tasks from your Phabricator instance.
## Requirements:
- Node.js
- rofi
- rofi-json-menu
## Usage:
```bash
$ roficator [--init]
```
## Configuration
When using roficator with `--init` flag, you will be presented with a few prompts which will allow to create config file, `.roficatorrc` placed in your home dir.
## .roficatorrc
```json
{
"token": "cli-foobar",
"arc": "example.com",
"defaultRequest": "configJson",
"configJson": "/home/foo/bar.json",
"configQueryKey": "foobar"
}
```
**token**
Phabricator's Conduit API token, necessary for making requests. Taken from `~/.arcrc`
**arc**
URI to your Phabricator instance
**defaultRequest**
Default option for _roficator_ to work. Available options:
- **configJson**
- **configQueryKey**
- **configJsonStdin**
- **configQueryKeyStdin**
**configJson** (With suitable defaultRequest option)
Path to `.json` file with request parameters.
**configQueryKey** (With suitable defaultRequest option)
Query key for proper request. [What is Query Key?](https://secure.phabricator.com/book/phabricator/article/conduit_search/)
## Request parameters
When using JSON file (from config path or stdin) you need to specify some parameters. You will find them [there](https://secure.phabricator.com/conduit/method/maniphest.search/) or in your Phabricator instance `your-instance.com/conduit/method/maniphest.search`
### Project is still work in progress, however it is functional at some point
## To-do
- [x] Reading Query Key from stdin
- [x] Read JSON from stdin
- [x] Read Query Key from config
- [x] Read JSON file from config path
- [] Fetch all tasks from Phabricator (Conduit allows to get max 100 tasks per request)
- [] Use cron to fetch tasks over a certain amount of time

File Metadata

Mime Type
text/plain
Expires
Tue, Feb 25, 08:16 (1 d, 15 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
610218
Default Alt Text
README.md (1 KB)

Event Timeline