Skip to content
vfs

Quick Start — Your First vfs Commands in 60 Seconds

Once installed, you can start scanning code immediately.

Find a function by name

Section titled “Find a function by name”
Terminal window
vfs . -f HandleLogin

Output:

internal/handlers/auth.go:23: func HandleLogin(w http.ResponseWriter, r *http.Request)

The -f flag is case-insensitive — searching for handlelogin, HANDLELOGIN, or HandleLogin all return the same results.

Scan specific directories

Section titled “Scan specific directories”
Terminal window
vfs ./internal ./pkg

List all signatures in a single file

Section titled “List all signatures in a single file”
Terminal window
vfs server.go

Show token savings stats

Section titled “Show token savings stats”
Terminal window
vfs . -f auth --stats

Appends a stats summary to stderr showing how many tokens vfs saved compared to reading the raw files.

Start the MCP server and dashboard

Section titled “Start the MCP server and dashboard”
Terminal window
vfs up          # start MCP + dashboard in background
vfs status      # check if running, show endpoints
vfs down        # stop the background server

Open the dashboard at http://localhost:3000 to see usage statistics and token savings over time.

Get help

Section titled “Get help”
Terminal window
vfs --help

What’s next?

Section titled “What’s next?”
  • AI Tools Setup — connect vfs to Cursor, Claude Code, Windsurf, and other AI editors
  • CLI Reference — full command documentation
  • Agent Rules — tell your AI agent to prefer vfs over grep