Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shalldie/todo-cli-js

A todo manager on the command-line interface.
https://github.com/shalldie/todo-cli-js

cli todo

Last synced: 21 days ago
JSON representation

A todo manager on the command-line interface.

Host: GitHub
URL: https://github.com/shalldie/todo-cli-js
Owner: shalldie
License: mit
Created: 2018-07-11T05:37:35.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2022-04-02T06:58:01.000Z (almost 3 years ago)
Last Synced: 2024-10-17T05:49:59.032Z (4 months ago)
Topics: cli, todo
Language: TypeScript
Homepage:
Size: 568 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # todo-cli-js

A todo manager on the command-line interface.

[![Npm Version](https://img.shields.io/npm/v/todo-cli-js.svg?logo=npm&style=flat-square)](https://www.npmjs.com/package/todo-cli-js)

[![Build Status](https://img.shields.io/github/workflow/status/shalldie/todo-cli-js/ci?label=build&logo=github&style=flat-square)](https://github.com/shalldie/todo-cli-js/actions)

[![License](https://img.shields.io/github/license/shalldie/todo-cli-js?logo=github&style=flat-square)](https://github.com/shalldie/todo-cli-js)

* [todo-cli-js](#todo-cli-js)

* [Usage](#usage)

* [Commands](#commands)

# Usage

```sh-session

$ npm install -g todo-cli-js

$ todo COMMAND

running command...

$ todo (--version)

todo-cli-js/0.0.7 linux-x64 node-v16.14.2

$ todo --help [COMMAND]

USAGE

  $ todo COMMAND

...

```

# Commands

* [`todo add`](#todo-add)

* [`todo edit`](#todo-edit)

* [`todo help [COMMAND]`](#todo-help-command)

* [`todo ls`](#todo-ls)

* [`todo rm`](#todo-rm)

## `todo add`

Add a todo item.

```

USAGE

  $ todo add -d  [-s done|undone] [-t ]

FLAGS

  -d, --description=   (required) Description of todo.

  -s, --status=(done|undone)  [default: undone] Status of todo's.

  -t, --tags=          Tags of todo.

DESCRIPTION

  Add a todo item.

EXAMPLES

  $ todo add -d 'A new todo.'

```

_See code: [dist/commands/add/index.ts](https://github.com/shalldie/todo-cli-js/blob/v0.0.7/dist/commands/add/index.ts)_

## `todo edit`

List todo items.

```

USAGE

  $ todo edit -i  [-s all|done|undone] [-t ] [-d ]

FLAGS

  -d, --description=       Description of todo.

  -i, --id=                (required) Id of todo.

  -s, --status=(all|done|undone)  Status of todos'.

  -t, --tags=              Tags of todo.

DESCRIPTION

  List todo items.

EXAMPLES

  $ todo edit -i 233 -s done -d "A new description"

```

_See code: [dist/commands/edit/index.ts](https://github.com/shalldie/todo-cli-js/blob/v0.0.7/dist/commands/edit/index.ts)_

## `todo help [COMMAND]`

Display help for todo.

```

USAGE

  $ todo help [COMMAND] [-n]

ARGUMENTS

  COMMAND  Command to show help for.

FLAGS

  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION

  Display help for todo.

```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.12/src/commands/help.ts)_

## `todo ls`

List todo items.

```

USAGE

  $ todo ls [-i ] [-s all|done|undone] [-t ] [-d ]

FLAGS

  -d, --description=       Description of todo.

  -i, --id=                Id of todo.

  -s, --status=(all|done|undone)  [default: undone] Status of todos'.

  -t, --tags=              Tags of todo.

DESCRIPTION

  List todo items.

EXAMPLES

  $ todo ls -s all

```

_See code: [dist/commands/ls/index.ts](https://github.com/shalldie/todo-cli-js/blob/v0.0.7/dist/commands/ls/index.ts)_

## `todo rm`

Remove a todo item.

```

USAGE

  $ todo rm [-i ]

FLAGS

  -i, --id=  Id of todo.

DESCRIPTION

  Remove a todo item.

EXAMPLES

  $ todo rm -i 233

```

_See code: [dist/commands/rm/index.ts](https://github.com/shalldie/todo-cli-js/blob/v0.0.7/dist/commands/rm/index.ts)_

## License

MIT