@manifesto-tech/tpx-sk-cli
v1.0.0
Published
A CLI tool to create new projects using TPXimpact starter kit repositories
Downloads
2
Keywords
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g @manifesto-tech/tpx-sk-cli
$ tpx-sk-cli COMMAND
running command...
$ tpx-sk-cli (--version)
@manifesto-tech/tpx-sk-cli/1.0.0 darwin-x64 node-v14.21.1
$ tpx-sk-cli --help [COMMAND]
USAGE
$ tpx-sk-cli COMMAND
...
Commands
tpx-sk-cli help [COMMAND]
tpx-sk-cli init [REPOSITORY]
tpx-sk-cli plugins
tpx-sk-cli plugins:install PLUGIN...
tpx-sk-cli plugins:inspect PLUGIN...
tpx-sk-cli plugins:install PLUGIN...
tpx-sk-cli plugins:link PLUGIN
tpx-sk-cli plugins:uninstall PLUGIN...
tpx-sk-cli plugins:uninstall PLUGIN...
tpx-sk-cli plugins:uninstall PLUGIN...
tpx-sk-cli plugins:update
tpx-sk-cli rename [REPOSITORY]
tpx-sk-cli help [COMMAND]
Display help for tpx-sk-cli.
USAGE
$ tpx-sk-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 tpx-sk-cli.
See code: @oclif/plugin-help
tpx-sk-cli init [REPOSITORY]
Start a new project using a TPXimpact seed repo
USAGE
$ tpx-sk-cli init [REPOSITORY] [-i <value>] [-v]
ARGUMENTS
REPOSITORY [default: [email protected]:manifestodigital/tpx-starter-kit.git] override the seed repo
FLAGS
-i, --install=<value> [default: true] run installation script
-v, --verbose print verbose output
DESCRIPTION
Start a new project using a TPXimpact seed repo
EXAMPLES
$ tpx-sk-cli init
tpx-sk-cli plugins
List installed plugins.
USAGE
$ tpx-sk-cli plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ tpx-sk-cli plugins
See code: @oclif/plugin-plugins
tpx-sk-cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ tpx-sk-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
$ tpx-sk-cli plugins:add
EXAMPLES
$ tpx-sk-cli plugins:install myplugin
$ tpx-sk-cli plugins:install https://github.com/someuser/someplugin
$ tpx-sk-cli plugins:install someuser/someplugin
tpx-sk-cli plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ tpx-sk-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
$ tpx-sk-cli plugins:inspect myplugin
See code: @oclif/plugin-plugins
tpx-sk-cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ tpx-sk-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
$ tpx-sk-cli plugins:add
EXAMPLES
$ tpx-sk-cli plugins:install myplugin
$ tpx-sk-cli plugins:install https://github.com/someuser/someplugin
$ tpx-sk-cli plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
tpx-sk-cli plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ tpx-sk-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
$ tpx-sk-cli plugins:link myplugin
See code: @oclif/plugin-plugins
tpx-sk-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ tpx-sk-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
$ tpx-sk-cli plugins:unlink
$ tpx-sk-cli plugins:remove
tpx-sk-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ tpx-sk-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
$ tpx-sk-cli plugins:unlink
$ tpx-sk-cli plugins:remove
See code: @oclif/plugin-plugins
tpx-sk-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ tpx-sk-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
$ tpx-sk-cli plugins:unlink
$ tpx-sk-cli plugins:remove
tpx-sk-cli plugins:update
Update installed plugins.
USAGE
$ tpx-sk-cli plugins:update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
tpx-sk-cli rename [REPOSITORY]
Start a new project using a TPXimpact seed repo
USAGE
$ tpx-sk-cli rename [REPOSITORY] [-v]
ARGUMENTS
REPOSITORY override the seed repo
FLAGS
-v, --verbose print verbose output
DESCRIPTION
Start a new project using a TPXimpact seed repo
EXAMPLES
$ tpx-sk-cli rename