package link

Aliases: 
  • link
  •  
    Parameters:
    Name Type Required Default Hint
    moduleDrectory string false Path to an app's modules directory
    force boolean false false Overwrite any existing module or link.

    Command Usage

    Takes the current module directory and link it to another app's modules directory. The current directory must be a package.
    This is useful for live testing of a module that's under develpment without needing to install and update the installation
    with every change. You're operating system's local symlink capabilities will be used. This requires a file sytem that
    supports symlinks.

    The target link must not be just to the root of the app, but the specific modules folder you want to link into.
    The package's slug will be used as the name of the target link.

    link path/to/app/modules
    
    link path/to/app/modules_app
    If you provide no package path, the module will be linked into the local CommandBox core.
    link
    If there already exists a module or linked package in the target location, use --force but bear in mind
    This will delete the existing folder or link first.
    link --force
    Linking a package is not the same as installing it. The target box.json will not be modified nor will any depdencies be installed.
    You'll need to run an "install" in the local module you're developing to install its depdendencies, which will in turn be part of the link.

    See also: package unlink