/tiny-care-terminal

💖💻 A little dashboard that tries to take care of you when you're using your terminal.

Primary LanguageJavaScriptMIT LicenseMIT

tiny-care-terminal

This is a little dashboard that tries to take care of you when you're using your terminal. It tells you cute, self care things, and tries not to stress you out. It shows:

  • the last tweets from @tinycarebot, @selfcare_bot and @magicrealismbot. The first two tend to tweet reminders about taking breaks, drinking water and looking outside, and the latter tells you strange, whimsical stories. If you don't like these bots, they're configurable!
  • your git commits from today and the last 7 days. When I get stressed out because I think I haven't done anything, it turns out that I only think about big and serious commits, and forget about all the tiny amounts of work I've actually done throughout. Hopefully this will help you too <3
  • the weather, because you might get rained on.

It looks like this, and updates every 20 minutes.

tiny terminal care screenshot

Make it go

The dashboard has two alternatives for reading tweets: using your API keys or scraping. API keys is preferred (because lol scraping), but if you're really not into that, then skip the next section and read the bit about setting TTC_APIKEYS

Set up API keys

You need Twitter API keys for the tweets to work. It should be pretty easy to create a new app, and get these 4 values. After you've set them up, set these env variables (see the sample.env for an example):

CONSUMER_KEY='...'
CONSUMER_SECRET='...'
ACCESS_TOKEN='...'
ACCESS_TOKEN_SECRET='...'

Configure the dashboard

All the settings the dashboard looks at are in sample.env:

  • TTC_BOTS are the 3 twitter bots to check, comma separated. The first entry in this list will be displayed in the party parrot.
  • TTC_REPOS, a comma separated list of repos to look at for git commits. This is using git-standup under the hood, and looks one subdirectory deep (so if you have all your code directories in a ~/Code, you only need to list that one)
  • TTC_WEATHER, the location or zip code to check the weather for (so both 90210 and Paris should work)
  • TTC_CELSIUS (by default true)
  • TTC_APIKEYS -- set this to false if you don't want to use Twitter API keys and want to scrape the tweets instead.

Set them through your favourite way of setting env variables.

Do the npm dance

(Note: this currently doesn't work with yarn because of path shenanigans I wrote, so while I'm fixing that, pls use npm 🙏)

npm install -g tiny-care-terminal
tiny-care-terminal

You can exit the dashboard by pressing esc or q.

Take care of yourself, ok? 💖