stow

Symlink all files recursively to a given directory

$ stow [[-t|--target]] [path/to/target_directory] [file1 directory1 file2 directory2]

$ stow [[-D|--delete]] [[-t|--target]] [path/to/target_directory] [file1 directory1 file2 directory2]

$ stow [[-n|--simulate]] [[-t|--target]] [path/to/target_directory] [file1 directory1 file2 directory2]

$ stow [[-R|--restow]] [[-t|--target]] [path/to/target_directory] [file1 directory1 file2 directory2]

$ stow --ignore=[regular_expression] [[-t|--target]] [path/to/target_directory] [file1 directory1 file2 directory2]

stow [-d directory] [-t target] [-n] [-v level] [-S] [-D] [-R] [-L] package ...

-d directory
    Specify the directory where packages are located. Defaults to the current directory.

-t target
    Specify the target directory where packages will be installed. Defaults to the parent directory of the package directory.

-n
    No-op mode: print actions without executing them.

-v level
    Set verbosity level (0-3). Higher values provide more detailed output.

-S
    Stow only. Create symbolic links.

-D
    Delete only. Remove symbolic links and empty directories.

-R
    Restow. Equivalent to -D followed by -S.

-L
    Lazy stow. Do not delete any stale symlinks in the target dir unless another package needs to claim them.

package
    The name of the package directory to be installed.

The stow command is a utility for managing the installation of software packages within a directory tree. It achieves this primarily through the creation of symbolic links. The core idea is to keep different packages separate in their own subdirectories, and then use stow to link the files from those subdirectories into a common target directory (typically /usr/local or /opt).

This allows for easy installation, uninstallation, and version management of multiple packages without conflicts. It is particularly useful for managing dotfiles, software installed from source, or different versions of libraries. stow simplifies the process of keeping track of which files belong to which package.

It minimizes the need for manual symbolic link management and provides a clean, organized structure for software deployments.

stow relies on proper directory structure and file organization within the package directories. Conflicting filenames across packages can lead to unexpected behavior or errors. Ensure packages do not overwrite each other's files unless intended.

To install the 'my-package' located in the current directory into /usr/local, use: stow -t /usr/local my-package.

To uninstall 'my-package' run: stow -D -t /usr/local my-package.

A typical workflow involves creating a directory (e.g., 'stow') to hold all the packages, placing each package in its own subdirectory, and then using stow to link the package contents into the target directory (e.g., /usr/local). This allows for easy switching between different versions, uninstalling specific software or custom configuration.

stow was initially designed to manage dotfiles. It has evolved into a general-purpose tool for managing package installations, particularly in environments where package managers are not available or not suitable. Its usage has expanded to managing configurations and deploying custom software builds.

ln(1), make(1)