diff --git a/README.md b/README.md index e23fee6..dece861 100644 --- a/README.md +++ b/README.md @@ -1,615 +1,14 @@ -oclif-hello-world -================= - -oclif example Hello World CLI - -[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) -[![CircleCI](https://circleci.com/gh/oclif/hello-world/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/hello-world/tree/main) -[![GitHub license](https://img.shields.io/github/license/oclif/hello-world)](https://github.com/oclif/hello-world/blob/main/LICENSE) - - -* [Usage](#usage) -* [Commands](#commands) - -* [Usage](#usage) -* [Commands](#commands) - -# Usage - -```sh-session -$ npm install -g plannerCLI -$ plannerCLI COMMAND -running command... -$ plannerCLI (--version) -plannerCLI/0.0.0 win32-x64 node-v20.10.0 -$ plannerCLI --help [COMMAND] -USAGE - $ plannerCLI COMMAND -... -``` - -```sh-session -$ npm install -g oclif-hello-world -$ oex COMMAND -running command... -$ oex (--version) -oclif-hello-world/0.0.0 darwin-x64 node-v16.13.1 -$ oex --help [COMMAND] -USAGE - $ oex COMMAND -... -``` - -# Commands - -* [`plannerCLI hello PERSON`](#plannercli-hello-person) -* [`plannerCLI hello world`](#plannercli-hello-world) -* [`plannerCLI help [COMMAND]`](#plannercli-help-command) -* [`plannerCLI plugins`](#plannercli-plugins) -* [`plannerCLI plugins:install PLUGIN...`](#plannercli-pluginsinstall-plugin) -* [`plannerCLI plugins:inspect PLUGIN...`](#plannercli-pluginsinspect-plugin) -* [`plannerCLI plugins:install PLUGIN...`](#plannercli-pluginsinstall-plugin-1) -* [`plannerCLI plugins:link PLUGIN`](#plannercli-pluginslink-plugin) -* [`plannerCLI plugins:uninstall PLUGIN...`](#plannercli-pluginsuninstall-plugin) -* [`plannerCLI plugins reset`](#plannercli-plugins-reset) -* [`plannerCLI plugins:uninstall PLUGIN...`](#plannercli-pluginsuninstall-plugin-1) -* [`plannerCLI plugins:uninstall PLUGIN...`](#plannercli-pluginsuninstall-plugin-2) -* [`plannerCLI plugins update`](#plannercli-plugins-update) - -## `plannerCLI hello PERSON` - -Say hello - -``` -USAGE - $ plannerCLI hello PERSON -f - -ARGUMENTS - PERSON Person to say hello to - -FLAGS - -f, --from= (required) Who is saying hello - -DESCRIPTION - Say hello - -EXAMPLES - $ oex hello friend --from oclif - hello friend from oclif! (./src/commands/hello/index.ts) -``` - -_See code: [src/commands/hello/index.ts](https://github.com/eseer-divad/plannerCLI/blob/v0.0.0/src/commands/hello/index.ts)_ - -## `plannerCLI hello world` - -Say hello world - -``` -USAGE - $ plannerCLI hello world - -DESCRIPTION - Say hello world - -EXAMPLES - $ plannerCLI hello world - hello world! (./src/commands/hello/world.ts) -``` - -_See code: [src/commands/hello/world.ts](https://github.com/eseer-divad/plannerCLI/blob/v0.0.0/src/commands/hello/world.ts)_ - -## `plannerCLI help [COMMAND]` - -Display help for plannerCLI. - -``` -USAGE - $ plannerCLI 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 plannerCLI. -``` - -_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.17/src/commands/help.ts)_ - -## `plannerCLI plugins` - -List installed plugins. - -``` -USAGE - $ plannerCLI plugins [--json] [--core] - -FLAGS - --core Show core plugins. - -GLOBAL FLAGS - --json Format output as json. - -DESCRIPTION - List installed plugins. - -EXAMPLES - $ plannerCLI plugins -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/index.ts)_ - -## `plannerCLI plugins:install PLUGIN...` - -Installs a plugin into the CLI. - -``` -USAGE - $ plannerCLI plugins add plugins:install PLUGIN... - -ARGUMENTS - PLUGIN Plugin to install. - -FLAGS - -f, --force Run yarn install with force flag. - -h, --help Show CLI help. - -s, --silent Silences yarn output. - -v, --verbose Show verbose yarn output. - -GLOBAL FLAGS - --json Format output as json. - -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 - $ plannerCLI plugins add - -EXAMPLES - $ plannerCLI plugins add myplugin - - $ plannerCLI plugins add https://github.com/someuser/someplugin - - $ plannerCLI plugins add someuser/someplugin -``` - -## `plannerCLI plugins:inspect PLUGIN...` - -Displays installation properties of a plugin. - -``` -USAGE - $ plannerCLI plugins inspect PLUGIN... - -ARGUMENTS - PLUGIN [default: .] Plugin to inspect. - -FLAGS - -h, --help Show CLI help. - -v, --verbose - -GLOBAL FLAGS - --json Format output as json. - -DESCRIPTION - Displays installation properties of a plugin. - -EXAMPLES - $ plannerCLI plugins inspect myplugin -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/inspect.ts)_ - -## `plannerCLI plugins:install PLUGIN...` - -Installs a plugin into the CLI. - -``` -USAGE - $ plannerCLI plugins install PLUGIN... - -ARGUMENTS - PLUGIN Plugin to install. - -FLAGS - -f, --force Run yarn install with force flag. - -h, --help Show CLI help. - -s, --silent Silences yarn output. - -v, --verbose Show verbose yarn output. - -GLOBAL FLAGS - --json Format output as json. - -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 - $ plannerCLI plugins add - -EXAMPLES - $ plannerCLI plugins install myplugin - - $ plannerCLI plugins install https://github.com/someuser/someplugin - - $ plannerCLI plugins install someuser/someplugin -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/install.ts)_ - -## `plannerCLI plugins:link PLUGIN` - -Links a plugin into the CLI for development. - -``` -USAGE - $ plannerCLI plugins link PLUGIN - -ARGUMENTS - PATH [default: .] path to plugin - -FLAGS - -h, --help Show CLI help. - -v, --verbose - --[no-]install Install dependencies after linking the plugin. - -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 - $ plannerCLI plugins link myplugin -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/link.ts)_ - -## `plannerCLI plugins:uninstall PLUGIN...` - -Removes a plugin from the CLI. - -``` -USAGE - $ plannerCLI plugins remove plugins:uninstall PLUGIN... - -ARGUMENTS - PLUGIN plugin to uninstall - -FLAGS - -h, --help Show CLI help. - -v, --verbose - -DESCRIPTION - Removes a plugin from the CLI. - -ALIASES - $ plannerCLI plugins unlink - $ plannerCLI plugins remove - -EXAMPLES - $ plannerCLI plugins remove myplugin -``` - -## `plannerCLI plugins reset` - -Remove all user-installed and linked plugins. - -``` -USAGE - $ plannerCLI plugins reset [--hard] [--reinstall] - -FLAGS - --hard Delete node_modules and package manager related files in addition to uninstalling plugins. - --reinstall Reinstall all plugins after uninstalling. -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/reset.ts)_ - -## `plannerCLI plugins:uninstall PLUGIN...` - -Removes a plugin from the CLI. - -``` -USAGE - $ plannerCLI plugins uninstall PLUGIN... - -ARGUMENTS - PLUGIN plugin to uninstall - -FLAGS - -h, --help Show CLI help. - -v, --verbose - -DESCRIPTION - Removes a plugin from the CLI. - -ALIASES - $ plannerCLI plugins unlink - $ plannerCLI plugins remove - -EXAMPLES - $ plannerCLI plugins uninstall myplugin -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/uninstall.ts)_ - -## `plannerCLI plugins:uninstall PLUGIN...` - -Removes a plugin from the CLI. - -``` -USAGE - $ plannerCLI plugins unlink plugins:uninstall PLUGIN... - -ARGUMENTS - PLUGIN plugin to uninstall - -FLAGS - -h, --help Show CLI help. - -v, --verbose - -DESCRIPTION - Removes a plugin from the CLI. - -ALIASES - $ plannerCLI plugins unlink - $ plannerCLI plugins remove - -EXAMPLES - $ plannerCLI plugins unlink myplugin -``` - -## `plannerCLI plugins update` - -Update installed plugins. - -``` -USAGE - $ plannerCLI plugins update [-h] [-v] - -FLAGS - -h, --help Show CLI help. - -v, --verbose - -DESCRIPTION - Update installed plugins. -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v4.2.6/src/commands/plugins/update.ts)_ - -* [`oex hello PERSON`](#oex-hello-person) -* [`oex hello world`](#oex-hello-world) -* [`oex help [COMMAND]`](#oex-help-command) -* [`oex plugins`](#oex-plugins) -* [`oex plugins:inspect PLUGIN...`](#oex-pluginsinspect-plugin) -* [`oex plugins:install PLUGIN...`](#oex-pluginsinstall-plugin) -* [`oex plugins:link PLUGIN`](#oex-pluginslink-plugin) -* [`oex plugins:uninstall PLUGIN...`](#oex-pluginsuninstall-plugin) -* [`oex plugins update`](#oex-plugins-update) - -## `oex hello PERSON` - -Say hello - -``` -USAGE - $ oex hello [PERSON] -f - -ARGUMENTS - PERSON Person to say hello to - -FLAGS - -f, --from= (required) Who is saying hello - -DESCRIPTION - Say hello - -EXAMPLES - $ oex hello friend --from oclif - hello friend from oclif! (./src/commands/hello/index.ts) -``` - -_See code: [dist/commands/hello/index.ts](https://github.com/oclif/hello-world/blob/v0.0.0/dist/commands/hello/index.ts)_ - -## `oex hello world` - -Say hello world - -``` -USAGE - $ oex hello world - -DESCRIPTION - Say hello world - -EXAMPLES - $ oex hello world - hello world! (./src/commands/hello/world.ts) -``` - -## `oex help [COMMAND]` - -Display help for oex. - -``` -USAGE - $ oex 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 oex. -``` - -_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.10/src/commands/help.ts)_ - -## `oex plugins` - -List installed plugins. - -``` -USAGE - $ oex plugins [--core] - -FLAGS - --core Show core plugins. - -DESCRIPTION - List installed plugins. - -EXAMPLES - $ oex plugins -``` - -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.0.11/src/commands/plugins/index.ts)_ - -## `oex plugins:inspect PLUGIN...` - -Displays installation properties of a plugin. - -``` -USAGE - $ oex 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 - $ oex plugins:inspect myplugin -``` - -## `oex plugins:install PLUGIN...` - -Installs a plugin into the CLI. - -``` -USAGE - $ oex 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 - $ oex plugins add - -EXAMPLES - $ oex plugins:install myplugin - - $ oex plugins:install https://github.com/someuser/someplugin - - $ oex plugins:install someuser/someplugin -``` - -## `oex plugins:link PLUGIN` - -Links a plugin into the CLI for development. - -``` -USAGE - $ oex 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 - $ oex plugins:link myplugin -``` - -## `oex plugins:uninstall PLUGIN...` - -Removes a plugin from the CLI. - -``` -USAGE - $ oex plugins:uninstall PLUGIN... - -ARGUMENTS - PLUGIN plugin to uninstall - -FLAGS - -h, --help Show CLI help. - -v, --verbose - -DESCRIPTION - Removes a plugin from the CLI. - -ALIASES - $ oex plugins unlink - $ oex plugins remove -``` - -## `oex plugins update` - -Update installed plugins. - -``` -USAGE - $ oex plugins update [-h] [-v] - -FLAGS - -h, --help Show CLI help. - -v, --verbose - -DESCRIPTION - Update installed plugins. -``` - +# Day planner / Task Management CLI Application +## Proposed Task Schema: + +| Task Name | DUE | Priority | Note | ADDED | +|----------------------|------------------|----------|------------------------------------|----------------------| +| Finish Rust project | 2024-03-01 17:00 | 90 | Complete the command-line interface| 2024-02-24 09:00 | +| Grocery shopping | 2024-02-25 12:00 | 70 | Buy vegetables for the week | 2024-02-24 10:00 | +| Book dentist appointment| 2024-03-10 09:00| 50 | Checkup and cleaning | 2024-02-24 11:00 | +| Plan birthday party | 2024-04-05 15:00 | 80 | Reserve venue, order cake | 2024-02-24 12:00 | +| Study for exams | 2024-05-20 10:00 | 100 | Focus on math and science subjects | 2024-02-24 13:00 | +| Update website | 2024-03-15 16:00 | 60 | Refresh the homepage design | 2024-02-24 14:00 | +| Write blog post | 2024-02-28 18:00 | 40 | Topic: 'Learning Rust' | 2024-02-24 15:00 | + +Then, write commands to call these tasks back in order of various column values.