https://github.com/cerchie/github-bio-profile-fetcher
sample cli for npm package tutorial
https://github.com/cerchie/github-bio-profile-fetcher
Last synced: about 1 month ago
JSON representation
sample cli for npm package tutorial
- Host: GitHub
- URL: https://github.com/cerchie/github-bio-profile-fetcher
- Owner: Cerchie
- Created: 2023-12-21T16:47:40.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-16T18:25:53.000Z (over 2 years ago)
- Last Synced: 2025-10-11T02:08:34.004Z (9 months ago)
- Language: TypeScript
- Size: 18.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
github-bio-profile-fetcher
=================
sample cli for npm package tutorial
[](https://oclif.io)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ 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.0 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]`](#github-profile-bio-fetcher-help-commands)
* [`github-profile-bio-fetcher plugins`](#github-profile-bio-fetcher-plugins)
* [`github-profile-bio-fetcher plugins:install PLUGIN...`](#github-profile-bio-fetcher-pluginsinstall-plugin)
* [`github-profile-bio-fetcher plugins:inspect PLUGIN...`](#github-profile-bio-fetcher-pluginsinspect-plugin)
* [`github-profile-bio-fetcher plugins:install PLUGIN...`](#github-profile-bio-fetcher-pluginsinstall-plugin-1)
* [`github-profile-bio-fetcher plugins:link PLUGIN`](#github-profile-bio-fetcher-pluginslink-plugin)
* [`github-profile-bio-fetcher plugins:uninstall PLUGIN...`](#github-profile-bio-fetcher-pluginsuninstall-plugin)
* [`github-profile-bio-fetcher plugins reset`](#github-profile-bio-fetcher-plugins-reset)
* [`github-profile-bio-fetcher plugins:uninstall PLUGIN...`](#github-profile-bio-fetcher-pluginsuninstall-plugin-1)
* [`github-profile-bio-fetcher plugins:uninstall PLUGIN...`](#github-profile-bio-fetcher-pluginsuninstall-plugin-2)
* [`github-profile-bio-fetcher plugins update`](#github-profile-bio-fetcher-plugins-update)
* [`github-profile-bio-fetcher profile USERNAME`](#github-profile-bio-fetcher-profile-username)
## `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)_
## `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](https://github.com/oclif/plugin-plugins/blob/v4.1.10/src/commands/plugins/index.ts)_
## `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](https://github.com/oclif/plugin-plugins/blob/v4.1.10/src/commands/plugins/inspect.ts)_
## `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](https://github.com/oclif/plugin-plugins/blob/v4.1.10/src/commands/plugins/install.ts)_
## `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](https://github.com/oclif/plugin-plugins/blob/v4.1.10/src/commands/plugins/link.ts)_
## `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](https://github.com/oclif/plugin-plugins/blob/v4.1.10/src/commands/plugins/reset.ts)_
## `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](https://github.com/oclif/plugin-plugins/blob/v4.1.10/src/commands/plugins/uninstall.ts)_
## `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](https://github.com/oclif/plugin-plugins/blob/v4.1.10/src/commands/plugins/update.ts)_
## `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](https://github.com/Cerchie/github-profile-bio-fetcher/blob/v0.0.0/src/commands/profile/index.ts)_
* [`github-profile-bio-fetcher hello PERSON`](#github-profile-bio-fetcher-hello-person)
* [`github-profile-bio-fetcher hello world`](#github-profile-bio-fetcher-hello-world)
* [`github-profile-bio-fetcher help [COMMANDS]`](#github-profile-bio-fetcher-help-commands)
* [`github-profile-bio-fetcher plugins`](#github-profile-bio-fetcher-plugins)
* [`github-profile-bio-fetcher plugins:install PLUGIN...`](#github-profile-bio-fetcher-pluginsinstall-plugin)
* [`github-profile-bio-fetcher plugins:inspect PLUGIN...`](#github-profile-bio-fetcher-pluginsinspect-plugin)
* [`github-profile-bio-fetcher plugins:install PLUGIN...`](#github-profile-bio-fetcher-pluginsinstall-plugin-1)
* [`github-profile-bio-fetcher plugins:link PLUGIN`](#github-profile-bio-fetcher-pluginslink-plugin)
* [`github-profile-bio-fetcher plugins:uninstall PLUGIN...`](#github-profile-bio-fetcher-pluginsuninstall-plugin)
* [`github-profile-bio-fetcher plugins reset`](#github-profile-bio-fetcher-plugins-reset)
* [`github-profile-bio-fetcher plugins:uninstall PLUGIN...`](#github-profile-bio-fetcher-pluginsuninstall-plugin-1)
* [`github-profile-bio-fetcher plugins:uninstall PLUGIN...`](#github-profile-bio-fetcher-pluginsuninstall-plugin-2)
* [`github-profile-bio-fetcher plugins update`](#github-profile-bio-fetcher-plugins-update)
## `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](https://github.com/Cerchie/github-profile-bio-fetcher/blob/v0.0.0/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)_