Command-line interface

Note

This section is scaffolded. Migrate the CLI reference from the repo-root README.md → ## Usage, ## Subcommands, and ## Flags sections here in a follow-up PR. The Sphinx build already runs green over this stub.

See also

The canonical CLI reference today lives in README.md. See the Indices for autogenerated symbols once the api/ layer lands.

Quick start

# Install (PyPI distribution name is stegx-cli; Python import name is stegx)
pip install stegx-cli

# Encode — password prompted at TTY
stegx encode -i cover.png -f secret.zip -o out.png

# Decode — payload piped to stdout
stegx decode -i out.png --stdout | sha256sum

Top-level subcommands

Subcommand	Purpose
encode	Embed a file into a PNG cover
decode	Extract a file (or pipe to --stdout)
rewrap	Rotate password / keyfile / YubiKey on an existing stego
shamir-split	Split a secret across N covers under a k-of-N quorum
shamir-combine	Reconstruct a secret from ≥ k covers
pick-cover	Rank covers in a directory by (capacity, entropy)
benchmark	Timing harness for encode / decode / compression