dry-run Command

Cloney ≥ 1.0.0Cloney ≥ 0.1.0 < 1.0.0

The dry-run command is used for debugging purposes, allowing you to inspect the output generated by your Cloney Template Repository with the provided variables. This command helps you verify variable replacement and check for errors in the cloning process.

By default, this command searches for a file named .cloney-vars.yaml in your current directory for variable values. However, with the --variables flag you can specify a different file or pass the variables inline as YAML.

Flags

Flag	Description	Default Value
-r, --hot-reload	Enable hot reload mode.	false
-o, --output string	Specifies the path to output the filled template files.	"cloney-dry-run-results"
-i, --output-in-terminal	Outputs the filled template file contents in the terminal instead of creating the files.	false
-v, --variables string	Specifies the path to a template variables file or raw YAML.	".cloney-vars.yaml"

Example 1: Using Default Variables File

Run a dry-run on your local template repository using the default variables file, .cloney-vars.yaml:

cloney dry-run

Example 2: Using a Custom Variables File

Specify a different variables file (e.g., variables.yaml) for the dry-run:

cloney dry-run -v variables.yaml

Example 3: Inline Variables

Run a dry-run with inline variable values:

cloney dry-run -v '{ var1: value, var2: value }'

Example 4: Dry-run from Local Path

Run a dry-run on a template repository from a local path:

cloney dry-run ./path/to/my/template -v variables.yaml

Example 5: Hot Reload Mode

Run a dry-run on a template repository with hot reload mode enabled. This mode will watch for changes in the template repository and automatically re-run the dry-run command for you:

cloney dry-run -v variables.yaml -r

The dry-run command is used for debugging purposes, allowing you to inspect the output generated by your Cloney Template Repository with the provided variables. This command helps you verify variable replacement and check for errors in the cloning process.

By default, this command searches for a file named .cloney-vars.yaml in your current directory for variable values. However, with the --variables flag you can specify a different file or pass the variables inline as YAML.

Flags

Flag	Description	Default Value
-o, --output string	Specifies the path to output the filled template files.	"cloney-dry-run-results"
-i, --output-in-terminal	Outputs the filled template file contents in the terminal instead of creating the files.	false
-v, --variables string	Specifies the path to a template variables file or raw YAML.	".cloney-vars.yaml"

Example 1: Using Default Variables File

Run a dry-run on your local template repository using the default variables file, .cloney-vars.yaml:

cloney dry-run

Example 2: Using a Custom Variables File

Specify a different variables file (e.g., variables.yaml) for the dry-run:

cloney dry-run -v variables.yaml

Example 3: Inline Variables

Run a dry-run with inline variable values:

cloney dry-run -v '{ var1: value, var2: value }'

Example 4: Dry-run from Local Path

Run a dry-run on a template repository from a local path:

cloney dry-run ./path/to/my/template -v variables.yaml