github-profile-bio-fetcher
TypeScript icon, indicating that this package has built-in type declarations

0.0.1 • Public • Published

github-bio-profile-fetcher

sample cli for npm package tutorial

oclif

Usage

$ npm install -g github-profile-bio-fetcher
$ github-profile-bio-fetcher COMMAND
running command...
$ github-profile-bio-fetcher (--version)
github-profile-bio-fetcher/0.0.1 darwin-arm64 node-v20.8.0
$ github-profile-bio-fetcher --help [COMMAND]
USAGE
  $ github-profile-bio-fetcher COMMAND
...

Commands

github-profile-bio-fetcher help [COMMANDS]

Display help for github-profile-bio-fetcher.

USAGE
  $ github-profile-bio-fetcher 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 github-profile-bio-fetcher.

See code: @oclif/plugin-help

github-profile-bio-fetcher plugins

List installed plugins.

USAGE
  $ github-profile-bio-fetcher plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ github-profile-bio-fetcher plugins

See code: @oclif/plugin-plugins

github-profile-bio-fetcher plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ github-profile-bio-fetcher 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
  $ github-profile-bio-fetcher plugins add

EXAMPLES
  $ github-profile-bio-fetcher plugins add myplugin 

  $ github-profile-bio-fetcher plugins add https://github.com/someuser/someplugin

  $ github-profile-bio-fetcher plugins add someuser/someplugin

github-profile-bio-fetcher plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ github-profile-bio-fetcher 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
  $ github-profile-bio-fetcher plugins inspect myplugin

See code: @oclif/plugin-plugins

github-profile-bio-fetcher plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ github-profile-bio-fetcher 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
  $ github-profile-bio-fetcher plugins add

EXAMPLES
  $ github-profile-bio-fetcher plugins install myplugin 

  $ github-profile-bio-fetcher plugins install https://github.com/someuser/someplugin

  $ github-profile-bio-fetcher plugins install someuser/someplugin

See code: @oclif/plugin-plugins

github-profile-bio-fetcher plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ github-profile-bio-fetcher 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
  $ github-profile-bio-fetcher plugins link myplugin

See code: @oclif/plugin-plugins

github-profile-bio-fetcher plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ github-profile-bio-fetcher 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
  $ github-profile-bio-fetcher plugins unlink
  $ github-profile-bio-fetcher plugins remove

EXAMPLES
  $ github-profile-bio-fetcher plugins remove myplugin

github-profile-bio-fetcher plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ github-profile-bio-fetcher plugins reset

See code: @oclif/plugin-plugins

github-profile-bio-fetcher plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ github-profile-bio-fetcher plugins uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ github-profile-bio-fetcher plugins unlink
  $ github-profile-bio-fetcher plugins remove

EXAMPLES
  $ github-profile-bio-fetcher plugins uninstall myplugin

See code: @oclif/plugin-plugins

github-profile-bio-fetcher plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ github-profile-bio-fetcher 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
  $ github-profile-bio-fetcher plugins unlink
  $ github-profile-bio-fetcher plugins remove

EXAMPLES
  $ github-profile-bio-fetcher plugins unlink myplugin

github-profile-bio-fetcher plugins update

Update installed plugins.

USAGE
  $ github-profile-bio-fetcher plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

github-profile-bio-fetcher profile USERNAME

fetch profile bio by GitHub username

USAGE
  $ github-profile-bio-fetcher profile USERNAME

ARGUMENTS
  USERNAME  GitHub username

DESCRIPTION
  fetch profile bio by GitHub username

EXAMPLES
  $ profile Cerchie 
  "bio: hello my name is Lucia Cerchie and I like cute cats." (./src/commands/profile/index.ts)

See code: src/commands/profile/index.ts

github-profile-bio-fetcher profile USERNAME

gets user's bio

USAGE
  $ github-profile-bio-fetcher profile USERNAME 

ARGUMENTS
  USERNAME  GitHub username

DESCRIPTION
fetch the bio for the GitHub user

EXAMPLES
  $ github-profile-bio-fetcher profile Cerchie 
  "This is the story of Cerchie's life:" (./src/commands/profile/index.ts)

See code: src/commands/profile/index.ts

e-bio-fetcher hello world hello world! (./src/commands/hello/world.ts)


## `github-profile-bio-fetcher help [COMMANDS]`

Display help for github-profile-bio-fetcher.

USAGE $ github-profile-bio-fetcher 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 github-profile-bio-fetcher.


_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_

Readme

Keywords

Package Sidebar

Install

npm i github-profile-bio-fetcher

Weekly Downloads

0

Version

0.0.1

License

MIT

Unpacked Size

16.4 kB

Total Files

11

Last publish

Collaborators

  • cerchie