https://github.com/bernardini687/pals

keep in touch with friends
https://github.com/bernardini687/pals

cli fun minimal node tool

Last synced: 3 months ago
JSON representation

keep in touch with friends

• Host: GitHub
• URL: https://github.com/bernardini687/pals
• Owner: bernardini687
• License: mit
• Created: 2020-03-24T19:39:46.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-18T21:24:40.000Z (almost 2 years ago)
• Last Synced: 2025-02-10T21:29:38.740Z (3 months ago)
• Topics: cli, fun, minimal, node, tool
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/@bernardini687/pals
• Size: 562 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![GitHub repo size](https://img.shields.io/github/repo-size/bernardini687/pals)

![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/bernardini687/pals)

![GitHub](https://img.shields.io/github/license/bernardini687/pals)

![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/@bernardini687/pals)

![npm](https://img.shields.io/npm/dt/@bernardini687/pals)

# pals

_keep in touch with friends_

this simple tool is designed to tell you about friends you don't hear from for a while.

![](preview.gif)

# install

install globally via:

```

$ npm i -g @bernardini687/pals

```

if you wish to be reminded of your pals every time you open up your terminal, just add `pals` to your `rc` shell script:

```

$ echo pals >> ~/.zshrc

```

# example

say you just contacted your dear friend Jake, while the last time you've heard from Finn was on Xmas.

you could enter:

```

$ pals jake            # defaults to current date.

$ pals finn 25-12-2019

$ pals

  => Finn would love a message from you.

$ pals reset!          # wipes data.

```

# configuration

it's possible to set two environment variables to configure the behaviour:

```

export PALS_FILE=foo # sets the name of the file where the data is stored, defaults to "pals".

export PALS_DAYS=365 # sets the time you consider to be "a while", defaults to 14.

```

# details

the first time the program runs, it generates a `.pals.json` in your home folder.

that file gets written with your pals' names for keys and dates for their values.

when you run the program without arguments, it will check for any friend you haven't contacted in the last 14 days.

the program depends on [`shape-date`](https://www.npmjs.com/package/shape-date) for its amazing date-shaping possibilities. ;)