Skip to content
This repository has been archived by the owner on May 22, 2021. It is now read-only.
/ ppp-cli Public archive

A cli tool to help generating PPP files (Progress, Plans & Problems) and sending them to Slack

Notifications You must be signed in to change notification settings

alexishevia/ppp-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PPP CLI

A cli tool to help generate PPP files (Progress, Plans & Problems) and send them to Slack

This cli tool can help you:

  • Create daily PPPs
    • Each PPP is saved as: YYYY-MM-DD
    • When generating a new PPP, the previous PPP is used as a template
  • Create weekly PPPs
    • Each weekly PPP is saved as: weekly_YYYY-MM-DD_YYYY-MM-DD
    • When generating a new weekly PPP, all PPPs for the last week are merged into a template
  • Automatically post your PPP to a slack channel

Why

PPP is a great tool for boosting your productivity AND is a perfect fit for Slack daily updates.

Installation

npm install ppp-cli --global

You'll need Node 8+.

Configuration

Create a config file in ~/.ppprc.json with the following values:

Example:

{
  "dirpath": "/path/to/PPP/directory",
  "token": "xoxp-12345",
  "channel": "C3N9KTFU5",
  "user": "alexishevia"
}

Usage

npx ppp-cli [options]

Your default editor ($EDITOR) will open for you to edit your PPP.

After saving & closing the editor, the PPP will be posted to the Slack channel you configured.

Options:

  • -w, --weekly Generate a weekly PPP (by default a daily PPP is generated).
  • -F <filename> Specifies an alternative configuration file. Default is ~/.pprc.json

About

A cli tool to help generating PPP files (Progress, Plans & Problems) and sending them to Slack

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published