Name | Type | Required | Default | Hint |
path | globber | true | Path of file or globbing pattern to create checksum of | |
algorithm | string | false | md5 | Hashing algorithm to use |
extension | string | false | File extension to write. Using this sets write to true. | |
format | string | false | checksum | Format to write hash in. checksum, md5sum, or sfv |
verify | string | false | A hash to verify to a file. Error will be thrown if checksums don't match. | |
write | boolean | false | false | Set true to write checksum to a file instead of outputting to console |
Generate checksum for a file or a directory via a globbing pattern.
Default is MD5, but SHA-1, SHA-256, and SHA-512 can also be used.
checksum file.txtCreate a checksum for more than one file in a directory with a file globbing pattern
checksum build.zip SHA-256
checksum path=*.zipWrite checksum(s) to a file named after the original file plus a new extension.
checksum myFile.zip md5 --writeControl the file extension like so. (--write is optional when supplying an extension)
checksum path=myFile.zip extension=hash --writeControl the format of the hash with the "format" parameter.
- "checksum" (default) -- just the hashVerify a file against an existing hash. Error will be thrown if checksums are different
- "md5sum" -- The format of GNU textutils md5sum
- "sfv" -- The format of BSDs md5 command
checksum path=myFile.zip verify=2A95F32028087699CCBEB09AFDA0348C