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

Declares one symlink, from a path in the repository to a destination.

[[actions]]
type = "symlink"
id = "zshrc"
source = "shell/zshrc"
dest = "~/.zshrc"
FieldTypeRequiredDescription
sourcerepository pathyesThe source, within this repository or a remote it names. Never empty.
desttemplate stringyesThe destination path, as written. Never empty; ~ is the home.

source is the target; dest is the link. Follow the shared path rules, destination policy, and source-containment check.

Symlink actions require Unix. On unsupported platforms, the action fails by type before inspecting its destination; it never substitutes a copy.

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