@paperback/toolchain v1.0.0-alpha.24
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g @paperback/toolchain
$ paperback-cli COMMAND
running command...
$ paperback-cli (--version)
@paperback/toolchain/1.0.0-alpha.13 darwin-arm64 node-v18.18.2
$ paperback-cli --help [COMMAND]
USAGE
$ paperback-cli COMMAND
...
Commands
paperback-cli bundle
paperback-cli help [COMMANDS]
paperback-cli logcat [FILE]
paperback-cli plugins
paperback-cli plugins:install PLUGIN...
paperback-cli plugins:inspect PLUGIN...
paperback-cli plugins:install PLUGIN...
paperback-cli plugins:link PLUGIN
paperback-cli plugins:uninstall PLUGIN...
paperback-cli plugins reset
paperback-cli plugins:uninstall PLUGIN...
paperback-cli plugins:uninstall PLUGIN...
paperback-cli plugins update
paperback-cli serve
paperback-cli bundle
Builds all the sources in the repository and generates a versioning file
USAGE
$ paperback-cli bundle [--folder <value>] [-h]
FLAGS
-h, --help Show CLI help.
--folder=<value> Subfolder to output to
DESCRIPTION
Builds all the sources in the repository and generates a versioning file
See code: src/commands/bundle.ts
paperback-cli help [COMMANDS]
Display help for paperback-cli.
USAGE
$ paperback-cli 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 paperback-cli.
See code: @oclif/plugin-help
paperback-cli logcat [FILE]
describe the command here
USAGE
$ paperback-cli logcat [FILE] [--ip <value>] [--port <value>]
ARGUMENTS
FILE file to read
FLAGS
--ip=<value> [default: localhost]
--port=<value> [default: 27015]
DESCRIPTION
describe the command here
EXAMPLES
$ paperback-cli logcat
See code: src/commands/logcat.ts
paperback-cli plugins
List installed plugins.
USAGE
$ paperback-cli plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ paperback-cli plugins
See code: @oclif/plugin-plugins
paperback-cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ paperback-cli 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
$ paperback-cli plugins add
EXAMPLES
$ paperback-cli plugins add myplugin
$ paperback-cli plugins add https://github.com/someuser/someplugin
$ paperback-cli plugins add someuser/someplugin
paperback-cli plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ paperback-cli 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
$ paperback-cli plugins inspect myplugin
See code: @oclif/plugin-plugins
paperback-cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ paperback-cli 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
$ paperback-cli plugins add
EXAMPLES
$ paperback-cli plugins install myplugin
$ paperback-cli plugins install https://github.com/someuser/someplugin
$ paperback-cli plugins install someuser/someplugin
See code: @oclif/plugin-plugins
paperback-cli plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ paperback-cli 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
$ paperback-cli plugins link myplugin
See code: @oclif/plugin-plugins
paperback-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ paperback-cli 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
$ paperback-cli plugins unlink
$ paperback-cli plugins remove
EXAMPLES
$ paperback-cli plugins remove myplugin
paperback-cli plugins reset
Remove all user-installed and linked plugins.
USAGE
$ paperback-cli 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
paperback-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ paperback-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
$ paperback-cli plugins unlink
$ paperback-cli plugins remove
EXAMPLES
$ paperback-cli plugins uninstall myplugin
See code: @oclif/plugin-plugins
paperback-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ paperback-cli 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
$ paperback-cli plugins unlink
$ paperback-cli plugins remove
EXAMPLES
$ paperback-cli plugins unlink myplugin
paperback-cli plugins update
Update installed plugins.
USAGE
$ paperback-cli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
paperback-cli serve
Build the sources and start a local server
USAGE
$ paperback-cli serve [-h] [-p <value>]
FLAGS
-h, --help Show CLI help.
-p, --port=<value> [default: 8080]
DESCRIPTION
Build the sources and start a local server
See code: src/commands/serve.ts
9 months ago
9 months ago
9 months ago
9 months ago
12 months ago
1 year ago
1 year ago
12 months ago
12 months ago
12 months ago
12 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago