Documentation

QuickFind

Terminal utility for instant directory bookmarking

Overview

A lightweight terminal utility for bookmarking directories and jumping to them instantly. Navigate large codebases and complex folder structures with single commands.

Features

  • Save directory bookmarks with short aliases
  • Jump to bookmarked directories from anywhere
  • Cross-session persistence (survives terminal restarts)
  • Shell-agnostic implementation
  • Lightweight—single compiled binary
  • Zero background processes or daemons
  • Perfect for large codebases and monorepos
  • Instant path resolution with minimal overhead

Architecture

Lightweight and Simple:

  • CLI: quickfind binary with subcommands (init, rmv, list, cd)
  • Shell Integration: qfcd() function enables seamless directory jumping
  • Data Storage: Local file at ~/.quickfind
  • System Integration: Profile script at /etc/profile.d/qfcd.sh for automatic loading
  • Cross-Shell: Works with all POSIX-compatible shells (bash, zsh, sh, ksh, fish)

Installation

# Via Homebrew (recommended)
brew tap Aditya-Baindur/homebrew-quickfind
brew install quickfind

# Or manually
git clone https://github.com/Aditya-Baindur/quickFind
cd quickFind
make install

Then source the profile script:

source /etc/profile.d/qfcd.sh

Usage

# Save current directory as 'project'
quickfind init project

# Jump to 'project' from anywhere
qfcd project

# List all bookmarks
quickfind list

# Remove a bookmark
quickfind rmv project

Tech Stack

  • POSIX Shell
  • Compiled Binary
  • Make
  • Homebrew

On this page