@eaj/todo-cli

CLI for Todo

Introduction

Todo is a productivity (to-do list) system that draws its design loosely from the principles of Getting Things Done (GTD) by David Allen. It is built first and foremost to help you get things out of your head so that you can be relaxed and present. To help you to enjoy productivity, how about that?

There has been a missing piece in our culture of knowledge work: a system with a coherent set of behaviors and tools that functions effectively at the level at which work really happens. It must incorporate the results of big-picture thinking as well as the smallest of open details. It must manage multiple tiers of priorities. It must maintain control over hundreds of new inputs daily. It must save a lot more time and effort than are needed to maintain it. It must make it easier to get things done.

-- David Allen

Getting Started

Todo saves your data to a single JSON file.

Use the todo start command to set the path of the JSON file used to store your list. An .env file with a TODO_PATH variable is created in the working directory.

• @eaj/todo-cli
• Introduction
• Getting Started
• Usage
• Commands

Usage

$ npm install -g @eaj/todo-cli
$ todo COMMAND
running command...
$ todo (-v|--version|version)
@eaj/todo-cli/1.5.1 darwin-arm64 node-v18.16.0
$ todo --help [COMMAND]
USAGE
  $ todo COMMAND
...

Commands

• todo action SHORTCODE
• todo active
• todo add
• todo category SHORTCODE CATEGORY
• todo complete [SHORTCODE]
• todo due SHORTCODE
• todo empty
• todo help [COMMAND]
• todo intention SHORTCODE
• todo list [CATEGORY]
• todo note SHORTCODE
• todo start
• todo title SHORTCODE
• todo trash [CATEGORY]
• todo trash-archive
• todo url SHORTCODE URL
• todo view SHORTCODE

todo action SHORTCODE

adds action to given item

USAGE
  $ todo action SHORTCODE

ARGUMENTS
  SHORTCODE  shortcode of item to add action

See code: src/commands/action.ts

todo active

sets archived items to active

USAGE
  $ todo active

See code: src/commands/active.ts

todo add

add a new todo list item

USAGE
  $ todo add

OPTIONS
  -c, --category=category  [default: inbox] category where item will be added
  -u, --url=url            hyperlink relating to item (example: "https://google.com")

ALIASES
  $ todo new

See code: src/commands/add.ts

todo category SHORTCODE CATEGORY

updates the category of item

USAGE
  $ todo category SHORTCODE CATEGORY

ARGUMENTS
  SHORTCODE  shortcode of item to update category
  CATEGORY   category of item

See code: src/commands/category.ts

todo complete [SHORTCODE]

mark item or action as complete

USAGE
  $ todo complete [SHORTCODE]

ARGUMENTS
  SHORTCODE  shortcode of item or action to complete

ALIASES
  $ todo done

See code: src/commands/complete.ts

todo due SHORTCODE

set the due date of an item or action

USAGE
  $ todo due SHORTCODE

ARGUMENTS
  SHORTCODE  shortcode of item or action to complete

See code: src/commands/due.ts

todo empty

empties the trash bin

USAGE
  $ todo empty

See code: src/commands/empty.ts

todo help [COMMAND]

display help for todo

USAGE
  $ todo help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

todo intention SHORTCODE

update the intention of item or action

USAGE
  $ todo intention SHORTCODE

ARGUMENTS
  SHORTCODE  shortcode of item to add action

See code: src/commands/intention.ts

todo list [CATEGORY]

view list of todo items

USAGE
  $ todo list [CATEGORY]

ARGUMENTS
  CATEGORY  list by category of items

OPTIONS
  -l, --list=list  [default: list] list to be shown

See code: src/commands/list.ts

todo note SHORTCODE

add a note to the specified item or action

USAGE
  $ todo note SHORTCODE

ARGUMENTS
  SHORTCODE  shortcode of item to add action

See code: src/commands/note.ts

todo start

start a new todo list

USAGE
  $ todo start

See code: src/commands/start.ts

todo title SHORTCODE

update the title of item or action

USAGE
  $ todo title SHORTCODE

ARGUMENTS
  SHORTCODE  shortcode of item to add action

See code: src/commands/title.ts

todo trash [CATEGORY]

move selected items to trash

USAGE
  $ todo trash [CATEGORY]

ARGUMENTS
  CATEGORY  list by category of items

See code: src/commands/trash.ts

todo trash-archive

moved archived items into trash bin

USAGE
  $ todo trash-archive

See code: src/commands/trash-archive.ts

todo url SHORTCODE URL

add a url to item or action

USAGE
  $ todo url SHORTCODE URL

ARGUMENTS
  SHORTCODE  shortcode of item to add url
  URL        url to set as item url

See code: src/commands/url.ts

todo view SHORTCODE

view information for an item or action

USAGE
  $ todo view SHORTCODE

ARGUMENTS
  SHORTCODE  shortcode of item or action to view

See code: src/commands/view.ts