❤
npm
Sign UpSign In

thw-faucet-cli
TypeScript icon, indicating that this package has built-in type declarations

0.0.0 • Public • Published

thw-faucet-cli

🌈 A command-line tool to quickly get testnet tokens right from your terminal with metamask authentication!

Built as a demo project from my blog post

Usage

$ npm install -g thw-faucet-cli
$ faucet-cli COMMAND
running command...
$ faucet-cli (--version)
thw-faucet-cli/0.0.0 win32-x64 node-v16.13.0
$ faucet-cli --help [COMMAND]
USAGE
  $ faucet-cli COMMAND
...

Commands

faucet-cli help [COMMAND]

Display help for faucet-cli.

USAGE
  $ faucet-cli 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 faucet-cli.

See code: @oclif/plugin-help

faucet-cli login

🦁 Connect your Metamask wallet to the faucet CLI

USAGE
  $ faucet-cli login

DESCRIPTION
  🦁 Connect your Metamask wallet to the faucet CLI

EXAMPLES
  $ faucet-cli login

See code: dist/commands/login.ts

faucet-cli plugins

List installed plugins.

USAGE
  $ faucet-cli plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ faucet-cli plugins

See code: @oclif/plugin-plugins

faucet-cli plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ faucet-cli plugins:install myplugin 

  $ faucet-cli plugins:install https://github.com/someuser/someplugin

  $ faucet-cli plugins:install someuser/someplugin

faucet-cli plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

faucet-cli plugins:install PLUGIN...

Installs a plugin into the CLI.

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

EXAMPLES
  $ faucet-cli plugins:install myplugin 

  $ faucet-cli plugins:install https://github.com/someuser/someplugin

  $ faucet-cli plugins:install someuser/someplugin

faucet-cli plugins:link PLUGIN

Links a plugin into the CLI for development.

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

faucet-cli plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ faucet-cli plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ faucet-cli plugins unlink
  $ faucet-cli plugins remove

faucet-cli plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ faucet-cli plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ faucet-cli plugins unlink
  $ faucet-cli plugins remove

faucet-cli plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ faucet-cli plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ faucet-cli plugins unlink
  $ faucet-cli plugins remove

faucet-cli plugins update

Update installed plugins.

USAGE
  $ faucet-cli plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

faucet-cli request

🚰 Request for testnet tokens

USAGE
  $ faucet-cli request

DESCRIPTION
  🚰 Request for testnet tokens

See code: dist/commands/request.ts

faucet-cli help [COMMAND]

Display help for faucet-cli.

USAGE
  $ faucet-cli 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 faucet-cli.

faucet-cli login

🦁 Connect your Metamask wallet to the faucet CLI

USAGE
  $ faucet-cli login

DESCRIPTION
  🦁 Connect your Metamask wallet to the faucet CLI

EXAMPLES
  $ faucet-cli login

faucet-cli request

🚰 Request for testnet tokens

USAGE
  $ faucet-cli request

DESCRIPTION
  🚰 Request for testnet tokens

Readme

Keywords

Package Sidebar

Install

npm i thw-faucet-cli

Repository

github.com/Kira272921/thw-faucet-cli

Homepage

github.com/Kira272921/thw-faucet-cli

Weekly Downloads

1

Version

0.0.0

License

MIT

Unpacked Size

19 kB

Total Files

27

Last publish

Collaborators

  • kira272921
Try on RunKit
Report malware