Mklinker 2.1.3

This documentation contains parts of the Github README.

Why use Mklinker? Who cares about symbolic links?

• With Mklinker you can keep the config file around and if you for example re-install your operating system you can just use Mklinker and restore all the various links you had before. This is especially useful if you are using a syncing program like Dropbox as it allows you to easily add links to outside folders like AppData, Program Files or My Documents
• With Mklinker you can easily setup outside references in your projects (you're welcome to use it in your own github repos!)
• With Mklinker you can send someone the config file and they can easily create all the links
• Mklinker is cross-platform (windows, linux, mac)

How do I use Mklinker?

Run mklinker help to see all verbs / commands and their description. You can also run mklinker help [VERB] or mklinker [VERB] --help in order to get more information about that given verb / command. For example, mklinker help addlink will show you arguments that the addlink verb / command takes.

For more info, check out the Getting started page on the wiki.

Features

• Supports symbolic, junction and hard links on Windows platform
• Supports symbolic and hard links on Linux and Mac platforms (junction links will be treated as symbolic links)
• Supports relative paths in config file, but will turn them into absolute paths when running linking commands.
• Supports variables for paths (e.g. "C:\Users?User?\Desktop") which means that you can create more dynamic configs. Nested variables (variables inside variables) are also supported.
• Supports custom config file name (if you don't like 'linker.config')
• Supports config validation where you can check for errors and warnings
• Supports interactive mode where you can run multiple commands without mklinker in front
• Supports a scan command which will help with finding circular paths that can arise due to symbolic directories / junctions pointing to a parent folder. This is important when combining Mklinker with Syncing tools like Dropbox as loops may cause the syncing to go on "forever"
• Supports adding multiple links at once using optional regex filters that also works for sub-directories (allows for recursion)