CLI Reference¶
Complete command-line interface documentation for PyForge CLI.
Quick Navigation¶
-
CLI Commands
Complete command reference with examples
-
Options Matrix
All options organized by converter type
-
Output Formats
Detailed information about output formats
Command Overview¶
PyForge CLI provides these main commands:
Command | Purpose | Example |
---|---|---|
convert |
Convert files between formats | pyforge convert file.pdf |
info |
Display file information | pyforge info file.xlsx |
validate |
Validate file compatibility | pyforge validate file.mdb |
formats |
List supported formats | pyforge formats |
Global Options¶
These options work with all commands:
Option | Description | Example |
---|---|---|
--help |
Show help message | pyforge --help |
--version |
Show version information | pyforge --version |
--verbose |
Enable verbose output | pyforge convert file.pdf --verbose |
Quick Reference Card¶
Basic Conversions¶
# PDF to Text
pyforge convert document.pdf
# Excel to Parquet
pyforge convert spreadsheet.xlsx
# Access Database to Parquet
pyforge convert database.mdb
# DBF to Parquet
pyforge convert legacy.dbf
File Information¶
# Get file details
pyforge info filename.ext
# Validate file
pyforge validate filename.ext
# List supported formats
pyforge formats
Common Options¶
# With custom output
pyforge convert input.pdf output.txt
# Force overwrite
pyforge convert input.xlsx --force
# Verbose mode
pyforge convert input.mdb --verbose
Command Structure¶
All PyForge CLI commands follow this structure:
Where:
- <command>
: One of convert, info, validate, formats
- <input_file>
: Path to input file (required for most commands)
- [output_file]
: Optional output file path
- [options]
: Command-specific options
Next Steps¶
- CLI Reference - Detailed command documentation
- Options Matrix - All options by converter
- Output Formats - Output format specifications