{"id":15608429,"url":"https://github.com/hypercubed/todo-md","last_synced_at":"2025-04-15T05:58:12.654Z","repository":{"id":9459935,"uuid":"11341606","full_name":"Hypercubed/todo-md","owner":"Hypercubed","description":"Manage your GitHub Flavored Markdown todo list from the command line","archived":false,"fork":false,"pushed_at":"2020-04-17T11:54:27.000Z","size":93,"stargazers_count":89,"open_issues_count":5,"forks_count":22,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-15T05:58:06.985Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://hypercubed.github.io/todo-md/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Hypercubed.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-07-11T12:39:23.000Z","updated_at":"2023-12-14T16:08:34.000Z","dependencies_parsed_at":"2022-09-02T12:44:22.212Z","dependency_job_id":null,"html_url":"https://github.com/Hypercubed/todo-md","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hypercubed%2Ftodo-md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hypercubed%2Ftodo-md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hypercubed%2Ftodo-md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Hypercubed%2Ftodo-md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Hypercubed","download_url":"https://codeload.github.com/Hypercubed/todo-md/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249016325,"owners_count":21198832,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-03T05:20:48.623Z","updated_at":"2025-04-15T05:58:12.637Z","avatar_url":"https://github.com/Hypercubed.png","language":"JavaScript","funding_links":["https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=X7KYR6T9U2NHC"],"categories":[],"sub_categories":[],"readme":"todo-md [![Build Status](https://secure.travis-ci.org/Hypercubed/todo-md.png?branch=master)](https://travis-ci.org/Hypercubed/todo-md) [![NPM version](https://badge.fury.io/js/todo-md.png)](http://badge.fury.io/js/todo-md) [![Code Climate](https://codeclimate.com/github/Hypercubed/todo-md.png)](https://codeclimate.com/github/Hypercubed/todo-md)\n======\n[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/Hypercubed/todo-md?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\n[![NPM](https://nodei.co/npm/todo-md.png?downloads=true)](https://nodei.co/npm/todo-md/)\n\n# Description\n\nManage your [GitHub Flavored Markdown Task List](https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments) from the command line.  A simple (but useful) example built using [autocmdr](https://github.com/Hypercubed/autocmdr).\n\n# Introduction\n\nTodo-md is meant to be a dead simple text based task manager.  There are many task managers out there.  What makes todo-md different?  todo-md is, first of all, markdown based.  todo-md runs off the command line and the task list is stored in a simple markdown file.  Text based tasks list are easy to manage as part of a git repository.  Furthermore, the todo list is [gfm](https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments) compatible for easy viewing in github and gist.  Simply check-in your todo.md file along with your source code and readme file.  Also, like git and npm, todo-md by default works in the current working directory so each project can have it's own todo list.\n\nI use todo-md all the time.  I hope you find it useful as well.  Feedback is welcome.\n\n# Installation\n\nInstall todo-md globally\n\n    $ npm install -g Hypercubed/todo-md\n\n## Autocomplete (optional)\n\nDo one of the following to enable auto-completion in your shell.\n\n* Add completion helper to ~/.bashrc (or ~/.zshrc) `todo completion \u003e\u003e ~/.bashrc`\n* Add completion to current shell `. \u003c(todo completion)`\n\n# Quick start\n\nCreating a todo list is done simply by adding your first task.  For example\n\n    $ todo \"Learn to use task-md\"\n\nwill create a `todo.md` file in the current directory containing a single line:\n\n```\n   - [ ] Learn to use task-md\n```\n\nNote that when adding tasks the `add` command is optional.  You can also type `todo add \"Learn to use task-md\"`.\n\nTo mark a task as done type\n\n    $ todo do 1\n\nor undo\n\n    $ todo undo 1\n\nTo remove a task\n\n    $ todo rm 1\n\nAfter each command you will see a list of your tasks along with line numbers.  You can also get the list at anytime by typing\n\n    $ todo\n\nNote that the command `list` is optional you may also type `todo list`.\n\nNote that `do`, `undo`, and `rm` require an index while `list` and `add` the index is optional.  With the exception of the `add` command this index can be a single line number (as displayed when running `todo list`) or a list of line numbers.  Ranges may also be used.  For example the following command will mark line 15,20, and 25-30 as done.\n\n    $ todo do 15,20,25-30\n\nAdding the -g option flag to any command will set the working file to `~/todo/todo.md`.  Great for keeping a master todo list.  Try using [gistup](https://github.com/mbostock/gistup) to push to github gist for online task management:\n\n    cd ~/todo/todo.md\n    gistup --private -- todo.md\n\n## Usage\n\n  Usage: todo [options] [command]\n\n  Commands:\n\n    list [index]               Displays all (or specified) lines in todo list with line numbers\n    print [index]              Displays all (or specified) lines in todo list without line numbers (same as list --no-color --no-stats --no-line-numbers)\n    add \u003ctext_to_add\u003e [index]  Adds text_to_add to your todo file on its own line at [index] or EOF if no index provided\n    do \u003cindex\u003e                 Marks task as done\n    undo \u003cindex\u003e               Marks task as not done\n    rm \u003cindex\u003e                 Removes tasks\n    mv \u003cfrom\u003e \u003cto\u003e             Moves task \u003cfrom\u003e to \u003cto\u003e\n    status                     Shows the tasks status (total, done, pending)\n\n  Options:\n\n    -h, --help             Output usage information\n    -d, --debug            Enable debugger\n    -g, --global           Use global todo list (usually ~/todo/todo.md)\n    -N, --no-line-numbers  Disable line numbers\n    -C, --no-color         Disable line numbers\n    -S, --no-stats         Disable stats\n    -q, --quiet            Quiet mode\n    -V, --version          output the version number\n\n# Todo\n\nSee todo.md (managed using [todo-md](https://github.com/Hypercubed/todo-md))\n\n# License\n\nCopyright (c) 2013 Jayson Harshbarger [![Gittip donate button](http://img.shields.io/gratipay/Hypercubed.svg)](https://www.gittip.com/hypercubed/ \"Donate weekly to this project using Gittip\")\n[![Paypal donate button](http://img.shields.io/badge/paypal-donate-brightgreen.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=X7KYR6T9U2NHC \"One time donation to this project using Paypal\")\n\n[MIT License](http://en.wikipedia.org/wiki/MIT_License)\n\n# Acknowledgments\n\nBuilt using [generator-commader](https://github.com/Hypercubed/generator-commander) and [autocmdr](https://github.com/Hypercubed/autocmdr).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhypercubed%2Ftodo-md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhypercubed%2Ftodo-md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhypercubed%2Ftodo-md/lists"}