@shwilliam/todo
v0.1.2
Published
A todo CLI
Downloads
5
Readme
@shwilliam/todo
A todo CLI
Usage
$ npm install -g @shwilliam/todo
$ t COMMAND
running command...
$ t (-v|--version|version)
@shwilliam/todo/0.1.1 darwin-x64 node-v14.1.0
$ t --help [COMMAND]
USAGE
$ t COMMAND
...
Commands
t add TODO
t autocomplete [SHELL]
t done INDEX
t help [COMMAND]
t list [FILTER]
t remove TARGET
t todo [INDEX]
t add TODO
add todo
USAGE
$ t add TODO
ARGUMENTS
TODO todo text
See code: src/commands/add.ts
t autocomplete [SHELL]
display autocomplete installation instructions
USAGE
$ t autocomplete [SHELL]
ARGUMENTS
SHELL shell type
OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
EXAMPLES
$ t autocomplete
$ t autocomplete bash
$ t autocomplete zsh
$ t autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
t done INDEX
mark as done
USAGE
$ t done INDEX
ARGUMENTS
INDEX index of target todo
See code: src/commands/done.ts
t help [COMMAND]
display help for t
USAGE
$ t help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
t list [FILTER]
list todos
USAGE
$ t list [FILTER]
ARGUMENTS
FILTER (todo|done|important) filter output by status
See code: src/commands/list.ts
t remove TARGET
remove todo
USAGE
$ t remove TARGET
ARGUMENTS
TARGET index of target todo or 'all'
See code: src/commands/remove.ts
t todo [INDEX]
mark as incomplete
USAGE
$ t todo [INDEX]
ARGUMENTS
INDEX index of target todo
See code: src/commands/todo.ts