Skip to main content

Super simple CLI for markdown based ticket management

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.1.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.1-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mdtasks-1.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 1096b54874bd538e44a570f9c8411a0e394b14b75629ff3aa7828e8295658928
MD5 8dc52e1c1e45b6a1237b25a8ad5b153b
BLAKE2b-256 35ef69de258d0c25f96853a58f92bf160a4d5f18966ccd2b098257ec43e821fa

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mdtasks-1.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d8fbe671d0b677fd9ad2152ce0615d2f508a616b93cca81aa189eb896154fb76
MD5 00ea2c1486ff8e4546da7712c3cb1344
BLAKE2b-256 5d271f116723f5c2020600679aa11bb3efcacaa48350af0b0ab6e902e1c436dd

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