dispositio

README

Dispositio

For more free software, or to check out my newsletter about useful tools and systems, head over to The Systemist.

Dispositio is a terminal tool for planning large projects in simple markdown.

Installation

Homebrew (macOS)

brew install tsraveling/tap/dispositio

Scoop (Windows)

scoop bucket add tsraveling https://github.com/tsraveling/scoop-bucket
scoop install dispositio

Debian / Ubuntu / Fedora / Alpine

Download the .deb, .rpm, or .apk from the latest release and install with your package manager, e.g.:

sudo dpkg -i dispositio_*.deb

Go

go install github.com/tsraveling/dispositio@latest

Manual

Download the archive for your platform from the latest release, extract, and place dispositio on your PATH.

Detailed documentation

A full walkthrough with GIF examples can be found over at The Systemist!

Quickstart

Simply run dispositio in any folder. It will prompt to create ROADMAP.md (if it doesn't already exist); your project will be stored in this file in simple Markdown.

Alternatively, you can do e.g. dispositio OTHER_FILENAME.md if you would like to use a different filename.

Once in dispositio, you can hit ? to see a keymap guide wherever you are in the app.

You will see your empty project. From here:

• Hit e to set a project name -- this shows up at the top, and can be whatever you want.
• Hit a to add your first milestone.
• With that milestone selected, use shift+h/l or shift+right/left to change the duration of the milestone
• Hit enter/right/l to enter milestone details
• From there you can add tasks, subtasks, etc (see ? popup for details).

Dispositio automatically creates a timeline. You can change the start date by selecting the first (project) row, and using h/l/right/left to change start date (hold shift to change by a week at a time).

This allows you to quickly map out a project timeline in milestones, with duration measured in weeks per milestone. Your current milestone is the topmost non-completed one, marked with a solid circle. The current milesone will "stretch" into overtime if you do not complete it on time, and your project timeline will update to match.

Documentation

Overview

Dispositio is a terminal tool for planning large projects in simple markdown.

A project lives in an ordinary Markdown file, ROADMAP.md by default. Each milestone is an H1, its tasks are checkboxes, and indented checkboxes are subtasks. The file stays readable and editable outside the app, so it can sit in a repository alongside the work it describes.

Milestones carry a duration in weeks, written as a parenthesised suffix on the header, and dispositio lays them out on a timeline from the project start date. Finishing a milestone early pulls the rest forward; overrunning pushes them back.

Usage:

dispositio             open ./ROADMAP.md, offering to create it
dispositio DIR         open DIR/ROADMAP.md
dispositio FILE.md     open a specific file
dispositio -h          show help
dispositio -v          print version

Press ? inside the app for the full keymap.