Awesome

Navita: Navigate Smarter, Not Harder

Derived from "navigate" and "ita" (short for "iteration"), suggesting a tool that helps you navigate through iterations of directory visits.

Features • Dependencies • Installation • Environment Variables • Known Caveats • Concept/Motivation • Contributing to Navita • License

Tired of typing out long, complex directory paths? Navita is here to simplify your command-line experience! The powerful Bash tool uses fuzzy search to get you to your destination in seconds.

Forget about tedious typing. You can instantly find and jump to any directory, no matter how deeply nested. Navita is a great tool for boosting your productivity and saving you valuable time.

Features

Usual Directory Change

Synopsis: cd [PCRE_EXPRESSION... | DIR]

• Navita will search the history and directly navigate to the highest-ranked matching directory. The current working directory will not be considered in the search.

• For highest-ranked directory traversal, search strings will be matched using Perl-compatible regular expressions (PCREs) and are compared case-sensitively.

• Navita has two exceptions when using PCREs, mainly to keep things (almost) compatible with FZF search syntax.

  • The . character will be treated literally.
  • The ! character can be used to exclude matches for a specified search pattern or word.

  # For example, navigate to the highest-ranked directory path 
  # that does not contain the substring 'smartcd' 
  # and ends with the substring '.config'.
  cd \!smartcd .config
  # OR
  cd '!smartcd' .config
  

[!NOTE] Navita will compare the last word of the string argument to the end of the paths in the history to determine the highest-ranked matching directory. You can override this behaviour by explicitly specifying $ (End-of-String Anchor) in your search string.<br>

• You can also navigate directories the same way you would with the usual built-in cd command.

Search & Traverse Child Directories

Synopsis: cd (-s | --sub-search) [STRING...]

Recursively search subdirectories, excluding .git and its subdirectories, and navigate to the selected one.

Search & Traverse Parent Directories

Synopsis: cd (-S | --super-search | ..) [STRING...]

Search directories one level below the parent directories and navigate to the desired one. The current working directory will not be considered in the search.

Search & Traverse History

Synopsis: cd -- [STRING...]

Search your recently visited directories and select the desired one. The current working directory will not be considered in the search.

[!NOTE] Visit a few directories after a clean or initial installation to build a history.

View History

Synopsis: cd (-H | --history) [--by-time | --by-frequency | --by-score]

View Navita's history of visited directories. The history will be displayed in the less pager, or directly to STDOUT if it fits on a single screen. The output will be sorted based on the provided option:

• --by-time: Sorts the history by access time, with the most recently accessed directories appearing first.
• --by-freq: Sorts the history by frequency, showing the most frequently accessed directories first.
• --by-score: Sorts the history by score, with the highest scoring directories at the top. This is the default option.

Toggle Current & Previous Directories

Synopsis: cd -

Switch between your current directory and the previous directory you were in. The previous directory is specific to the current shell.

Clean-up History

Synopsis: cd (-c | --clean) [--invalid-paths | --ignored-paths | --custom-paths | --full-history]

You can choose to either remove invalid paths or paths matching regex in the $NAVITA_IGNOREFILE file or custom paths from the history, or clear the entire history.

Version Information

Synopsis: cd (-v | --version)

View Navita's version information.

View Help

Synopsis: cd (-h | --help)

View help message.

Tab Completion

• Navita supports Tab completion for its options, directories and Highest-ranked directory.

  # To trigger Highest-ranked directory completion, 
  # press the Tab key after entering a space following the last search term. 
  cd \!smartcd .config<Space><Tab>
  

• For Zsh, to initialize the completion system, the function compinit should be autoloaded, and then run simply as ‘compinit’. Ref: Zsh Completion System - Use of Compinit

Path Exclusion for History

• Prevent paths that match any regular expression pattern in the $NAVITA_IGNOREFILE file from being added to the history.
• Navita automatically prevents the .git and $HOME directories from being added to the history by default.

[!NOTE] Even if a path was part of the history prior to its inclusion in the $NAVITA_IGNOREFILE using a regular expression pattern, it will still be visible, but Navita will cease to boost its ranking.

Frecency Directory Ranking

The Frecency algorithm ranks directories based on a combination of two factors:

• frequency (how often a directory is accessed) and,
• recency (how recently it was accessed).

This ensures that the most relevant directories—those accessed both frequently and recently—are ranked higher, while directories with older access are deprioritized.

$$ \text{FrecencyScore(t)} = \ln\Bigg(k + \frac{10}{1+\alpha_1(t-T_0)} + \sum_{i=0}^{n} e^{-\alpha_2(t-T_i)} \Bigg) $$

where,

• t is the current time.

• T0 is the time of the most recent visit.

• Ti represent the time of previous visits (with i = 0 for the most recent visit and i = n for the oldest).

• k is a constant (0.1) which provides a lower bound on the frecency score.

• α1 and α2 are decay parameters:

  • α1 = 2 * 10^(-5), which controls the decay for the most recent visit.
  • α2 = 3 * 10^(-7), which controls the decay for all prior visits. <br>

• All times are expressed in seconds and the idea is to make recency more important than frequency.

• NOTE: The Frecency algorithm was created by @homerours and is used in their Jumper project, another excellent fast file jumper. @homerours should be credited for the Frecency algorithm.

• Detailed information about the algorithm can be found here.

Aging

• Navita will check aging once every 24 hours at shell startup.
• During the aging process, Navita will,
  • limit the entries in the history to 100 (default) most frecent directory paths,
  • remove directory paths that match any pattern in the $NAVITA_IGNOREFILE, and
  • remove invalid directory paths.

Additional Info

• Frecency rankings are updated asynchronously at runtime.
• Navita employs a locking mechanism to ensure atomic history updates, preventing race conditions that may arise from concurrent modifications.
• For Navita to follow physical directory structures, use the -P option along with the other options. This will resolve symbolic links and navigate you to the actual physical location on disk. To make Navita always resolve symbolic links, check the NAVITA_FOLLOW_ACTUAL_PATH environment variable.

[!NOTE] If this option is used, it should be the very first option given to Navita.

• Search syntax is same as the FZF search syntax except when searching for Highest-ranked directory. You can type in multiple search terms delimited by spaces. For example, FZF sees ^music .conf3$ sbtrkt !fire as four separate search terms.

  Token	Match Type	Description
  sbtrkt	fuzzy-match	Items that include sbtrkt characters in that order
  'wild	exact-match (quoted)	Items that include wild
  'wild'	exact-boundary-match (quoted both ends)	Items that include wild at word boundaries
  ^music	prefix-exact-match	Items that start with music
  .conf3$	suffix-exact-match	Items that end with .conf3
  !fire	inverse-exact-match	Items that do not include fire
  !^music	inverse-prefix-exact-match	Items that do not start with music
  !.conf3$	inverrse-suffix-exact-match	Items that do not end with .conf3

Dependencies

• GNU Bash or Zsh
• FZF
• GNU Grep
• GNU bc
• GNU Find Utilities (basically the find command)
• Util-Linux (basically the flock command)
• GNU Core Utilities
• Less (only for viewing the history in a pager)

Installation

1. Download the navita.sh file.

# using wget2
wget2 https://raw.githubusercontent.com/CodesOfRishi/navita/main/navita.sh

# or using curl
curl https://raw.githubusercontent.com/CodesOfRishi/navita/main/navita.sh --output navita.sh

2. Source the navita.sh file in your .bashrc/.zshrc configuration file.

source "path/to/the/navita.sh"

Environment Variables

[!NOTE] If you want to keep your desired values rather than the default ones, make sure to export these environment variables before sourcing the navita.sh file in your .bashrc/.zshrc.

• NAVITA_DATA_DIR

  • Directory location for Navita's data files.
  • Defaults to $XDG_STATE_HOME/navita
  • If XDG_STATE_HOME is not set, it defaults to ~/.local/state/navita.

• NAVITA_CONFIG_DIR

  • Directory location for Navita's configuration files.
  • Defaults to $XDG_CONFIG_HOME/navita
  • If XDG_CONFIG_HOME is not set, it defaults to ~/.config/navita.

• NAVITA_COMMAND

  • Name of the command to use Navita.
  • Defaults to cd.

• NAVITA_FOLLOW_ACTUAL_PATH

  • Follow symbolic links and resolve them to their actual physical locations before making the directory change.
  • Defaults to n, i.e., not to follow symbolic links.
  • Change it to y or Y to follow symbolic links.

• NAVITA_RELATIVE_PARENT_PATH

  • Defaults to y i.e., show the resolved parent paths relative to the present working directory in Search & Traverse Parent Directories feature.
  • Change it to n or N to show the parent paths as absolute path.

• NAVITA_SHOW_AGE

  • Defaults to y, i.e., show an age annotation next to the paths while searching and traversing from history.
  • Change it to n or N, to not show an age annotation beside the paths.

• NAVITA_FZF_EXACT_MATCH

  • Defaults to y, i.e., Exact match and search in FZF when utilizing Search & Traverse Child Directories, Search & Traverse Parent Directories or Search & Traverse History.
  • Change it to n or N, to Fuzzy match and search in FZF.
  • It will not affect Tab completion in Bash or the Highest-ranked directory search.

• NAVITA_HISTORY_LIMIT

  • Maximum number of directory paths Navita should remember.
  • Defaults to 100.

Non-Configurable Environment Variables

• NAVITA_VERSION

  • Navita's version information.

• NAVITA_IGNOREFILE

  • The file containing regular expression patterns to ignore matching paths from being added to the history.
  • The path to the file is $NAVITA_CONFIG_DIR/navita-ignore.

• NAVITA_HISTORYFILE

  • The file containing a history of directory paths visited using Navita, along with their associated metadata like frequency, access time, and score.
  • The path to the file is $NAVITA_DATA_DIR/navita-history.

Known Caveats

• Using suffix-exact-match FZF search syntax won't work in Search & Traverse History if NAVITA_SHOW_AGE environment variable is set to y due to FZF Issue #3983.

Concept/Motivation

• To address the tedium of the builtin cd command.
• KISS&E - Keep It Simple, Straightforward & Efficient.
• No feature bloating.

Contributing to Navita

To review the latest changes that have not yet been included in the latest release, check out the dev branch.

Reporting Issues

If you encounter any bugs or issues while using Navita, please open an issue on the Navita GitHub repository. Provide as much detail as possible, including steps to reproduce the issue and any relevant error messages.

License

This project is licensed under the Apache License 2.0. See the LICENSE for details.