Super-Simple Includes Documentation

v0.244.0

CLI Messages

See Errors & Warnings Catalog for the full index, and Errors & Warnings Guide for a narrative explanation of message categories, exit codes, and common fixes.

Messages from command-line argument parsing and subcommand dispatch.

Message Exit Code Hint
CLI flag [option] requires a value but none was provided: [error message]
โŒ '--[option]' is specific to the '[command]' command 2 ๐Ÿ’ก Place it after the subcommand: ssi [command] --[option] ...
โŒ Cannot use --[name] and --[option] together 2 ๐Ÿ’ก Provide at most one of these flags
โŒ Cannot use --verbose and --quiet together 2 ๐Ÿ’ก Use --verbose for more output, or --quiet for less
โŒ `auto` is no longer a valid copy method 2 ๐Ÿ’ก Use `copy` instead โ€” it uses reflink with automatic byte-copy fallback, which was what `auto` selected
โŒ Deployment symlink already exists: [path] 1 ๐Ÿ’ก Remove the existing symlink first or use a different link path
โŒ Directory already exists: [path] 2 ๐Ÿ’ก Choose a different directory name, or remove the existing directory first
โŒ Directory already exists and is not empty: [path] 1 ๐Ÿ’ก Use a different directory or remove existing contents
๐Ÿงช Dry run completed for [command] - no files modified
๐Ÿงช Dry run for [operation]: completed successfully
A FatalError was constructed with a MessageId that has no exit_code configured โ€” every fatal message must declare an exit_code in messages.toml (programming error)
Help display failed for no-args case: [error message]
โŒ Invalid value for [option] `[name]`: [error message] 2 ๐Ÿ’ก Enter a value that matches the flag's documented type โ€” run `ssi --help` or `ssi --help` for allowed forms
โŒ unrecognized variant 2
โŒ Missing required argument: [name] 2 ๐Ÿ’ก Run `ssi [command] --help` to see usage
โŒ Cannot create site โ€” path exists but is not a directory: [path] 2 ๐Ÿ’ก Remove or rename the file or other entry blocking that path, or choose a different directory
โŒ No command specified 2 ๐Ÿ’ก Run `ssi help` to see available commands
โŒ Symlink name must be a single filename component, not a path: [path] 2 ๐Ÿ’ก Specify just the filename (e.g., 'prod'), not a path with separators (e.g., 'subdir/prod')
โŒ Destination '-' (stdout) requires --single-file 2 ๐Ÿ’ก Use: ssi deploy --single-file <file> <source> -
Stdout flush failed: [I/O error message]
โŒ File not found in any page step: [path] 2 ๐Ÿ’ก The path must be relative to the source directory and belong to a page step
โŒ Failed to write output to stdout 1 ๐Ÿ’ก If piping output, check the receiving command completed successfully
Stdout write_all failed: [I/O error message]
โŒ SOURCE must be a directory, not a file 2 ๐Ÿ’ก Use the directory containing ssi-config.toml ๐Ÿ’ก Or use --config for custom config files
โŒ --suffix-length=[length] ignored when using --suffix=timestamp 2 ๐Ÿ’ก --suffix-length only applies to random suffixes โ€” remove it or use a different --suffix mode
โŒ Suffix length [current] is above the maximum ([max]) 2
โŒ Not a valid number for --suffix-length: [error message] 2
โŒ Suffix length cannot be 0; use 1 through [max] 2
โŒ Too many arguments for '[command]' command 2 ๐Ÿ’ก Run `ssi [command] --help` to see usage
โŒ --trace-tokens requires --single-file 2 ๐Ÿ’ก Use: ssi deploy --single-file <file> <source> <dest> --trace-tokens
โŒ Unknown flag: [name] 2 ๐Ÿ’ก Run `ssi --help` to see available options
โŒ Unknown command: [name] 2 ๐Ÿ’ก Run `ssi --help` to see available commands
โŒ 1 ๐Ÿ’ก Review the errors above and fix them in your source files or ssi-config.toml