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

copy

Declares one file or one directory, copied to a destination where nothing is.

[[actions]]
type = "copy"
id = "gitconfig-local"
source = "seed/gitconfig.local"
dest = "~/.gitconfig.local"
FieldTypeRequiredDescription
sourcerepository pathyesThe file or directory to copy, within this repository or a remote it names.
desttemplate stringyesWhere the copy goes, exactly. Never empty; ~ is the home.
includeglob or listnoEntries of a directory source to copy; absent, every entry. See entry filters.
excludeglob or listnoEntries of a directory source not to copy.

Installs an editable copy of a file or directory, under the seed policy: editing it does not change the repository, and later runs keep it. A directory is installed whole, never merged; use copy-dir to seed missing children. Refresh also replaces the whole tree. Paths, permissions, and containment follow shared rules.

Only regular files and directories may occur within the copied tree; nested symlinks, sockets, FIFOs, and devices fail naming the path. The source itself may resolve through a symlink.

Filters match paths relative to source at any depth. Unselected entries are not inspected, so an excluded symlink does not fail. Selecting nothing seeds an empty directory. Filters on a file source fail, regardless of the destination. Selection reads the source in both modes before considering the destination; refresh compares against the filtered tree.

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