snakefmt: add page (#8733)

pull/1/head
Henrique Borges 2022-10-05 08:31:36 -03:00 committed by GitHub
parent 4751abf6c8
commit 16b2d486a4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 0 deletions

24
pages/common/snakefmt.md Normal file
View File

@ -0,0 +1,24 @@
# snakefmt
> Format Snakemake files.
> More information: <https://github.com/snakemake/snakefmt>.
- 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}}`