Skip to content

README.md

Latest commit

 

History

History
146 lines (114 loc) · 4.08 KB

README.md

File metadata and controls

146 lines (114 loc) · 4.08 KB

Commands Reference

Complete reference for all Shadowforge CLI commands.

Command Categories

Embedding & Extraction

  • embed - Embed secrets in carrier media
  • extract - Recover secrets from stego media

Analysis

  • analyze - Analyze capacity and security
  • validate - Verify stego media integrity

Archive Management

Advanced Features

  • watermark - Forensic watermarking
  • chain - Technique chaining
  • select - Intelligent cover media selection
  • scan - Analyze available media

Utilities

  • keygen - Generate encryption keys
  • formats - List supported media formats
  • version - Display version information
  • help - Show help information

Global Flags

All commands support these global flags:

--help, -h           Show help information
--verbose, -v        Enable verbose output
--log-level LEVEL    Set logging level (debug, info, warn, error)
--config FILE        Load configuration from file

Output Formats

Commands can output in multiple formats:

--output-format json    Output in JSON format
--output-format text    Output in human-readable text (default)
--output-format yaml    Output in YAML format

File Specifications

Input Files

Can be specified as:

  • Single file: --input file.txt
  • Multiple files (comma-separated): --input file1.txt,file2.txt,file3.txt
  • Glob pattern: --input "*.png" (quote patterns containing wildcards)
  • Directory: --input-dir /path/to/directory

Output

  • Single output: --output file.txt
  • Output directory: --output-dir /path/to/directory

Common Patterns

Quiet Mode

shadowforge embed --input secret.txt --cover image.png --output stego.png --quiet

JSON Output

shadowforge analyze capacity --input image.png --output-format json

Verbose Debugging

shadowforge embed --input secret.txt --cover image.png --output stego.png -vv --log-level debug

Command Index

Command Purpose Complexity
embed Basic embedding Beginner
extract Basic extraction Beginner
analyze capacity Check carrier capacity Beginner
archive create Bundle stego files Beginner
formats List supported types Beginner
validate Verify stego integrity Intermediate
select Auto-select carriers Intermediate
chain Multi-technique embedding Advanced
watermark Forensic tracking Advanced

Quick Examples

Basic embedding:

shadowforge embed --input secret.txt --cover image.png --output stego.png

Extract with integrity verification:

shadowforge extract --input stego.png --output secret.txt --verify

Distributed resilient embedding:

shadowforge embed \
  --input data.zip \
  --cover img1.png,img2.png,img3.png,img4.png,img5.png \
  --pattern 1:N \
  --threshold 3 \
  --output-dir distributed/

Archive stego files:

shadowforge archive create --input-dir ./stego-output --format tar.gz --output stegos.tar.gz

Scan media for capacity:

shadowforge scan ~/Pictures --min-capacity 100KB

Technique chaining:

shadowforge chain create --name "multi-technique" --techniques lsb,dct --weights 0.5,0.5
shadowforge chain execute --chain "multi-technique" --input secret.txt --cover image.png --output stego.png

Want details on a specific command? See the individual command pages: