npm package: @gabriele-rizzo/todo-cli
Description: A typescript based command-line interface to create and manage todo tasks.
Author: Gabriele Rizzo @RizzoGR
Latest version: 0.0.1

oclif-hello-world
=================

oclif example Hello World CLI

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world)
[![CircleCI](https://circleci.com/gh/oclif/hello-world/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/hello-world/tree/main)
[![Downloads/week](https://img.shields.io/npm/dw/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world)
[![License](https://img.shields.io/npm/l/oclif-hello-world.svg)](https://github.com/oclif/hello-world/blob/main/package.json)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g @gabriele-rizzo/todo-cli
$ todo COMMAND
running command...
$ todo (--version)
@gabriele-rizzo/todo-cli/0.0.1 darwin-arm64 node-v16.17.0
$ todo --help [COMMAND]
USAGE
  $ todo COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`todo add [TASKS]`](#todo-add-tasks)
* [`todo help [COMMAND]`](#todo-help-command)
* [`todo init`](#todo-init)
* [`todo list`](#todo-list)
* [`todo mark`](#todo-mark)
* [`todo plugins`](#todo-plugins)
* [`todo plugins:install PLUGIN...`](#todo-pluginsinstall-plugin)
* [`todo plugins:inspect PLUGIN...`](#todo-pluginsinspect-plugin)
* [`todo plugins:install PLUGIN...`](#todo-pluginsinstall-plugin-1)
* [`todo plugins:link PLUGIN`](#todo-pluginslink-plugin)
* [`todo plugins:uninstall PLUGIN...`](#todo-pluginsuninstall-plugin)
* [`todo plugins:uninstall PLUGIN...`](#todo-pluginsuninstall-plugin-1)
* [`todo plugins:uninstall PLUGIN...`](#todo-pluginsuninstall-plugin-2)
* [`todo plugins update`](#todo-plugins-update)
* [`todo remove [TASKS]`](#todo-remove-tasks)

## `todo add [TASKS]`

Add one or multiple task to the list. The added tasks will be marked uncompleted by default

```
USAGE
  $ todo add [TASKS]

DESCRIPTION
  Add one or multiple task to the list. The added tasks will be marked uncompleted by default

EXAMPLES
  $ todo add first_task "second task"
```

_See code: [dist/commands/add.ts](https://github.com/RizzoGR/todo-cli/blob/v0.0.1/dist/commands/add.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.14/src/commands/help.ts)_

## `todo init`

Initialize the environment for the todo list

```
USAGE
  $ todo init [-f]

FLAGS
  -f, --force  Overwrite the created list

DESCRIPTION
  Initialize the environment for the todo list

EXAMPLES
  $ todo init

  $ todo init --force
```

_See code: [dist/commands/init.ts](https://github.com/RizzoGR/todo-cli/blob/v0.0.1/dist/commands/init.ts)_

## `todo list`

List all the registered tasks

```
USAGE
  $ todo list [-c] [-u]

FLAGS
  -c, --completed    List all the completed tasks
  -u, --uncompleted  List all the uncompleted tasks

DESCRIPTION
  List all the registered tasks

EXAMPLES
  $ todo list

  $ todo list --completed

  $ todo list --uncompleted
```

_See code: [dist/commands/list.ts](https://github.com/RizzoGR/todo-cli/blob/v0.0.1/dist/commands/list.ts)_

## `todo mark`

Change the state of a task. Specify the state with the flag before the name of the task

```
USAGE
  $ todo mark [-c <value>] [-u <value>]

FLAGS
  -c, --completed=<value>...    Mark the task as completed
  -u, --uncompleted=<value>...  Mark the task as uncompleted

DESCRIPTION
  Change the state of a task. Specify the state with the flag before the name of the task

EXAMPLES
  $ todo mark -c "task_will_get_marked_completed"

  $ todo mark -u "task_will_get_marked_uncompleted"

  $ todo mark -u task1 -c task2
```

_See code: [dist/commands/mark.ts](https://github.com/RizzoGR/todo-cli/blob/v0.0.1/dist/commands/mark.ts)_

## `todo plugins`

List installed plugins.

```
USAGE
  $ todo plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ todo plugins
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.1/src/commands/plugins/index.ts)_

## `todo plugins:install PLUGIN...`

Installs a plugin into the CLI.

```
USAGE
  $ todo plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ todo plugins add

EXAMPLES
  $ todo plugins:install myplugin 

  $ todo plugins:install https://github.com/someuser/someplugin

  $ todo plugins:install someuser/someplugin
```

## `todo plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

```
USAGE
  $ todo plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ todo plugins:inspect myplugin
```

## `todo plugins:install PLUGIN...`

Installs a plugin into the CLI.

```
USAGE
  $ todo plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ todo plugins add

EXAMPLES
  $ todo plugins:install myplugin 

  $ todo plugins:install https://github.com/someuser/someplugin

  $ todo plugins:install someuser/someplugin
```

## `todo plugins:link PLUGIN`

Links a plugin into the CLI for development.

```
USAGE
  $ todo plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.

  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLES
  $ todo plugins:link myplugin
```

## `todo plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
  $ todo plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ todo plugins unlink
  $ todo plugins remove
```

## `todo plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
  $ todo plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ todo plugins unlink
  $ todo plugins remove
```

## `todo plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

```
USAGE
  $ todo plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ todo plugins unlink
  $ todo plugins remove
```

## `todo plugins update`

Update installed plugins.

```
USAGE
  $ todo plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.
```

## `todo remove [TASKS]`

Remove one or multiple task from the list

```
USAGE
  $ todo remove [TASKS]

DESCRIPTION
  Remove one or multiple task from the list

EXAMPLES
  $ todo remove first_task "second task"
```

_See code: [dist/commands/remove.ts](https://github.com/RizzoGR/todo-cli/blob/v0.0.1/dist/commands/remove.ts)_
<!-- commandsstop -->

## `todo mark [FLAG] [TASK]`

Add one or multiple task to the list. The added tasks will be marked uncompleted by default

```
USAGE
  $ todo mark [FLAG] [TASK]

DESCRIPTION
  Change the state of a task. Specify the state with the flag before the name of the task

EXAMPLES
  $ todo marl -c first_task -u second_task
```

_See code: [dist/commands/mark.ts](https://github.com/RizzoGR/todo-cli/blob/v0.0.1/dist/commands/mark.ts)_

## `todo list`

List the task

```
USAGE
  $ todo list [-c] [-u]

FLAGS
  -c, --completed    List all the completed tasks
  -u, --uncompleted  List all the uncompleted tasks

DESCRIPTION
  List the task

EXAMPLES
  $ todo list

  $ todo list --completed

  $ todo list --uncompleted
```

_See code: [dist/commands/list.ts](https://github.com/RizzoGR/todo-cli/blob/v0.0.1/dist/commands/list.ts)_