blinko-cli
v0.0.4
Published
a blinko cli for development and release
Downloads
17
Readme
blinko-cli
A command line tool for managing Blinko plugins
Usage
You can run it directly with npx:
$ npx blinko-cli COMMANDOr install it globally:
$ npm install -g blinko-cli
$ blinko-cli COMMANDCommands
blinko-cli dev serverblinko-cli help [COMMAND]blinko-cli pluginsblinko-cli plugins add PLUGINblinko-cli plugins:inspect PLUGIN...blinko-cli plugins install PLUGINblinko-cli plugins link PATHblinko-cli plugins remove [PLUGIN]blinko-cli plugins resetblinko-cli plugins uninstall [PLUGIN]blinko-cli plugins unlink [PLUGIN]blinko-cli plugins updateblinko-cli release plugin
blinko-cli dev server
Start a development server for Blinko plugins with hot-reloading
USAGE
$ blinko-cli dev server [--ws-port <value>] [--http-port <value>] [--dist-dir <value>] [--plugin-json <value>]
[--vite-command <value>]
FLAGS
--dist-dir=<value> [default: ./dist] Directory containing build output
--http-port=<value> [default: 3000] HTTP documentation server port
--plugin-json=<value> [default: ./plugin.json] Path to plugin.json file
--vite-command=<value> [default: vite] Vite command to run
--ws-port=<value> [default: 8080] WebSocket server port
DESCRIPTION
Start a development server for Blinko plugins with hot-reloading
EXAMPLES
$ blinko-cli dev server
Starting Blinko development server...
$ blinko-cli dev server --ws-port=9000 --http-port=4000
Starting Blinko development server with custom ports...See code: src/commands/dev/server.ts
blinko-cli help [COMMAND]
Display help for blinko-cli.
USAGE
$ blinko-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 blinko-cli.See code: @oclif/plugin-help
blinko-cli plugins
List installed plugins.
USAGE
$ blinko-cli plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ blinko-cli pluginsSee code: @oclif/plugin-plugins
blinko-cli plugins add PLUGIN
Installs a plugin into blinko-cli.
USAGE
$ blinko-cli 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 blinko-cli.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the BLINKO_CLI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the BLINKO_CLI_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ blinko-cli plugins add
EXAMPLES
Install a plugin from npm registry.
$ blinko-cli plugins add myplugin
Install a plugin from a github url.
$ blinko-cli plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ blinko-cli plugins add someuser/somepluginblinko-cli plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ blinko-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
$ blinko-cli plugins inspect mypluginSee code: @oclif/plugin-plugins
blinko-cli plugins install PLUGIN
Installs a plugin into blinko-cli.
USAGE
$ blinko-cli 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 blinko-cli.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the BLINKO_CLI_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the BLINKO_CLI_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ blinko-cli plugins add
EXAMPLES
Install a plugin from npm registry.
$ blinko-cli plugins install myplugin
Install a plugin from a github url.
$ blinko-cli plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ blinko-cli plugins install someuser/somepluginSee code: @oclif/plugin-plugins
blinko-cli plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ blinko-cli 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
$ blinko-cli plugins link mypluginSee code: @oclif/plugin-plugins
blinko-cli plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ blinko-cli 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
$ blinko-cli plugins unlink
$ blinko-cli plugins remove
EXAMPLES
$ blinko-cli plugins remove mypluginblinko-cli plugins reset
Remove all user-installed and linked plugins.
USAGE
$ blinko-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
blinko-cli plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ blinko-cli 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
$ blinko-cli plugins unlink
$ blinko-cli plugins remove
EXAMPLES
$ blinko-cli plugins uninstall mypluginSee code: @oclif/plugin-plugins
blinko-cli plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ blinko-cli 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
$ blinko-cli plugins unlink
$ blinko-cli plugins remove
EXAMPLES
$ blinko-cli plugins unlink mypluginblinko-cli plugins update
Update installed plugins.
USAGE
$ blinko-cli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
blinko-cli release plugin
Release plugin to Blinko marketplace
USAGE
$ blinko-cli release plugin [-d <value>]
FLAGS
-d, --dir=<value> [default: .] Directory containing plugin.json and release folder
DESCRIPTION
Release plugin to Blinko marketplace
EXAMPLES
$ blinko-cli release plugin
Releasing plugin from current directory...
$ blinko-cli release plugin --dir ./my-plugin
Releasing plugin from ./my-plugin directory...See code: src/commands/release/plugin.ts
