GithubHelp home page GithubHelp logo

mrmurdock11 / noty-cli-sample Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 20 KB

Simple implementation of a CLI project using oclif for a blog post.

Batchfile 0.54% TypeScript 97.64% JavaScript 1.82%

noty-cli-sample's Introduction

oclif-hello-world

oclif example Hello World CLI

oclif CircleCI GitHub license

Usage

$ npm install -g noty
$ noty COMMAND
running command...
$ noty (--version)
noty/0.0.0 darwin-arm64 node-v20.5.0
$ noty --help [COMMAND]
USAGE
  $ noty COMMAND
...

Commands

noty hello PERSON

Say hello

USAGE
  $ noty hello PERSON -f <value>

ARGUMENTS
  PERSON  Person to say hello to

FLAGS
  -f, --from=<value>  (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

noty hello world

Say hello world

USAGE
  $ noty hello world

DESCRIPTION
  Say hello world

EXAMPLES
  $ noty hello world
  hello world! (./src/commands/hello/world.ts)

See code: src/commands/hello/world.ts

noty help [COMMANDS]

Display help for noty.

USAGE
  $ noty help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

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

DESCRIPTION
  Display help for noty.

See code: @oclif/plugin-help

noty plugins

List installed plugins.

USAGE
  $ noty plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ noty plugins

See code: @oclif/plugin-plugins

noty plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ noty plugins add myplugin 

  $ noty plugins add https://github.com/someuser/someplugin

  $ noty plugins add someuser/someplugin

noty plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

noty plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ noty plugins install myplugin 

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

  $ noty plugins install someuser/someplugin

See code: @oclif/plugin-plugins

noty plugins:link PLUGIN

Links a plugin into the CLI for development.

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

See code: @oclif/plugin-plugins

noty plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ noty 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
  $ noty plugins unlink
  $ noty plugins remove

EXAMPLES
  $ noty plugins remove myplugin

noty plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ noty 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

noty plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ noty plugins uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ noty plugins unlink
  $ noty plugins remove

EXAMPLES
  $ noty plugins uninstall myplugin

See code: @oclif/plugin-plugins

noty plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ noty 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
  $ noty plugins unlink
  $ noty plugins remove

EXAMPLES
  $ noty plugins unlink myplugin

noty plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

noty-cli-sample's People

Contributors

mrmurdock11 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.