Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dannyben/fuzzycd
Change directories with fuzzy search
https://github.com/dannyben/fuzzycd
cd fuzzy-search fzf fzf-wrapper shell shell-productivity
Last synced: about 1 month ago
JSON representation
Change directories with fuzzy search
- Host: GitHub
- URL: https://github.com/dannyben/fuzzycd
- Owner: DannyBen
- License: mit
- Created: 2022-10-21T11:41:14.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T04:39:26.000Z (7 months ago)
- Last Synced: 2024-05-01T14:12:07.492Z (7 months ago)
- Topics: cd, fuzzy-search, fzf, fzf-wrapper, shell, shell-productivity
- Language: Shell
- Homepage:
- Size: 5.23 MB
- Stars: 17
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
A bash function that patches the native `cd` to allow changing directories
instantly using a fuzzy match, with or without an interactive menu.
# Fuzzy CD
[](https://github.com/DannyBen/fuzzycd/actions?query=workflow%3ATest)
## 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.
- Three operation modes:
- Minimal - cd to best match
- Interactive
- Interactive with `ls` preview
- Optional fuzzy bash completions.
## 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.
```shell
$ curl -Ls get.dannyb.co/fuzzycd/setup | bash
```
You are encouraged to inspect the [setup script](setup) 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
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 -c show completions function [usage: eval "$(cd -c)"]
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 (default)
i = interactive when needed, no preview
p = interactive when needed, with ls preview
FUZZYCD_COMPLETIONS_COUNT
Maximum number of suggestions to show in bash completions
(default: 10)
Interactive Keyboard Bindings:
Del
Delete selected directory from history
```
---
First, verify that Fuzzy CD is properly installed by running:
```shell
$ 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:
```shell
$ 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, or you will
`cd` to the best match when running in non-interactive mode (default).
## Bash completions
To enable fuzzy bash completions, add the following line to your `~/.bashrc`:
```bash
eval "$(cd -c)"
```
This works best when tab completion is configured for inline completions, which
you can set by adding/updating the `~/.inputrc` file:
```bash
# ~/.inputrc
TAB: menu-complete
```
## Uninstall
1. Remove the `source /usr/local/bin/fuzzycd` line from your `~/.bashrc`.
2. Delete `/usr/local/bin/fuzzycd`.
3. Optionally, delete the history file (`~/.fuzzycd-history`).
4. Restart 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][issues].
---
[issues]: https://github.com/DannyBen/fuzzycd/issues
[fzf]: https://github.com/junegunn/fzf