dannyben/fuzzycd

Change directories with fuzzy search

A bash function that patches the native cd to allow changing directories instantly using a fuzzy search

Fuzzy CD

Features

• Preserves the native cd completion.
• Understands CDPATH.
• Remembers all visited directories.
• Allows changing directory to any directory from the history that matches the input fuzzy search (unless it matches an actual directory).
• Shows available choices, with ls preview, when there are more than one matches (optional).
• Does not override the builtin cd when running non-interactively.
• Adds flags such as cd -l to view and manage the history.
• Interactive menu is optional and can be disabled in favor of "cd to best match".

Prerequisites

Fuzzy CD requires a recent version of fzf.

Installation

Installing using the setup script

This setup script will download the fuzzycd function to /usr/local/bin and apply the necessary source command to your startup script.

$ curl -Ls get.dannyb.co/fuzzycd/setup | bash

You are encouraged to inspect the setup script before running.

Installing manually

1. Place the fuzzycd file in /usr/local/bin/ and make it executable
2. Source it (source /usr/local/bin/fuzzycd) from your startup script (for example: ~/.bashrc)

Usage

Show Usage Patterns

$ cd -h

fuzzycd 0.2.2

Usage:
  cd DIR       change working directory
  cd SEARCH    change working directory or show selection menu
  cd -l        list history with fzf
  cd -e        edit history file
  cd -s        show history file
  cd -d [DIR]  delete current or specified directory from history
  cd -v        show version
  cd -h        show this help

Environment Variables:
  FUZZYCD_HISTORY_FILE
    Path to history file (default: ~/.fuzzycd-history)

  FUZZYCD_MODE
    Set operation mode (one of: m, i, p)
      m = minimal, non interactive, always cd to best match
      i = interactive when needed, no preview
      p = interactive when needed, with ls preview (default)

Interactive Keyboard Bindings:
  Del
    Delete selected directory from history

---

First, verify that Fuzzy CD is properly installed by running:

$ cd -h

Now, you can use cd normally to change to any directory. These directories will be remembered in a history file. You can view this file by running:

$ cd -s
# or
$ cat ~/.fuzzycd-history

Fuzzy search

Use cd with a string that is not a directory. If exactly one directory in the history matches this string, you will instantly cd to it as usual.

If more than one directories match, you will be prompted to choose one of the matching directories when running in interactive mode (default), or you will cd to the best match when running in non-interactive mode.

Uninstall

1. Remove the source /usr/local/bin/fuzzycd line from your startup script(s) (~/.bashrc and/or ~/.zshrc).
2. Delete /usr/local/bin/fuzzycd.
3. Optionally, delete the history file (~/.fuzzycd-history).
4. Retsrat your session.

Contributing / Support

If you experience any issue, have a question or a suggestion, or if you wish to contribute, feel free to open an issue.

---

fuzzycd's Issues

Allow customizing the fzf command

This can be done in one of two ways (or both):

1. Allow complete customization using FUZZYCD_FZF_COMMAND environment variable.
2. Allow selecting "presets" - for example, with interactivity or without.

Tab autocompletion for fuzzily-matched directories

Can this be done?

Discussion: junegunn/fzf#3019

Add ability to delete directory from the history

Would be nice to be able to do:

# delete current directory from history
$ cd -d

# delete other directory from history
$ cd -d /some/dir

Then, in addition, we can probably bind the del key to run this and reload, when using the interactive menu.

Change directory to the best match instead of opening fzf menu

Can this be done?

junegunn/fzf#3017