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).

Versioning

We strictly use semantic versioning. Don't be fooled by the 1.x major version. THis isn't necessarily super stable software. However, we strictly increase version numbers on every breaking change.

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.1.0.tar.gz (45.0 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.1.0-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mdtasks-1.1.0.tar.gz
Algorithm Hash digest
SHA256 c02f8b941ca78f6b4dfa1160d8f9ef7816079ef27707f9db20a86228e5b1f68a
MD5 0885636dc34c3428405ee8f229bf87d6
BLAKE2b-256 057eae5d4dbd18716eed24ca9c2147ae503916e34204c3aa046a55698210d0c9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mdtasks-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 18.7 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ea80449452e516302054d494afa30ff8bca0568c7c0f4df45fd8a7d1cd3e06ec
MD5 0a518a00fa4b7fa1f648c4c01951fb03
BLAKE2b-256 3035349fe60db358e33d8de954364827ffb31e75c52f0acf6be5b5d2cedf2a72

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