0.1.0 • Published 1 year ago

engineering-day-log v0.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

oclif-hello-world

oclif example Hello World CLI

oclif Version CircleCI Downloads/week License

Usage

$ npm install -g engineering-day-log
$ daylog COMMAND
running command...
$ daylog (--version)
engineering-day-log/0.1.0 darwin-arm64 node-v18.4.0
$ daylog --help [COMMAND]
USAGE
  $ daylog COMMAND
...

Commands

daylog entry

Create, edit, delete and tag notes

USAGE
  $ daylog entry [-t] [-e] [-d <value>]

FLAGS
  -d, --delete=<value>  delete specified entry
  -e, --edit            edit specified entry
  -t, --tag             add specified tag to entry

DESCRIPTION
  Create, edit, delete and tag notes

EXAMPLES
  $ daylog -t

  $ daylog -e

  $ daylog -d 123

See code: dist/commands/entry.ts

daylog help [COMMAND]

Display help for daylog.

USAGE
  $ daylog 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 daylog.

See code: @oclif/plugin-help

daylog log

See a log of past entries

USAGE
  $ daylog log [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml |  |
    [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -x, --extended     show extra columns
  --columns=<value>  only show provided columns (comma-separated)
  --csv              output is csv format [alias: --output=csv]
  --filter=<value>   filter property by partial string matching, ex: name=foo
  --no-header        hide table header from output
  --no-truncate      do not truncate output to fit screen
  --output=<option>  output in a more machine friendly format
                     <options: csv|json|yaml>
  --sort=<value>     property to sort by (prepend '-' for descending)

DESCRIPTION
  See a log of past entries

EXAMPLES
  $ daylog log

See code: dist/commands/log.ts

daylog login

Log in to an account using email and password

USAGE
  $ daylog login -e <value> -p <value>

FLAGS
  -e, --email=<value>     (required) email address
  -p, --password=<value>  (required) user's password

DESCRIPTION
  Log in to an account using email and password

EXAMPLES
  $ daylog login -e john@example.com -p password

See code: dist/commands/login.ts

daylog logout

Log out of current account

USAGE
  $ daylog logout

DESCRIPTION
  Log out of current account

EXAMPLES
  $ daylog logout

See code: dist/commands/logout.ts

daylog plugins

List installed plugins.

USAGE
  $ daylog plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ daylog plugins

See code: @oclif/plugin-plugins

daylog plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ daylog 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
  $ daylog plugins add

EXAMPLES
  $ daylog plugins:install myplugin 

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

  $ daylog plugins:install someuser/someplugin

daylog plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ daylog 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
  $ daylog plugins:inspect myplugin

daylog plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ daylog 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
  $ daylog plugins add

EXAMPLES
  $ daylog plugins:install myplugin 

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

  $ daylog plugins:install someuser/someplugin

daylog plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ daylog 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
  $ daylog plugins:link myplugin

daylog plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ daylog plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ daylog plugins unlink
  $ daylog plugins remove

daylog plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ daylog plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ daylog plugins unlink
  $ daylog plugins remove

daylog plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ daylog plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ daylog plugins unlink
  $ daylog plugins remove

daylog plugins update

Update installed plugins.

USAGE
  $ daylog plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

daylog register

Register as a new user

USAGE
  $ daylog register

DESCRIPTION
  Register as a new user

EXAMPLES
  $ daylog register

See code: dist/commands/register.ts

daylog tag

Create, delete, edit and view user's tags

USAGE
  $ daylog tag [-l] [-n <value>] [-d <value>] [-e <value>] [--columns <value> | -x] [--sort <value>]
    [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -d, --delete=<value>
  -e, --edit=<value>
  -l, --list
  -n, --new=<value>
  -x, --extended        show extra columns
  --columns=<value>     only show provided columns (comma-separated)
  --csv                 output is csv format [alias: --output=csv]
  --filter=<value>      filter property by partial string matching, ex: name=foo
  --no-header           hide table header from output
  --no-truncate         do not truncate output to fit screen
  --output=<option>     output in a more machine friendly format
                        <options: csv|json|yaml>
  --sort=<value>        property to sort by (prepend '-' for descending)

DESCRIPTION
  Create, delete, edit and view user's tags

EXAMPLES
  $ daylog tag -l

  $ daylog tag -n newTag

  $ daylog tag -d 123

  $ daylog tag -e 123

See code: dist/commands/tag.ts

daylog whoami

Get current user data for debugging

USAGE
  $ daylog whoami

DESCRIPTION
  Get current user data for debugging

EXAMPLES
  $ daylog whoami

See code: dist/commands/whoami.ts