Skip to content

Latest commit

 

History

History
92 lines (66 loc) · 2.66 KB

README.md

File metadata and controls

92 lines (66 loc) · 2.66 KB
Raw

pathfinder

Version : v0.1.2 Build : 202405242303

Pathfinder is a command-line tool that helps you navigate between directories without needing to specify the entire path. Simply specify the name of the directory you want to switch to, and Pathfinder will handle the rest. It also supports specifying entire paths if needed.

Features

  • Quickly switch from one directory to another without entering the full path
  • Mention the parent directory to avoid jumping to other unwanted folders
  • Pathfinder also supports full paths
  • Use the -b flag to get back to the previous directory you were in
  • Uses a cache to store frequently visited directories, so you can move between them faster

Installation

Warning

Pathfinder is only tested in Linux right now. This will not work on Windows!!

  • Clone this repository
git clone https://github.com/vyshnav-vinod/pathfinder.git
  • Move into the cloned folder
cd path/to/clone
  • Mark install.sh as executable
chmod +x install.sh
  • Run install.sh
./install.sh

Note

This will create a alias named pf in your .bashrc and also a pathfinder.sh script which is required to run pathfinder

  • If successful, reload the terminal or use the source command
source ~/.bashrc

You are good to go. Check below usage and examples to start using pathfinder. If you were stuck or unable to install, please raise an issue and i will help you.

Usage

pf [directory name/path] (flags)

Flags

  • -b, --back : Move back to the previous directory from where pathfinder was called.
  • -i, --ignore : Ignore searching for the folder in the current directory.
  • --clean : Clean the cache. If you encounter any unexpected behaviour, try this.
  • --info : Display version and build number.
  • -h, --help : Display the help message.

Examples

  • Go to the folder named dirname
pf dirname
  • Go to the folder named dirname under the parentdir folder
pf parentdir/dirname
  • Go to the folder named dirname using full path
pf ~/Desktop/dirname
  • Go back to previous directory
pf -b

Issues

Pathfinder is still in early stages. You can raise an issue and i will be glad to help.

Contributing

Do you have a new feature idea? Or do you want to improve the performance? Or know how to fix a bug? You can raise a new Pull Request. If you are adding a new feature, please open a issue stating what you will add to pathfinder and then you are good to go. If you feel stuck with something, raise an issue and i will be happy to help.