tl-utils
v0.4.2
Published
A set of command-line utilities for the TrustLayer Platform
Downloads
7
Readme
tl-utils
A set of command-line utilities for the TrustLayer Platform
Usage
$ npm install -g tl-utils
$ tl-utils COMMAND
running command...
$ tl-utils (--version)
tl-utils/0.4.2 darwin-arm64 node-v22.5.1
$ tl-utils --help [COMMAND]
USAGE
$ tl-utils COMMAND
...
Commands
tl-utils hello PERSON
tl-utils help [COMMAND]
tl-utils plugins
tl-utils plugins add PLUGIN
tl-utils plugins:inspect PLUGIN...
tl-utils plugins install PLUGIN
tl-utils plugins link PATH
tl-utils plugins remove [PLUGIN]
tl-utils plugins reset
tl-utils plugins uninstall [PLUGIN]
tl-utils plugins unlink [PLUGIN]
tl-utils plugins update
tl-utils tenant
tl-utils tenant clone
tl-utils tenant delete
tl-utils hello PERSON
Say hello
USAGE
$ tl-utils hello PERSON -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Who is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ tl-utils hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
See code: src/commands/hello/index.ts
tl-utils help [COMMAND]
Display help for tl-utils.
USAGE
$ tl-utils 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 tl-utils.
See code: @oclif/plugin-help
tl-utils plugins
List installed plugins.
USAGE
$ tl-utils plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ tl-utils plugins
See code: @oclif/plugin-plugins
tl-utils plugins add PLUGIN
Installs a plugin into tl-utils.
USAGE
$ tl-utils 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 tl-utils.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the TL_UTILS_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the TL_UTILS_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ tl-utils plugins add
EXAMPLES
Install a plugin from npm registry.
$ tl-utils plugins add myplugin
Install a plugin from a github url.
$ tl-utils plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ tl-utils plugins add someuser/someplugin
tl-utils plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ tl-utils 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
$ tl-utils plugins inspect myplugin
See code: @oclif/plugin-plugins
tl-utils plugins install PLUGIN
Installs a plugin into tl-utils.
USAGE
$ tl-utils 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 tl-utils.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the TL_UTILS_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the TL_UTILS_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ tl-utils plugins add
EXAMPLES
Install a plugin from npm registry.
$ tl-utils plugins install myplugin
Install a plugin from a github url.
$ tl-utils plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ tl-utils plugins install someuser/someplugin
See code: @oclif/plugin-plugins
tl-utils plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ tl-utils 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
$ tl-utils plugins link myplugin
See code: @oclif/plugin-plugins
tl-utils plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ tl-utils 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
$ tl-utils plugins unlink
$ tl-utils plugins remove
EXAMPLES
$ tl-utils plugins remove myplugin
tl-utils plugins reset
Remove all user-installed and linked plugins.
USAGE
$ tl-utils 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
tl-utils plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ tl-utils 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
$ tl-utils plugins unlink
$ tl-utils plugins remove
EXAMPLES
$ tl-utils plugins uninstall myplugin
See code: @oclif/plugin-plugins
tl-utils plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ tl-utils 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
$ tl-utils plugins unlink
$ tl-utils plugins remove
EXAMPLES
$ tl-utils plugins unlink myplugin
tl-utils plugins update
Update installed plugins.
USAGE
$ tl-utils plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
tl-utils tenant
Admin commands to manage tenants of the TrustLayer Platform.
USAGE
$ tl-utils tenant
DESCRIPTION
Admin commands to manage tenants of the TrustLayer Platform.
See code: src/commands/tenant/index.ts
tl-utils tenant clone
Clones a tenant, remapping IDs in case source and target DB coincide.
USAGE
$ tl-utils tenant clone -i <value> -s <value> -t <value> [-c <value>] [-k <value>] [-b <value>] [-p <value>...]
FLAGS
-b, --batchSize=<value> [default: 100] Size of the batch for bulk writes
-c, --tenantCollection=<value> [default: Organization] Name of the collection containing all tenants
-i, --tenantId=<value> (required) ID of the tenant that will be cloned.
-k, --tenantKey=<value> [default: organization] Tenant key referencing the tenant by its ID
-p, --skipCollections=<value>... Collections to skip. Pass multiple collections separated by comma.
-s, --sourceMongoURI=<value> (required) Mongo URI for the DB containing the data that will be cloned.
-t, --targetMongoURI=<value> (required) Mongo URI for the DB that will contain the cloned tenant.
DESCRIPTION
Clones a tenant, remapping IDs in case source and target DB coincide.
See code: src/commands/tenant/clone.ts
tl-utils tenant delete
Deletes a tenant.
USAGE
$ tl-utils tenant delete -i <value> -t <value> [-c <value>] [-k <value>]
FLAGS
-c, --tenantCollection=<value> [default: Organization] Name of the collection containing all tenants
-i, --tenantId=<value> (required) ID of the tenant to delete.
-k, --tenantKey=<value> [default: organization] Tenant key referencing the tenant by its ID
-t, --targetMongoURI=<value> (required) Mongo URI for the DB that contains the tenant to delete.
DESCRIPTION
Deletes a tenant.
See code: src/commands/tenant/delete.ts