diff --git a/pages/common/snakefmt.md b/pages/common/snakefmt.md new file mode 100644 index 000000000..89e1cfa7d --- /dev/null +++ b/pages/common/snakefmt.md @@ -0,0 +1,24 @@ +# snakefmt + +> Format Snakemake files. +> More information: . + +- Format a specific Snakefile: + +`snakefmt {{path/to/snakefile}}` + +- Format all Snakefiles recursively in a specific directory: + +`snakefmt {{path/to/directory}}` + +- Format a file using a specific configuration file: + +`snakefmt --config {{path/to/config.toml}} {{path/to/snakefile}}` + +- Format a file using a specific maximum line length: + +`snakefmt --line-length {{100}} {{path/to/snakefile}}` + +- Display the changes that would be performed without performing them (dry-run): + +`snakefmt --diff {{path/to/snakefile}}`