d5-cli

Does default operations such as zip, export and deploy

Environment variables

Below is the documentation for the environment variables defined in the .env file. These variables are used to configure and control various aspects of the application.

[!CAUTION] Attention! Do not leave your login credentials in the .env file, as it is not secure! Use .env.local for this purpose instead, this file is in .gitignore.

| Параметр | Описание | Пример | |---------------------|-----------------------------------------------------------------------------------------------|-------------------------------------------| | JS_DEBUG_KEY | Debug token (optional). | dubug_token | | DEPLOY_HOSTS | List of hosts where the deployment will take place. Hosts are separated by a semicolon (;). | https://example.com;https://google.com; | | DEPLOY_USER | Username used during deployment. | user | | DEPLOY_PASSWORD | Password used during deployment. | password | | DEPLOY_UPLOAD_KEY | Token used for authorization during deployment. | secret_token |

Commands

deploy

Deploys zip archives to the server

| Команда | Описание | |------------------------------------|--------------------------| | -с, --client | deploy client scripts | | -r, --resources | deploy resources | | -s, --server | deploy server scripts | | -f, --forms | deploy forms | | -o, --objects | deploy objects | | -d, --debug | deploy in own scope | | --functions | deploy app functions | | --subsystems | deploy subsystems | | --uploadOperation | specify upload operation | | -initial-script, --initialScript | deploy initial script |

Usage

# deploys only client and server zips to the server
npx d5-cli deploy -c -r

# deploys all zips in your own scope specified in JS_DEBUG_KEY
npx d5-cli deploy -d

export

Fetch forms and objects from the server and save them to JSON files

| Команда | Описание | |-------------------|----------------------------------------------------| | -с, --client | export config | | -r, --resources | fetch forms | | -s, --server | export objects | | -p, --partial | applies filter from the config file | | -r, --remove | removing outdated objects and forms before export | | --functions | export app functions | | --subsystems | export subsystems |

Usage

# exports forms and objects to json files
npx d5-cli export -f -o

# exports only forms that satisfied filter from export.config.json
npx d5-cli export -f -p

zip

Creates zip archives from scrips, resources and dump

| Команда | Описание | |------------------------------------|----------------------------------| | -с, --client | zip client scripts and resources | | -s, --server | zip server scripts | | -f, --forms | zip forms | | -o, --objects | zip objects | | --functions | zip functions | | --subsystems | zip subsystems | | -initial-script, --initialScript | zip initial script |

Usage

# zips forms and objects json files
npx d5-cli zip -f -o

zip-engine

Creates zip archive for engine

Usage

npx d5-cli zip-engine

deploy-engine

Deploys engine zip to the server

| Команда | Описание | |---------------|---------------------| | -d, --debug | deploy in own scope |

Usage

npx d5-cli deploy-engine -d