Skip to content

Quick Start

This guide gets you from zero to searching your data in under 5 minutes.

The Fast Path

  1. Install Hoard

    Terminal window
    pipx install hoard
  2. Run the Setup Wizard

    Terminal window
    hoard init
  3. Start Searching

    Terminal window
    hoard search "meeting notes"

For the best experience, follow this order:

Terminal window
# 1. Initialize (configures sources, runs first sync)
hoard init
# 2. Start the HTTP server (required for AI tools)
hoard serve
# 3. Configure detected AI tools
hoard setup --all

For remote servers, use:

Terminal window
hoard setup remote --url https://hoard.example.com --token hoard_sk_... --all

Manual Setup (Alternative)

Terminal window
hoard init --quick
hoard add ~/Documents/Notes
hoard sync
hoard search "query"

What Gets Indexed by Default

File TypeExtension
Markdown.md
Plain text.txt
CSV.csv
JSON.json
YAML.yaml
reStructuredText.rst

Next Steps