Quick Start

Get Running in 5 Minutes

This guide gets you from zero to your first indexed note in under 5 minutes.

Step 1: Install Strayfiles

Download and install from our download page:

1. Download the .dmg file
2. Drag Strayfiles to Applications
3. Launch from Applications

Step 2: Create Your First Config

Create a strayfiles.toml file in any folder you want to index:

version = 1

[settings]
roots = ["./"]
exclude = ["node_modules/**", ".git/**"]

This tells Strayfiles to index all Markdown files in that folder.

Step 3: Add Your First Note

Create a Markdown file with Strayfiles frontmatter:

---
strayfiles:
  enabled: true
---

# My First Note

This note is now tracked by Strayfiles!

Step 4: View in Strayfiles

Open Strayfiles and navigate to the folder containing your config. You should see your note indexed and ready to edit.

What’s Next?

• Core Concepts - Understand how Strayfiles works
• Frontmatter Guide - Learn all frontmatter options
• TOML Configuration - Advanced config options

Quick Tips

Index existing files without modification:

Set explicit_only = false in your config to index all Markdown files without requiring frontmatter:

[settings]
explicit_only = false
roots = ["./notes", "./docs"]

Use glob patterns:

Target specific files across your filesystem:

[settings]
roots = ["**/CLAUDE.md", "**/README.md"]

Organize with workspaces:

Group notes virtually without moving files:

[workspaces.projects]
include = ["projects/**"]

[workspaces.docs]
include = ["**/docs/**", "**/README.md"]