rtk-cli
v0.0.1
Published
RTK cli commands
Downloads
3
Readme
SSG cli
npm i ssgrtk -g
Usage
$ npm install -g rtk-cli
$ ssg COMMAND
running command...
$ ssg (--version)
rtk-cli/0.0.1 darwin-x64 node-v16.13.2
$ ssg --help [COMMAND]
USAGE
$ ssg COMMAND
...
Commands
ssg collection
ssg create
ssg crud
ssg delete
ssg get
ssg help [COMMAND]
ssg patch
ssg plugins
ssg plugins:inspect PLUGIN...
ssg plugins:install PLUGIN...
ssg plugins:link PLUGIN
ssg plugins:uninstall PLUGIN...
ssg plugins update
ssg update
ssg collection
USAGE
$ ssg collection
See code: dist/commands/collection.ts
ssg create
USAGE
$ ssg create
See code: dist/commands/create.ts
ssg crud
USAGE
$ ssg crud
See code: dist/commands/crud.ts
ssg delete
USAGE
$ ssg delete
See code: dist/commands/delete.ts
ssg get
USAGE
$ ssg get
See code: dist/commands/get.ts
ssg help [COMMAND]
Display help for ssg.
USAGE
$ ssg 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 ssg.
See code: @oclif/plugin-help
ssg patch
USAGE
$ ssg patch
See code: dist/commands/patch.ts
ssg plugins
List installed plugins.
USAGE
$ ssg plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ ssg plugins
See code: @oclif/plugin-plugins
ssg plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ ssg 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
$ ssg plugins:inspect myplugin
ssg plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ ssg 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
$ ssg plugins add
EXAMPLES
$ ssg plugins:install myplugin
$ ssg plugins:install https://github.com/someuser/someplugin
$ ssg plugins:install someuser/someplugin
ssg plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ ssg 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
$ ssg plugins:link myplugin
ssg plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ ssg plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ssg plugins unlink
$ ssg plugins remove
ssg plugins update
Update installed plugins.
USAGE
$ ssg plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
ssg update
USAGE
$ ssg update
See code: dist/commands/update.ts