@opentext/otts-cli
v1.0.1
Published
The otts npm module is used to upload and submit a project (JavaScript Application) as a module to TeamSite.
Downloads
4
Readme
OTTS CLI
OTTS CLI is command line tool to import a custom-developed application or component to OpenText TeamSite, as a TeamSite Module. Note: This package is only compatible with OpenText TeamSite 23.2 and later.
Prerequisites
- Node.js version 16 or later
- OpenText TeamSite 23.2 or later
Installation
OpenText recommends that you install this package globally.
npm i -g @opentext/otts-cli
Note: The module_system_config.json
file will be created after the npm module has been installed.
Installation without an NPM registry
- Clone this repository
- Run the following command:
npm install <cloned repository root directory>
Usage
# Prints general usage instructions
> otts --help
> otts -h
# Prints usage instructions for module-import subcommand
> otts module-import --help
> otts module-import -h
# Imports the project into TeamSite as a TeamSite module
# See configuration section below
> otts module-import -u <username> -p <password>
CLI Configuration
When importing your project to TeamSite, OpenText recommends using the module_system_config.json
manifest to define the configurable import parameters. This should be located in the root directory of your project.
| Parameter | Description | Required? | Default Value |
|----------:|---------------|-----------|---------------|
| name | Name of the TeamSite Module (Note: This can also be set in iw_module_config.json in the project root) | Yes | N/A |
| builddir | Build directory of your project | Yes | N/A |
| tsurl | Base URL of the TeamSite server | Yes | N/A |
| destdir | TeamSite destination directory, relative to the Module root directory | No | / |
| autosubmit | Submit Module after importing ("true" or "false") | No | false |