makerflow-cli

Makerflow 💻 🌊

Makerflow is a deep work and collaboration assistant for developers. Get in the zone without hiding away from your product manager, designer or other developers on the team!

Table of contents

1. Features
2. Installation
3. Usage
   1. Flow Mode
   2. Tasks
   3. Breaks
   4. Events (from Google Calendar)

Features

With a single command (makerflow toggle):

1. 🔕 Toggle "Do Not Disturb" mode on macOS.
2. 🙅 Close/open distracting chat apps like Slack, Discord, MS Teams, Telegram, WhatsApp, and Messages.
3. 🛑 Block/unblock distracting websites with the help of Makerflow Chrome or Firefox extensions
4. 💬 Update/clear your Slack status automatically to let your co-workers know when
   1. you are trying to do deep work and will be slow to respond. Status is set to 💻
   2. or, when you are on a break. Status is set to one of these emojis ☕️ 🍵 🥪 🥤 🚶 🏃 💪 🏥 👶 ⏸ (more info)

Plus, other commands to

1. 📋 Get a list of your tasks (makerflow tasks todo) like pull requests from GitHub or Bitbucket
2. ✅ and mark them as done (makerflow tasks done)
3. 📅 Interact with events from Google Calendar by
   1. listing them (makerflow events list)
   2. or, joining them (makerflow events join)

Installation

Install with npm install -g makerflow-cli

Once installed, run

1. makerflow config token to set your API token.
2. makerflow config kill to set which apps are automatically closed when Flow Mode is started and reopened when it is ended

Pre-requisites

1. MacOS.
2. A free Makerflow account. Sign up at https://makerflow.co
3. API token from https://app.makerflow.co/settings#api

Usage

Get a list of available commands with makerflow --help

Run any available command with the --help flag to get more usage details about it. For example, run makerflow toggle --help to get usage information about the toggle command

Flow Mode

Starting Flow Mode will:

1. 🔕 Turn on "do-not-disturb" mode on macOS to block your notifications and prevent distractions.
2. 💬 If you have your Slack workspace connected to Makerflow, it will automatically set your Slack status to let your teammates know you might be slow to respond.
3. 🙅 Close distracting chat apps like Slack, Discord, MS Teams, Telegram, WhatsApp, and Messages
   1. Once, if you ran makerflow toggle --kill
   2. Everytime, if you configured it to do so with makerflow config kill
4. 🛑 Block distracting websites if you have Makerflow Chrome or Firefox extensions installed.

Stopping Flow Mode will reverse all the above actions.

Commands

makerflow toggle - Start/stop Flow Mode

makerflow toggle --kill - Start/stop Flow Mode and close/open chat apps. Only apps that were closed at the time of starting Flow Mode are reopened.

Demo

Tasks

Tasks show up in Makerflow by connecting with your other collaboration tools like Slack, GitHub or Bitbucket.

You can connect these tools with Makerflow from the "Setup Integrations" page on the website.

Commands

makerflow tasks todo - See a list of pending tasks like pull requests from GitHub/Bitbucket.

makerflow tasks done - list notifications/pull requests and mark one or more tasks as done

Demo

Breaks

Breaks are a quick way to set your Slack status and let your coworkers know when you are away on a break.

Providing type of break

If you pass a --reason argument, Makerflow will automatically set an appropriate status and emoji for you on Slack. For instance, if you run makerflow break start --reason=lunch, it will set 🥪 emoji as your status icon. If you don't supply a reason, your status will be set to ⏸.

Reasons currently supported are lunch (🥪), coffee (☕️), tea (🍵), beverage (🥤), walk (👟), run (🏃), workout (💪), child (👶), and doctor (🏥).

Commands

makerflow break start - Start a beak. Sets your Slack status emoji to ⏸

makerflow break start --reason=<type> - Start a break with a specific reason. Supported values for reason are one of lunch, coffee, tea, beverage, walk, run, workout, child, doctor

makerflow break stop - Finish your break. Slack status is cleared.

Demo

Events (from Google Calendar)

Interact with events from connected Google Calendars. You can your calendars with Makerflow from the "Setup Integrations" page on the website.

Commands

makerflow events list - will list recently ended, ongoing and upcoming events from Google Calendar. makerflow events join - will open a currently ongoing event's, or, the next upcoming event's Google Meet makerflow events join --next --wait - Open next event's Google Meet when the event starts

Demo

Upcoming

Makerflow VS Code plugin is coming soon to trigger "Flow Mode" automatically or from the command palette.