@tadamspace/cli
v0.0.1
Published
TSpace Development & Deployment Tool
Downloads
2
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g @tadamspace/cli
$ ts COMMAND
running command...
$ ts (--version)
@tadamspace/cli/0.0.1 linux-x64 node-v18.18.2
$ ts --help [COMMAND]
USAGE
$ ts COMMAND
...
Commands
ts autocomplete [SHELL]
ts clear-configuration
ts conf [KEY] [VALUE]
ts config:generate
ts config:test [FILE]
ts deploy:production [FILE]
ts deploy:stage
ts help [COMMANDS]
ts plugins
ts plugins:install PLUGIN...
ts plugins:inspect PLUGIN...
ts plugins:install PLUGIN...
ts plugins:link PLUGIN
ts plugins:uninstall PLUGIN...
ts plugins:reset
ts plugins:uninstall PLUGIN...
ts plugins:uninstall PLUGIN...
ts plugins:update
ts autocomplete [SHELL]
Display autocomplete installation instructions.
USAGE
$ ts autocomplete [SHELL] [-r]
ARGUMENTS
SHELL (zsh|bash|powershell) Shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
Display autocomplete installation instructions.
EXAMPLES
$ ts autocomplete
$ ts autocomplete bash
$ ts autocomplete zsh
$ ts autocomplete powershell
$ ts autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
ts clear-configuration
clear your configuration
USAGE
$ ts clear-configuration [-y]
FLAGS
-y, --yes continue without asking
DESCRIPTION
clear your configuration
EXAMPLES
$ ts clear-configuration
See code: src/commands/clear-configuration.ts
ts conf [KEY] [VALUE]
manage configuration
USAGE
$ ts conf [KEY] [VALUE] [-h] [-k <value>] [-v <value>] [-d] [-p <value>] [-n <value>] [-d <value>]
ARGUMENTS
KEY key of the config
VALUE value of the config
FLAGS
-d, --cwd=<value> config file location
-d, --delete delete?
-h, --help show CLI help
-k, --key=<value> key of the config
-n, --name=<value> config file name
-p, --project=<value> project name
-v, --value=<value> value of the config
DESCRIPTION
manage configuration
See code: conf-cli
ts config:generate
describe the command here
USAGE
$ ts config:generate [-f]
FLAGS
-f, --force
DESCRIPTION
describe the command here
EXAMPLES
$ ts config:generate
See code: src/commands/config/generate.ts
ts config:test [FILE]
describe the command here
USAGE
$ ts config:test [FILE]
ARGUMENTS
FILE config file to read
DESCRIPTION
describe the command here
EXAMPLES
$ ts config:test
See code: src/commands/config/test.ts
ts deploy:production [FILE]
deploy to production server
USAGE
$ ts deploy:production [FILE] [-n <value>] [-f]
ARGUMENTS
FILE file to read
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
deploy to production server
EXAMPLES
$ ts deploy:production
See code: src/commands/deploy/production.ts
ts deploy:stage
deploy to staging server
USAGE
$ ts deploy:stage [-f]
FLAGS
-f, --force
DESCRIPTION
deploy to staging server
EXAMPLES
$ ts deploy:stage
See code: src/commands/deploy/stage.ts
ts help [COMMANDS]
Display help for ts.
USAGE
$ ts 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 ts.
See code: @oclif/plugin-help
ts plugins
List installed plugins.
USAGE
$ ts plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ ts plugins
See code: @oclif/plugin-plugins
ts plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ ts 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
$ ts plugins:add
EXAMPLES
$ ts plugins:add myplugin
$ ts plugins:add https://github.com/someuser/someplugin
$ ts plugins:add someuser/someplugin
ts plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ ts 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
$ ts plugins:inspect myplugin
See code: @oclif/plugin-plugins
ts plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ ts 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
$ ts plugins:add
EXAMPLES
$ ts plugins:install myplugin
$ ts plugins:install https://github.com/someuser/someplugin
$ ts plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
ts plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ ts 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
$ ts plugins:link myplugin
See code: @oclif/plugin-plugins
ts plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ ts plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ts plugins:unlink
$ ts plugins:remove
EXAMPLES
$ ts plugins:remove myplugin
ts plugins:reset
Remove all user-installed and linked plugins.
USAGE
$ ts plugins:reset
See code: @oclif/plugin-plugins
ts plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ ts plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ts plugins:unlink
$ ts plugins:remove
EXAMPLES
$ ts plugins:uninstall myplugin
See code: @oclif/plugin-plugins
ts plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ ts plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ts plugins:unlink
$ ts plugins:remove
EXAMPLES
$ ts plugins:unlink myplugin
ts plugins:update
Update installed plugins.
USAGE
$ ts plugins:update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins