Skip to content

Easily register and recall aliases for commonly used directories.

Notifications You must be signed in to change notification settings

wilkesreid/mydir

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 

Repository files navigation

mydir

Built for Mac OS X

mydir is a command line tool that can help keep track of commonly used folders without cluttering up your environment variables. I often find that it's tedious to call cd over and over to get to the folder of the project I'm working in. This way I can easily and intuitively set an alias for my project folder.

Table of Contents

Prerequisites

You must have npm/nodejs installed.

Installation

npm install mydir -g

The ability to call cmydir <alias> to instantly change to an aliased directory command will be available the next time you open a terminal. To have cmydir available right away without restarting the terminal, run this in terminal after installation:

. ~/.bashrc OR . ~/.bash_profile

Tutorial

Create a project folder for yourself:

mkdir -p ~/Documents/Projects/MyProject

Create an alias with mydir:

mydir set MyProject ~/Documents/Projects/MyProject

Change to your project directory from any other directory:

cmydir MyProject

Usage

Set

To create an alias, use the set command:

mydir set <alias> <path>

For example:

mydir set MyProject ~/Documents/Projects/MyProject

Note: the path provided must be absolute.

Recall an alias

To use an alias you've created, just call mydir with your alias as the second argument:

mydir <alias>

For example:

mydir MyProject

The main usage of this is to cd into an aliased folder. This is how you would do that:

cmydir MyProject

Here's what's happening behind the scenes:

cd "$(mydir MyProject)"

If you call mydir with an alias that doesn't exist, it will return ..

You can call mydir with an alias followed by a path. For example,

mydir MyProject/subfolder

And since cmydir just uses mydir behind the scenes, you can make a call like this:

cmydir MyProject/subfolder

List

To see all existing aliases, call mydir list

Remove

To remove an existing alias, call mydir rm <alias>

About

Easily register and recall aliases for commonly used directories.

Resources

Stars

Watchers

Forks

Packages

No packages published