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_WITH_SELF_SIGNED_CERTIFICATE | If your certificates are self-signed you can enable this option. DONT USE IT FOR PRODUCTION, ONLY DEVELOP ENVIRONMENTS | true | | D5_KEYS_DIR | Directory where JWK keys are stored. Set automatically by generate-jwk in .env.local. | /Users/me/keys |

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 | | --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 | | --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

generate-jwk

The generate-jwk command generates JWK key pairs, including both private and public keys. During execution you can choose a custom directory for saving keys. The selected directory is persisted to .env.local with the D5_KEYS_DIR variable and used on subsequent runs.

If a saved directory is present, it is used as the default path. Otherwise the command falls back to the standard d5_keys directory in the user's home folder.

npx d5-cli generate-jwk

Path format

When you are asked to enter the directory, you can use:

| Format | Example | Resolves to | |-------------------|--------------------|-------------------------------------| | Absolute | /Users/me/keys | exactly that path | | Home-relative | ~/keys | <home>/keys | | Project-relative | ./keys or keys | <cwd>/keys (at the time of input) |

The chosen path is resolved to an absolute path and saved to .env.local as D5_KEYS_DIR=..., so subsequent runs (and deploy / export) pick up the same directory regardless of cwd.

If the chosen directory is located inside a git repository, a .gitignore is created in it automatically (with * and !.gitignore) so private keys cannot be accidentally committed. An existing .gitignore in that directory is left untouched.

init-app

Initializes the application with basic settings

npx d5-cli init-app

log

Fetches log entries by ResponseID from the server and saves them to a local file

The log is saved to logs/<ResponseID>.log in the current working directory.
The logs/ directory is created automatically if it does not exist.

| Аргумент | Описання | |--------------|---------------------------------| | <responseId> | ResponseID of the request to fetch logs for |

Usage

npx d5-cli log "0406ca0850f7be234f499fb295b9974cae09"