Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

symlink-dir

Declares one symlink per direct child of a directory in the repository, all of them in one destination directory.

[[actions]]
type = "symlink-dir"
id = "rcfiles"
source-dir = "files"
dest-dir = "~"
dot-prefix = true
FieldTypeRequiredDescription
source-dirrepository pathyesThe directory whose direct children are linked.
dest-dirtemplate stringyesThe directory the links are made in. Created if it is missing.
dot-prefixbooleannoPrefix each installed name with .. Defaults to false.
includeglob or listnoChildren to link; absent, every child. See entry filters.
excludeglob or listnoChildren not to link.

Each direct child is linked, in sorted order, without descending into directories: a config/ child becomes one link to everything below it. Adding a source child requires no manifest change.

source-dir and dest-dir follow the path rules. The destination is a directory container; each child follows the symlink policy. The containment check runs before creating the container or enumerating children. Child failures follow execution failures.

  • dot-prefix fails on an already-dotted child, naming it.
  • An empty source still creates dest-dir; -v reports no children.
  • A source that is not a directory fails.
  • Unsupported platforms fail before reading the source directory, as for symlink.

Filters match direct child names before dot-prefix. Patterns containing / are load errors. Unselected destinations are untouched; selecting no children still creates dest-dir and reports that fact at -v.

See common action fields for id, group, and conditions.