Development & Commands Overview

Solution CLI Development Flow

The usual develoment flow consists of several steps performed by different Solution CLI commands

Solution CLI Commands

The following commands are available in the Solution CLI:


Command	Description
fss clone	Cloning a solution that was modeled in the Solution Designer of the current setup stage to the local file system. It requires two parameters: the solution which consists of the group key and the solution acronym, and the Git provider alias. Command Options `-s, --solution <solution>` The identifier of the solution we want to clone (containing the repository group key and repository slug) `-p, --provider-alias <provider>` Alias of the Git provider in which the solution repository resides `-S, --stage <stage>` The stage name
fss compile	Compile project files.
fss help	Displays the documentation.
fss install	Install/update dependencies.
fss lint	To check project files for linting errors. Currently only available for TypeScript low-code solutions!
fss login-envoy	Used to login to Solution Envoy environment for debug / test support. It will ask for the Solution Envoy credentials. Command Options `-u, --username <username>` Username for login. Alternative: ENV var "FSS_CLI_LOGIN_ENVOY_USERNAME" `-p, --password <password>` Password for login. Alternative: ENV var "FSS_CLI_LOGIN_ENVOY_PASSWORD" `-S, --stage <stage>` Stage name. Alternative: ENV var "FSS_CLI_LOGIN_ENVOY_STAGE" Currently only available for TypeScript low-code solutions!
fss login	It will ask for the same credentials as the Solution Designer, the login is usually valid for a longer period, as defined by your company policies. Command Options `-u, --username <username>` Username for login. Alternative: ENV var "FSS_CLI_LOGIN_USERNAME" `-p, --password <password>` Password for login. Alternative: ENV var "FSS_CLI_LOGIN_PASSWORD" `-S, --stage <stage>` Stage name. Alternative: ENV var "FSS_CLI_LOGIN_STAGE"
fss prepare-debug	Used to prepare debug sessions against the configured Solution Envoy environment. It will ask for the Solution Envoy credentials. Currently only available for TypeScript low-code solutions!
fss pull	Pull in the latest changes of the current branch from the Git repository you are currently on.
fss push	Add, commit and push changes to the Git repository Command Options `-m, --message <message>` Commit message. `-f, --force` Forcefully skip validation step. Be careful! Default is `false`
fss setup-envoy	Setup the Solution CLI to work with a Solution Envoy environment installation. Command Options `-s, --string <string>` Solution Envoy setup string `-f, --file <file>` Path to the Solution Envoy setup file `-n, --no-interactive` Skip interactive functionality like prompts. Default is `false` Currently only available for TypeScript low-code solutions!
fss setup	Used to setup the Solution CLI to work with a Solution Designer installation. It takes all configuration as a base64 encoded string. Command Options `-s, --string <string>` Solution Designer setup string `-f, --file <file>` Path to the Solution Designer setup file `-n, --no-interactive` Skip interactive functionality like prompts. Default is `false`
fss test	Run unit tests and integration tests within this solution. Currently only the unit tests are supported for Java solutions!
fss upgrade-framework	Automatically migrates implementation code from an older framework version to a new one.
fss upgrade-cli	Upgrade the Solution CLI to the latest version.
fss version	Displays the current version of the Solution CLI.

Attention: By using --help or -h after a command you will get detailed information on the expected syntax.