ssgrtk
v1.1.0
Published
RTK cli commands
Readme
SSG cli
npm i ssgrtk -gUsage
$ npm install -g ssgrtk
$ ssg COMMAND
running command...
$ ssg (--version)
ssgrtk/1.1.0 darwin-arm64 node-v22.9.0
$ ssg --help [COMMAND]
USAGE
$ ssg COMMAND
...Commands
ssg action [NAME]ssg collection [NAME]ssg create [NAME]ssg crud [NAME]ssg delete [NAME]ssg get [NAME]ssg help [COMMAND]ssg patch [NAME]ssg pluginsssg plugins add PLUGINssg plugins:inspect PLUGIN...ssg plugins install PLUGINssg plugins link PATHssg plugins remove [PLUGIN]ssg plugins resetssg plugins uninstall [PLUGIN]ssg plugins unlink [PLUGIN]ssg plugins updatessg screenssg update [NAME]
ssg action [NAME]
Reducer Slice: Dispatch an action that stores global state
USAGE
$ ssg action [NAME]
DESCRIPTION
Reducer Slice: Dispatch an action that stores global stateSee code: src/commands/action.ts
ssg collection [NAME]
RTK Service: Retrieve a collection of things from an api
USAGE
$ ssg collection [NAME]
DESCRIPTION
RTK Service: Retrieve a collection of things from an apiSee code: src/commands/collection.ts
ssg create [NAME]
RTK Service: Create a thing with an api
USAGE
$ ssg create [NAME]
DESCRIPTION
RTK Service: Create a thing with an apiSee code: src/commands/create.ts
ssg crud [NAME]
RTK Service: Create,get,update and delete a thing with an api
USAGE
$ ssg crud [NAME]
DESCRIPTION
RTK Service: Create,get,update and delete a thing with an apiSee code: src/commands/crud.ts
ssg delete [NAME]
RTK Service: Delete a thing with an api
USAGE
$ ssg delete [NAME]
DESCRIPTION
RTK Service: Delete a thing with an apiSee code: src/commands/delete.ts
ssg get [NAME]
RTK Service: Get a thing with an api
USAGE
$ ssg get [NAME]
DESCRIPTION
RTK Service: Get a thing with an apiSee code: src/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 [NAME]
RTK Service: Patch a thing with an api
USAGE
$ ssg patch [NAME]
DESCRIPTION
RTK Service: Patch a thing with an apiSee code: src/commands/patch.ts
ssg plugins
List installed plugins.
USAGE
$ ssg plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ ssg pluginsSee code: @oclif/plugin-plugins
ssg plugins add PLUGIN
Installs a plugin into ssg.
USAGE
$ ssg 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 ssg.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the SSG_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the SSG_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ ssg plugins add
EXAMPLES
Install a plugin from npm registry.
$ ssg plugins add myplugin
Install a plugin from a github url.
$ ssg plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ ssg plugins add someuser/somepluginssg 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
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ ssg plugins inspect mypluginSee code: @oclif/plugin-plugins
ssg plugins install PLUGIN
Installs a plugin into ssg.
USAGE
$ ssg 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 ssg.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the SSG_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the SSG_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ ssg plugins add
EXAMPLES
Install a plugin from npm registry.
$ ssg plugins install myplugin
Install a plugin from a github url.
$ ssg plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ ssg plugins install someuser/somepluginSee code: @oclif/plugin-plugins
ssg plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ ssg 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
$ ssg plugins link mypluginSee code: @oclif/plugin-plugins
ssg plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ ssg 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
$ ssg plugins unlink
$ ssg plugins remove
EXAMPLES
$ ssg plugins remove mypluginssg plugins reset
Remove all user-installed and linked plugins.
USAGE
$ ssg 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
ssg plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ ssg 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
$ ssg plugins unlink
$ ssg plugins remove
EXAMPLES
$ ssg plugins uninstall mypluginSee code: @oclif/plugin-plugins
ssg plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ ssg 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
$ ssg plugins unlink
$ ssg plugins remove
EXAMPLES
$ ssg plugins unlink mypluginssg plugins update
Update installed plugins.
USAGE
$ ssg plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
ssg screen
Screen: creates a ReactNative Screen and Route
USAGE
$ ssg screen
DESCRIPTION
Screen: creates a ReactNative Screen and RouteSee code: src/commands/screen.ts
ssg update [NAME]
RTK Service: Update a thing with an api
USAGE
$ ssg update [NAME]
DESCRIPTION
RTK Service: Update a thing with an apiSee code: src/commands/update.ts
