Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Introduction

wwid (what was I doing?) is a command-line tool for keeping portable, ad-hoc, project-relative notes. It maps text files to relative paths inside projects, makes no further assumptions, and does not attempt to manage your workflow for you.

  • Quick & simple CLI.
    • Wrap it in a fuzzy picker, call it from your scripts, etc.
  • Notes and metadata are stored separately from projects.
    • No source tree pollution, easy syncing thanks to plain-text format.
  • Notes can be in any plain-text format.
    • Markdown, AsciiDoc, text, Python, Shell, you name it.
  • Edit on your own terms.
    • Interactively with your $EDITOR, or pipe over standard IO — helpful for editor integration!

For examples of the kinds of workflows wwid enables, please see the workflows chapter.

Who is this for?

You may like wwid if you:

  • Frequently stop work mid-task and struggle with forgetting context.
  • Prefer plain-text, bring-your-own-editor note taking.
  • Work across many projects & files simultaneously.

This tool probably works best for people who think in terms of files & directories, and who want to leave short, contextual notes without committing to a larger system. It is less suitable if you want long-lived knowledge storage or rich metadata.

License & Contributing

wwid and this documentation book are open source under the OBSD license. If you are interested in contributing, please see the relevant chapter.