Skip to main content

A symlink farm manager akin to GNU Stow

Project description

Symlink Gardener is a symlink farm manager akin to GNU Stow, but with additional features that are useful for tasks such as managing dotfiles.


  • Options for conflict resolution. By default, packages will silently shadow symlinks from packages with lower precedence than them, but actions will fail when there are conflicts with “weeds” (files not owned by the garden). However, different conflict resolution strategies can also be specified.

  • A more tangible concept of packages than stow. Packages can have their own config files to declare files to ignore (and maybe more stuff in the future), and packages have a real concept of being installed which allows symlinks to be easily and accurately updated when packages change.

  • Commands for converting specific weeds into symlinks managed by the garden and vice-versa.

  • And most importantly – hastily tacked on gardening metaphors!


Python >= 3.6 is required.

Recommended installation (with pipsi):

$ pipsi install --python=python3 symlink-gardener

Basic Usage

Create a garden in the current directory

$ gardener prepare

Plant (install) packages in the garden

This creates symlinks in the garden directory at paths that correspond to those in the package directory.

Packages may be customized in /.garden-package.json (currently all you can do is add ignore patterns)

$ gardener plant path/to/common path/to/ex other-ex:path/to/other/ex

Update symlinks for all installed packages

$ gardener tend

Add weeds to an installed package.

This moves the specified files from the garden directory to the package and creates a symlink in their place.

$ gardener cultivate -p common some/file another/file

Turn those symlinks back into weeds.

$ gardener fallow some/file another/file

Change package precedence.

This causes symlinks owned by ex to shadow symlinks owned by all other packages. Earlier, the package other-ex was in front of it.

$ gardener arrange --front ex

Prune (uninstall) packages

$ gardener prune ex other-ex

See the help for more

$ gardener help

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

symlink-gardener-0.2.4.tar.gz (12.6 kB view hashes)

Uploaded source

Built Distribution

symlink_gardener-0.2.4-py3-none-any.whl (11.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page