CLI Reference

Complete command-line interface reference for checkle.

Synopsis

checkle [OPTIONS] <COMMAND>

Global Options

OptionShortDescription
--verbose-vIncrease verbosity (use multiple times)
--quiet-qSuppress non-essential output
--versionDisplay version
--help-hShow help

Commands

checkle hash

Generate checksums for files.

checkle hash [OPTIONS] <FILE_OR_DIR>

Arguments

  • <FILE_OR_DIR> - File, directory, or archive path to hash

Options

OptionDefaultDescription
--algo <ALGORITHM>md5Hash algorithm (md5, sha256)
--recursivefalseProcess directories recursively
--output <FILE>-Output file for checksums
--format <FORMAT>textOutput format (text, json, csv)
--prettyfalseDisplay formatted table
--per-filefalseCreate individual checksum files
--include <PATTERN>-Include only matching files
--exclude <PATTERN>-Exclude matching files
--no-ignorefalseDon't respect .gitignore
--parallel-readers <N>autoParallel reader threads
--chunk-size-kb <SIZE>1024Chunk size in KB
--max-files-batch <N>1000Maximum files per batch
--absolute-pathsfalseUse absolute paths
--no-progressfalseDisable progress bars

checkle verify

Verify file against known hash.

checkle verify [OPTIONS] <FILE> --hash <HASH>

Arguments

  • <FILE> - File to verify

Options

OptionDefaultDescription
--hash <HASH>requiredExpected hash value
--algo <ALGORITHM>md5Hash algorithm
--chunk-size-kb <SIZE>1024Chunk size in KB
--parallel-readers <N>autoParallel reader threads
--no-progressfalseDisable progress bar

checkle verify-many

Verify multiple files from checksum file.

checkle verify-many [OPTIONS] --checksum-file <FILE>

Options

OptionDefaultDescription
--checksum-file <FILE>requiredFile containing checksums
--base-dir <DIR>.Base directory for paths
--algo <ALGORITHM>md5Hash algorithm
--fail-fastfalseStop on first failure
--quietfalseOnly show failures
--prettyfalseDisplay formatted table
--parallel-files <N>4Files to verify in parallel
--chunk-size-kb <SIZE>1024Chunk size in KB
--failed-onlyfalseShow only failures
--no-progressfalseDisable progress bars

Archive Path Syntax

archive.tar:internal/path/file.txt

Special patterns:

  • :* - All files in archive
  • :*.ext - Files matching pattern
  • :dir/* - All files in directory

Exit Codes

CodeMeaning
0Success
1General error
2Verification failure
3File not found
4Invalid arguments
5I/O error

Environment Variables

No environment variables are used directly. Shell aliases can customize defaults:

alias checkle='checkle --algo sha256'

File Formats

Checksum File Format (text)

<hash>  <filepath>

Example:

d41d8cd98f00b204e9800998ecf8427e  file1.txt
e3b0c44298fc1c149afbf4c8996fb924  file2.txt

JSON Format

[
  {
    "hash": "d41d8cd98f00b204e9800998ecf8427e",
    "filepath": "file1.txt"
  }
]

CSV Format

hash,filepath
d41d8cd98f00b204e9800998ecf8427e,file1.txt