Navigational Assistance with Velocity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Abreu dab199f113
Updated README to fix typo
3 months ago
completions Major revision 3 months ago
functions Fixed the "forward" option. 3 months ago
hooks Major revision 3 months ago
subfunctions Fixed the "forward" option. 3 months ago
.gitignore Initial commit 11 months ago
LICENSE Initial commit 11 months ago
README.md Updated README to fix typo 3 months ago
init.fish Initial commit 11 months ago

README.md

GPL License | Fish Shell | Oh My Fish Framework |

nav - Navigation Assistance with Velocity

A plugin for Oh My Fish

In brief, it finds a folder whose name matches search patterns and makes it the current working directory. Ambiguities prompt the user to choose a directory from a list ordered on the basis of folders that have been used most often and most recently.

Summary

  1. Example Usage

  2. Options

  3. Installation

  4. Configuration

  5. Thanks

Example usage

asciicast

Options

Navigation

nav [pattern] ...

If no argument is provided, list bookmarks. Otherwise, look for a directory in the navigation history that matches the patterns given and go there.

nav -w/--where [pattern] ...

Go to a directory in the navigation history.

nav -t/--to [pattern] ...

Go to a bookmarked directory.

nav -f/--forward [pattern] ...

Go to the closest child folder that matches passed patterns.

nav -b/--back [pattern] ...

Go to the closest parent folder that matches passed patterns.

nav -p/--prevd [pattern] ...

Navigate to a previous directory in the navigation history.

nav -n/--nextd [pattern] ...

Navigate to a following directory in the navigation history.

Modifiers

nav [-t/-w/-f/-b/-p/-n] -e/--echo [pattern] ...

Print destination instead.

nav [-t/-w/-f/-b] -c/--commander [pattern] ...

Open a directory, or some directories, using mc, the Midnight Commander. A directory can be opened in each panel by dividing search patterns using ,.

nav [-t/-w/-f/-b] -R/--ranger [pattern] ...

Open a directory, or some directories, using ranger. Directories can be opened in different tabs by dividing search patterns with ,.

Bookmarking

nav -s/--save [name] [destination] ...

Bookmark directories. If only a name is provided, the current directory is bookmarked.

nav -r/--remove [bookmark/all] ...

Remove some, or all, saved bookmarks or bookmark folders.

nav -m/--move [source] ... [destination]

Move or rename bookmarks or bookmark folders.

nav -a/--autoremove

Remove bookmarks of folders that no longer exist. Bookmarks with destinations starting with "/media" will be ignored.

nav -l/--list [folder] ...

List the contents of the bookmarks folder or some inner folders.

nav --backup [restore] [file]

Create, or restore from, a backup file containing all bookmarks. If no file is specified, it'll create, or look for, a backup file in the current folder.

Miscellaneous

nav --abbr

Add, or otherwise remove, abbreviations for interactive use:

  • w for nav --where
  • t for nav --to
  • f for nav --forward
  • b for nav --back
  • p for nav --prevd
  • n for nav --nextd
  • l for nav --list

nav --help

Display these instructions

Install

omf repositories add https://git.disroot.org/lusiadas/argonautica
omf install nav

Dependencies

Required

If any of the following dependencies isn't installed, upon installing nav you'll be prompted to install them.

curl contains_opts feedback grep percol mlocate sed tree

Optional

To use the --commander and --ranger options, mc and ranger need to be installed, respectively.

Configuration

When nav loads along with the shell, and it can set the latest directory in the navigation history as the current working directory. This behaviour helps to avoid bloating the navigation history with directories the user frequently opens as soon as the terminal is launched.

To activate this behaviour add the line set -g _nav_resume true to your fish config file. Like so:

echo 'set -g _nav_resume true' >> ~/.config/fish/config.fish

And to remove said behavior:

sed -i '/_nav_resume/d' ~/.config/fish/config.fish

Thanks

This script was inspired by, and was based on, the work of theses nice fellows:

Also, it was written with the constant support of fish's gitter channel.