Package Exports

@tangelo/tangelo-configuration-toolkit

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@tangelo/tangelo-configuration-toolkit) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

tangelo-configuration-toolkit

Tangelo Configuration Toolkit is a command-line toolkit which offers support for developing a Tangelo configuration.

Installation

The toolkit requires NPM on Node.js® version 12.14.1 or higher. An active or maintenance LTS release is recommended. After installing Node.js, you can install the latest version of the Tangelo Configuration Toolkit globally on your system using the following command:

npm i -g @tangelo/tangelo-configuration-toolkit

Usage

Get help for the available commands and see version:

tangelo-configuration-toolkit

Get help for a specific command, detailing all its arguments:

tangelo-configuration-toolkit <command>

Use the tct shorthand instead of tangelo-configuration-toolkit:

tct <command>

Config

The deploy command requires server connection information. So you'll have to create a configuration file named tangelo-configuration-toolkit-config.json in which such information can be stored. This file will be searched for in an ancestor directory of the current working directory.

The contents looks like this (all properties are optional):

{
  "sharedConfigPath": "absolute/or/relative/path/to/folder/containing/shared/config",
  "servers": [{
    "config": {
      "port": 22,
      "parallel": 4,
      "username": "username",
      "remotedir": "/absolute/path/to/tangelo/config/folder/on/server"
    },
    "domains": ["domain.name.com"],
    "name": "name-for-local-deploy"
  }],
  "serverDefaults": {
    "config": {
      ...
    }
  }
  "defaultServer": "can be set to the name of e.g. your favorite dev server"
}

When passing a server name, tct will look for a full match with a name or a partial match (the start) with a domain.