https://github.com/partysun/focusapp-cli
Focus is the tiny cli pomodoro application
https://github.com/partysun/focusapp-cli
cli focus lifehacks pomodoro
Last synced: about 2 months ago
JSON representation
Focus is the tiny cli pomodoro application
- Host: GitHub
- URL: https://github.com/partysun/focusapp-cli
- Owner: Partysun
- License: mit
- Created: 2017-07-14T10:17:09.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-07-16T12:51:37.000Z (almost 8 years ago)
- Last Synced: 2025-02-16T11:16:03.579Z (4 months ago)
- Topics: cli, focus, lifehacks, pomodoro
- Language: JavaScript
- Homepage:
- Size: 205 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Focus
[](https://github.com/Partysun/focusapp-cli/blob/master/LICENSE)
[](https://travis-ci.org/Partysun/focusapp-cli)
Focus is the tiny cli pomodoro application. After pomodoro has eaten, your OS
fires the notification. (Mac OS tested).
Read more about tech [in wikipedia](https://en.wikipedia.org/wiki/Pomodoro_Technique#Underlying_principles)
## Installation
```bash
npm install -g focusapp-cli
```
## Usage
Run `focus` to start. You can change configuration in ~/.focus.json
Configuration file will create after first launch. Configuration path is `~/.focus.js`
Database saves in `~/.focus.db`.
Options:
- --help, -h
- report
- list
- --version, -v
### Example `shell`
```bash
# Report information about today, week and month
$ focus report
# It's time for work!
$ focus
# Get last 10 focuses
$ focus list
```
## Roadmap
- [x] Report show today tasks
- [ ] Report show heatmap of tasks of the month
- [ ] Set configaration through the args, not only config file
- [x] Autocomplete tasks title
## For Developers
Preparing...
1. fork this repo
2. yarn
3. node.js main.js
Run tests `npm test`
Run linting: `npm run lint` or `xo`
Thank you.
## Use inside tmux session
When using focus within a tmux session, Mac OS notifications doesn't work. This can be solved by following the steps described in this comment: https://github.com/julienXX/terminal-notifier/issues/115#issuecomment-104214742