Giter Club home page Giter Club logo

do's Introduction

oclif-hello-world

oclif example Hello World CLI

oclif GitHub license

Usage

$ npm install -g do
$ do COMMAND
running command...
$ do (--version)
do/0.0.0 win32-x64 node-v18.18.2
$ do --help [COMMAND]
USAGE
  $ do COMMAND
...
$ 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

do autocomplete [SHELL]

Display autocomplete installation instructions.

USAGE
  $ do autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  (zsh|bash|powershell) Shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  Display autocomplete installation instructions.

EXAMPLES
  $ do autocomplete

  $ do autocomplete bash

  $ do autocomplete zsh

  $ do autocomplete powershell

  $ do autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

do commands

list all the commands

USAGE
  $ do commands [--json] [--deprecated] [-h] [--hidden] [--tree] [--columns <value> | -x] [--filter <value>]
    [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml |  | ] [--sort <value>]

FLAGS
  -h, --help             Show CLI help.
  -x, --extended         show extra columns
      --columns=<value>  only show provided columns (comma-separated)
      --csv              output is csv format [alias: --output=csv]
      --deprecated       show deprecated commands
      --filter=<value>   filter property by partial string matching, ex: name=foo
      --hidden           show hidden commands
      --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)
      --tree             show tree of commands

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  list all the commands

See code: @oclif/plugin-commands

do hello PERSON

Say hello

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

do hello world

Say hello world

USAGE
  $ do hello world

DESCRIPTION
  Say hello world

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

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

do help [COMMAND]

Display help for do.

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

See code: @oclif/plugin-help

do json sort FILES_OR_FOLDER

Sort the contents of .json files

USAGE
  $ do json sort FILES_OR_FOLDER [-o <value>] [-p <value>] [-v <value>]

ARGUMENTS
  FILES_OR_FOLDER  Files or folder

FLAGS
  -o, --output=<value>   Output to file
  -p, --prepend=<value>  Prepend to generated filenames
  -v, --verbose=<value>  Verbose mode

DESCRIPTION
  Sort the contents of .json files

EXAMPLES
  Single file use
  $ do json sort file.json
  Single file use with selected output name
  $ do json sort file.json --output sorted.json
  Single file use with prepend
  $ do json sort file.json --output sorted.json --prepend "sorted-"
  Multifile files use
  $ do json sort *.json
  $ do json sort *.json --output ./sorted
  $ do json sort ./ --output ./sorted
  $ do json sort ./ --output ./sorted --prepend "sorted-"

See code: src/commands/json/sort.ts

do plugins

List installed plugins.

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ do plugins

See code: @oclif/plugin-plugins

do plugins add PLUGIN

Installs a plugin into do.

USAGE
  $ do plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into do.

  Uses bundled npm executable to install plugins into C:\Users\alpap\AppData\Local\do

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

  Use the DO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the DO_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ do plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ do plugins add myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ do plugins add someuser/someplugin

do plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

do plugins install PLUGIN

Installs a plugin into do.

USAGE
  $ do plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into do.

  Uses bundled npm executable to install plugins into C:\Users\alpap\AppData\Local\do

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

  Use the DO_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the DO_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ do plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ do plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ do plugins install someuser/someplugin

See code: @oclif/plugin-plugins

do plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ do plugins link PATH [-h] [--install] [-v]

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

See code: @oclif/plugin-plugins

do plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ do plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ do plugins unlink
  $ do plugins remove

EXAMPLES
  $ do plugins remove myplugin

do plugins reset

Remove all user-installed and linked plugins.

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

do plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ do plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ do plugins unlink
  $ do plugins remove

EXAMPLES
  $ do plugins uninstall myplugin

See code: @oclif/plugin-plugins

do plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ do plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ do plugins unlink
  $ do plugins remove

EXAMPLES
  $ do plugins unlink myplugin

do plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

do version

USAGE
  $ do version [--json] [--verbose]

FLAGS
  --verbose  Show additional information about the CLI.

GLOBAL FLAGS
  --json  Format output as json.

FLAG DESCRIPTIONS
  --verbose  Show additional information about the CLI.

    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.

See code: @oclif/plugin-version

oex hello PERSON

Say hello

USAGE
  $ oex 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: 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

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

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.

do's People

Contributors

alpap 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.