dotfiles

Description

Symbolically link dotfile folders into place and install associated applications.

This frecklet is mainly meant to be used with freckelize to provide a 'one-command' way of initializing a new workstation setup, including application install and configuration.

It can be used without freckelize, but this usage is neither documented nor supported.

Note: this is currently unmaintained, it will be re-written at some stage

Variables

Name Type Default Description

extra_vars

n/a --

n/a Required

files

n/a --

n/a Required

path

string --

The path to the folder to process. Required

vars

n/a --

n/a Required

__folder_files__

list --

A list of files contained in the dotfile folder.

fail_on_install_error

boolean False

Whether to stop if an install step fails (this will still continue until the current list is finished though).

folder_overlay

dict --

Overlay dictionary to specify more details install instructions for folder-based package install.

packages

list --

List of additional packages to install.

skip_extra_packages

boolean False

Skip the install of extra packages specified in a .freckle file.

skip_folder_packages

boolean False

Skip the install of packages calculated from folder names.

unstow

boolean False

Unstow dotfiles folders instead of stowing them, this also prevents the installation of packages.

Command-line

frecklecute --community dotfiles --help

Usage: frecklecute dotfiles [OPTIONS] FOLDER

  Symbolically link dotfile folders into place and install associated
  applications.

  This frecklet is mainly meant to be used with ``freckelize`` to provide a
  'one-command' way of initializing a new workstation setup, including
  application install and configuration.

  It can be used without ``freckelize``, but this usage is neither
  documented nor supported.

  **Note**: this is currently unmaintained, it will be re-written at some
  stage

Options:
  --extra-vars EXTRA_VARS         n/a  [required]
  --files FILES                   n/a  [required]
  --vars VARS                     n/a  [required]
  --fail-on-install-error / --no-fail-on-install-error
                                  Whether to stop if an install step fails
                                  (this will still continue until the current
                                  list is finished though).
  --folder-overlay FOLDER_OVERLAY
                                  Overlay dictionary to specify more details
                                  install instructions for folder-based
                                  package install.
  -p, --package PACKAGE           List of additional packages to install.
  --skip-extra-packages / --no-skip-extra-packages
                                  Skip the install of extra packages specified
                                  in a .freckle file.
  --skip-folder-packages / --no-skip-folder-packages
                                  Skip the install of packages calculated from
                                  folder names.
  --unstow / --no-unstow          Unstow dotfiles folders instead of stowing
                                  them, this also prevents the installation of
                                  packages.
  --help                          Show this message and exit.