0.1.1 • Published 7 months ago
tkt-cli v0.1.1
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g tkt-cli
$ tkt-cli COMMAND
running command...
$ tkt-cli (--version)
tkt-cli/0.1.1 darwin-arm64 node-v16.20.1
$ tkt-cli --help [COMMAND]
USAGE
$ tkt-cli COMMAND
...
Commands
tkt-cli g COMPONENTNAME
tkt-cli generate COMPONENTNAME
tkt-cli help [COMMANDS]
tkt-cli plugins
tkt-cli plugins:install PLUGIN...
tkt-cli plugins:inspect PLUGIN...
tkt-cli plugins:install PLUGIN...
tkt-cli plugins:link PLUGIN
tkt-cli plugins:uninstall PLUGIN...
tkt-cli plugins:uninstall PLUGIN...
tkt-cli plugins:uninstall PLUGIN...
tkt-cli plugins update
tkt-cli g COMPONENTNAME
generate components from templates
USAGE
$ tkt-cli g COMPONENTNAME [-t] [-c] [-s] [-g] [-p] [-S] [-d]
FLAGS
-S, --screenOverComponentSuffix create a .screen.tsx rather than .component.tsx
-c, --addConstsFile add component.consts.ts
-d, --useDefaults create all available files
-g, --addGraphqlFile add component.graphql.ts
-p, --addPartsFolder add ./parts/ folder
-s, --addStylesFile add component.styles.ts
-t, --addTypesFile add component.types.ts
DESCRIPTION
generate components from templates
ALIASES
$ tkt-cli g
EXAMPLES
$ create-component g my-component
Generating component 'my-component'! (./src/commands/create-component/index.ts)
tkt-cli generate COMPONENTNAME
generate components from templates
USAGE
$ tkt-cli generate COMPONENTNAME [-t] [-c] [-s] [-g] [-p] [-S] [-d]
FLAGS
-S, --screenOverComponentSuffix create a .screen.tsx rather than .component.tsx
-c, --addConstsFile add component.consts.ts
-d, --useDefaults create all available files
-g, --addGraphqlFile add component.graphql.ts
-p, --addPartsFolder add ./parts/ folder
-s, --addStylesFile add component.styles.ts
-t, --addTypesFile add component.types.ts
DESCRIPTION
generate components from templates
ALIASES
$ tkt-cli g
EXAMPLES
$ create-component g my-component
Generating component 'my-component'! (./src/commands/create-component/index.ts)
See code: dist/commands/generate/index.ts
tkt-cli help [COMMANDS]
Display help for tkt-cli.
USAGE
$ tkt-cli 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 tkt-cli.
See code: @oclif/plugin-help
tkt-cli plugins
List installed plugins.
USAGE
$ tkt-cli plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ tkt-cli plugins
See code: @oclif/plugin-plugins
tkt-cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ tkt-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
$ tkt-cli plugins add
EXAMPLES
$ tkt-cli plugins:install myplugin
$ tkt-cli plugins:install https://github.com/someuser/someplugin
$ tkt-cli plugins:install someuser/someplugin
tkt-cli plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ tkt-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
$ tkt-cli plugins:inspect myplugin
See code: @oclif/plugin-plugins
tkt-cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ tkt-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
$ tkt-cli plugins add
EXAMPLES
$ tkt-cli plugins:install myplugin
$ tkt-cli plugins:install https://github.com/someuser/someplugin
$ tkt-cli plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
tkt-cli plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ tkt-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
$ tkt-cli plugins:link myplugin
See code: @oclif/plugin-plugins
tkt-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ tkt-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
$ tkt-cli plugins unlink
$ tkt-cli plugins remove
tkt-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ tkt-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
$ tkt-cli plugins unlink
$ tkt-cli plugins remove
See code: @oclif/plugin-plugins
tkt-cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ tkt-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
$ tkt-cli plugins unlink
$ tkt-cli plugins remove
tkt-cli plugins update
Update installed plugins.
USAGE
$ tkt-cli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins