star is a CLI tool that allows you to bookmark your favorite folders and instantly navigate to them.
This software has been developed on bash >= 5.2, untested on prior versions (pretty sure it does not work on bash 3).
It uses GNU tools such as find, basename, which are not always the default (e.g. find exists on MacOS, but does not have the same options as the GNU version).
On MacOS, GNU utils can be installed using brew: https://apple.stackexchange.com/questions/69223/how-to-replace-mac-os-x-utilities-with-gnu-core-utilities.
Clone the repo and source the file star.sh:
git clone https://github.com/Fruchix/star.git
cd star
source star.shAlso source the file in your .bashrc:
echo "source $(pwd)/star.sh" >> ~/.bashrc
or .zshrc:
echo "source $(pwd)/star.sh" >> ~/.zshrc
star [MODE [ARGUMENTS...]]
Without MODE:
- Show this help message.
With MODE:
- Will execute the feature associated with this option.
MODEcan be one ofadd,list,load,rename,remove,reset,help, or one of their shortnames (such as-hforhelp). Usestar helpfor more information on short parameters and aliases.
star add [NAME]
sa [NAME]
Add the current directory to the list of starred directories.
The new star will be named after NAME if provided, otherwise it will use the basename of the current directory.
NAME must be unique (among all stars).
NAME can contain slashes /.
star list
sL
List all starred directories, sorted according to last load (top ones are the last loaded stars).
star load [STAR]
sl
Navigate (cd) into the specified STAR directory. If no argument is provided, it displays the list of starred directories (same behavior as star list).
STAR should be the name or index of a starred directory (one that is listed using "star list").
Also updates the last accessed time (used to sort stars when listing them).
star rename <EXISTING_STAR> <NEW_STAR_NAME>
Rename an existing star.
star remove <STAR> [STAR]...
srm <STAR> [STAR]...
Remove one or more starred directories.
STAR should be the name of a starred directory.
star reset [-f|--force]
Remove the ".star" directory (thus remove the starred directories). The argument -f or --force will force the reset without prompting the user.
star help
Get more information.
Use
star helpfor all options and aliases.
The following aliases are provided to make your life easier:
sa= star addsah= star addsL= star listsl= star load (which is the same as "star list" when no argument is provided)unstar= star removesrm= star remove
fruchix@debian:~/Documents/star$ star list
No ".star" directory (will be created when adding new starred directories).
fruchix@debian:~/Documents/star$ star add
Added new starred directory: star -> /home/fruchix/Documents/star
fruchix@debian:~/Documents/star$ star list
1: star -> /home/fruchix/Documents/star
fruchix@debian:~/Documents/star$ cd ..
fruchix@debian:~/Documents$ star add my/docs
Added new starred directory: my/docs -> /home/fruchix/Documents
# my/doc is not composed of two directories "my" and "docs",
# but is a star name containing a slash
fruchix@debian:~/Documents$ sl
1: my/docs -> /home/fruchix/Documents
2: star -> /home/fruchix/Documents/star
fruchix@debian:~/Documents$ cd
fruchix@debian:~$ sl star
fruchix@debian:~/Documents/star$ sl my/docs
fruchix@debian:~/Documents$ unstar my/docs
Removed starred directory: my/docsCopyright 2025 Fruchix
Contributions are welcome! Please submit issues or pull requests to improve star.
Special thanks to @PourroyJean for contributing to this project.