Fresh

Quick Start

Learn Fresh in 5 minutes

Get started with Fresh in just a few minutes. This guide covers the essential commands.

This guide assumes you have Fresh installed. If not, check the Installation guide first.

Your First Commands

1. List Documentation Pages

Discover what pages are available on a documentation site:

fresh list https://docs.python.org/3/

This will show all documentation pages found on the Python documentation site.

2. Fetch a Page as Markdown

Get a specific page and convert it to Markdown:

fresh get https://docs.python.org/3/tutorial/

The content will be displayed in your terminal. Use -o to save to a file:

fresh get https://docs.python.org/3/tutorial/ -o tutorial.md

3. Search Across Pages

Find specific content across all pages:

fresh search "virtual environment" https://docs.python.org/3/

4. Download for Offline Use

Sync an entire documentation site for offline reading:

fresh sync https://docs.python.org/3/

Once synced, you can search and read without internet using aliases!

Using Aliases

Aliases let you save frequently used documentation sites with short names.

Creating an Alias

fresh alias add python https://docs.python.org/3/
fresh alias add react https://react.dev/
fresh alias add rust https://doc.rust-lang.org/stable/

Using an Alias

# Instead of typing the full URL
fresh list python
fresh get react/
fresh search "hooks" react

Common Options

Most commands support these useful options:

OptionDescription
-v, --verboseShow detailed output
-h, --helpShow command help
--format jsonOutput as JSON

Next Steps

On this page