Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qiz-li/feeling
😆 A script for your feelings!
https://github.com/qiz-li/feeling
feeling shell-script zsh
Last synced: about 1 month ago
JSON representation
😆 A script for your feelings!
- Host: GitHub
- URL: https://github.com/qiz-li/feeling
- Owner: qiz-li
- License: mit
- Created: 2022-02-22T05:00:04.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-08T23:58:59.000Z (about 2 years ago)
- Last Synced: 2024-11-10T07:04:15.469Z (3 months ago)
- Topics: feeling, shell-script, zsh
- Language: Shell
- Homepage:
- Size: 22.5 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
Feeling
A Zsh script for your feelings
Demo made with
svg-term-cli
using my
dotfiles
## Overview
The script is inspired by this Reddit [post](https://github.com/qiz-li/dotfiles).
The idea is to enter your feeling each day on a 1-10 scale.
This gives time to reflect upon your day to create more meaningful goals and improve wellness.
By displaying your feelings in a beautiful calendar,
you can also gain insight into trends in your feelings while prettifying your terminal.
## Installation
> Note for **macOS** users.
> As the script makes use of GNU versions of tools,
> please link [`gsed`](https://formulae.brew.sh/formula/gnu-sed) to `sed` and `gdate` to `date`.
### [Oh My Zsh](http://ohmyz.sh)
Clone this repository into the custom plugins folder:
```shell
git clone https://github.com/qiz-li/feeling.git ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/feeling
```
Update Oh My Zsh plugins list in `.zshrc`:
```shell
plugins=(
# Other plugins...
feeling
)
```
### [Antigen](https://github.com/zsh-users/antigen)
Add the following to your `.zshrc`:
```shell
antigen bundle qiz-li/feeling@main
```
## Configuration
#### `FEELING_DATA_PATH`
Path to file in which your feelings and corresponding dates will be stored.
Defaults to `~/.config/feeling/feelings.csv`.
#### `FEELING_FILLED_CHAR`
Character to represent days you have rated.
Defaults to `●`.
#### `FEELING_EMPTY_CHAR`
Character to represent days that are unrated.
Defaults to `◯`.
## Usage
Use the `-h` flag for help.
### Show Calendar
Run without any arguments:
```shell
feeling
```
### Add/Change Feeling
Add your feeling as an argument.
To add/change today's feeling:
```shell
feeling 8
```
Or specify a date using the `-d` flag:
```shell
feeling -d 2022-02-22 3
```
### Remove Feeling
Add the `-r` flag to remove a feeling.
To remove today's feeling:
```shell
feeling -r
```
Or a specific date:
```shell
feeling -d 2022-03-20 -r
```