Command-line interface# deploy-tools is driven entirely through its command-line interface. deploy-tools# deploy-tools Usage: deploy-tools [OPTIONS] COMMAND [ARGS]... ╭─ Options ─────────────────────────────────────────────────────╮ │--version-VShow program's version number│ │and exit. │ │--install-completionInstall completion for the │ │current shell. │ │--show-completionShow completion for the │ │current shell, to copy it or │ │customize the installation. │ │--helpShow this message and exit.│ ╰───────────────────────────────────────────────────────────────╯ ╭─ Commands ────────────────────────────────────────────────────╮ │sync Synchronise deployment root with current │ │configuration. │ │validateValidate deployment configuration and print a list │ │of expected module changes. │ │compare Compare the deployment snapshot to deployed modules│ │in the deployment root. │ │schema Generate JSON schemas for yaml configuration files.│ ╰───────────────────────────────────────────────────────────────╯ sync# sync Usage: deploy-tools sync [OPTIONS] {deployment_root} {config_folder} Synchronise deployment root with current configuration. This will also run the validate command beforehand, but without printing the expected changes. A git repository is created in the deployment area to help track changes, but as we do not want to include large files it should not be used to revert the state of the deployment area. ╭─ Arguments ───────────────────────────────────────────────────╮ │*deployment_root<directory>Root of the deployment│ │area to use. │ │[required] │ │*config_folder <directory>Folder containing │ │configuration for │ │deployment. │ │[required] │ ╰───────────────────────────────────────────────────────────────╯ ╭─ Options ─────────────────────────────────────────────────────╮ │--allow-allAllow all │ │lifecycle │ │transitions. This │ │still requires the│ │deployment area to│ │be in a healthy │ │state. │ │[default: (False)]│ │--from-scratchDeploy into an │ │empty deployment │ │area. │ │[default: (False)]│ │--verbose-v<int range> Set verbosity │ │[x<=2]level by passing │ │option multiple │ │times. │ │[default: │ │(WARNING)] │ │--helpShow this message │ │and exit. │ ╰───────────────────────────────────────────────────────────────╯ validate# validate Usage: deploy-tools validate [OPTIONS] {deployment_root} {config_folder} Validate deployment configuration and print a list of expected module changes. If specified, this includes a test build of the provided configuration. The configuration validation is the same as used by the deploy-tools sync command. ╭─ Arguments ───────────────────────────────────────────────────╮ │*deployment_root<directory>Root of the deployment│ │area to use. │ │[required] │ │*config_folder <directory>Folder containing │ │configuration for │ │deployment. │ │[required] │ ╰───────────────────────────────────────────────────────────────╯ ╭─ Options ─────────────────────────────────────────────────────╮ │--from-scratchDeploy into an │ │empty deployment │ │area. │ │[default: (False)]│ │--allow-allAllow all │ │lifecycle │ │transitions. This │ │still requires the│ │deployment area to│ │be in a healthy │ │state. │ │[default: (False)]│ │--test-buildTest the build in │ │a temporary │ │directory. │ │[default: (False)]│ │--verbose-v<int range> Set verbosity │ │[x<=2]level by passing │ │option multiple │ │times. │ │[default: │ │(WARNING)] │ │--helpShow this message │ │and exit. │ ╰───────────────────────────────────────────────────────────────╯ compare# compare Usage: deploy-tools compare [OPTIONS] {deployment_root} Compare the deployment snapshot to deployed modules in the deployment root. This allows us to identify any discrepancies. If there was an error during the deploy step, we can use this function to determine any required steps for fixing files in the deployment root. ╭─ Arguments ───────────────────────────────────────────────────╮ │*deployment_root<directory>Root of the deployment│ │area to use. │ │[required] │ ╰───────────────────────────────────────────────────────────────╯ ╭─ Options ─────────────────────────────────────────────────────╮ │--use-ref<str>Use deployment │ │area git ref for │ │comparison. │ │--from-scratchDeploy into an │ │empty deployment │ │area. │ │[default: (False)]│ │--verbose-v<int range> Set verbosity │ │[x<=2]level by passing │ │option multiple │ │times. │ │[default: │ │(WARNING)] │ │--helpShow this message │ │and exit. │ ╰───────────────────────────────────────────────────────────────╯ schema# schema Usage: deploy-tools schema [OPTIONS] {output_path} Generate JSON schemas for yaml configuration files. ╭─ Arguments ───────────────────────────────────────────────────╮ │*output_path<directory>Output path to write all │ │.json schema files to. │ │[required] │ ╰───────────────────────────────────────────────────────────────╯ ╭─ Options ─────────────────────────────────────────────────────╮ │--verbose-v<int range> [x<=2]Set verbosity level by│ │passing option │ │multiple times. │ │[default: (WARNING)] │ │--helpShow this message and │ │exit. │ ╰───────────────────────────────────────────────────────────────╯
