Skip to main content

Add your description here

Project description

mdtasks

Simple commandline tasks and tickets via markdown files

Installation

uv tool install mdtasks

The tool installs an executable mdtasks and an alias t that refers to the same executable.

Usage

Use t --help for detailed up to date help.

Tasks are stored in a central folder by can be grouped by project and context. Typically, you will have one or two projects but separate contexts (e.g. "messaging", "backend", "ux", "website", ...). You can set both via environment variables. Use direnv to automatically switch based on the current directory. The following env vars are read:

Env Var description default
MDTASKS_ROOT root directory for task files ~/.mdtasks
MDTASKS_PROJECT project specifier "any"
MDTASKS_DEFAULT_CONTEXT default context specifier "any"

To create your first task, run

t new my-first-task --use-full-spec

This will scaffold a task, open your preferred editor ($EDITOR) to let you edit the task and will then move the tasks to $MDTASKS_ROOT/open/ directory. The flag --use-full-spec is useful while you're not yet really familiar with mdtasks metadata schema: when called with --use-full-spec, mdtasks will add the full metadata schema to the task file, including optional arguments.

To see an overview of existing tasks, run

t ls

For other kinds of usage, use t --help.

Projects vs Contexts

Projects and contexts may appear quite similar, but they aren't really: Typically, projects refer to an overarching concept. You work on that project for a longer time. That's why mdtasks isn't really able to filter by project from the command line. The idea is that you might have projects "private" and "work". You can filter by project only via environment variables (e.g. by setting MDTASKS_PROJECT for a particular directory via direnv). On the other hand, contexts are less tightly coupled to a particular directory and the cli typically allows for ad-hoc switches between different contexts (although you can also set the default context via environment variable).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mdtasks-1.0.0.tar.gz (44.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mdtasks-1.0.0-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

File details

Details for the file mdtasks-1.0.0.tar.gz.

File metadata

  • Download URL: mdtasks-1.0.0.tar.gz
  • Upload date:
  • Size: 44.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for mdtasks-1.0.0.tar.gz
Algorithm Hash digest
SHA256 03148459e061d8e899f3e5a81e0c6a6ddd580694406481b7db73378e055b3b20
MD5 ce1f22a0ef14b9146c1271bc838d96b2
BLAKE2b-256 f70e3b85ad79ad395ecb2b607ec81fa36fd01f1017770236b8df73f7d01eb3a6

See more details on using hashes here.

File details

Details for the file mdtasks-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: mdtasks-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 18.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for mdtasks-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 44fdc98c37b27c4716466e862e129e31994cec1fbc982abb84f56386bafce2d9
MD5 d239b6045c3b43ad7d7cc5cab52b439d
BLAKE2b-256 b1b1e8f7d8438cd548f960f72194e52a5d3b375e2ee8294ce2a5ae864dfb232a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page