Fresh

fresh sync

Download entire documentation for offline use

The sync command downloads an entire documentation site for offline reading.

Usage

fresh sync <URL> [OPTIONS]

Examples

# Sync Python documentation
fresh sync https://docs.python.org/3/

# Sync to custom directory
fresh sync https://docs.python.org/3/ --output-dir ./docs

# Force re-sync (delete existing first)
fresh sync https://docs.python.org/3/ --force

# Limit pages and depth
fresh sync https://docs.python.org/3/ --max-pages 50 --depth 2

Options

OptionShortDescription
--output-dir-oTarget directory for synced docs
--verbose-vUse verbose output
--max-pages-Maximum pages to sync (default: 100)
--depth-dMaximum crawl depth (default: 3)
--force-fForce re-sync (delete existing first)
--pattern-pFilter paths matching pattern

Output Location

Synced documentation is stored in ~/.fresh/docs/ by default, or in your specified --output-dir.

~/.fresh/docs/
└── docs.python.org/
    └── 3/
        ├── index.html
        ├── tutorial/
        └── library/

Reading Offline

After syncing, you can search and read without internet:

# Search in synced docs
fresh search "virtual environment" python

# List synced pages
fresh list python

On this page