API Docs

download(d::Download)

Download the file specified by the Download object d.

addprogramfile(fname)

Include a Julia source file containing program install configurations in the Programs submodule.

addprograms(dir)

Include all Julia source files in a directory to the program install configurations in the Programs submodule.

attempt(𝒻, gr::GitRepo)

Run the function 𝒻 taking the URL of the repo gr as an argument. If execution fails with a ProcessFailedException, 𝒻 will be run again but with the fallback URL provided instead. Such a failure will also cause the GitRepo to prefer the fallback.

Calling this function on a GitRepo with prefer_fallback will use the fallback and will not re-attempt a failure.

checkout(gr::GitRepo)

Checkout the specified branch of the GitRepo. If the repo does not exist locally clone(gr) will be run first.

clone(gr::GitRepo; replace=false)

Clone the gitrepo. If replace, will delete the existing directory, otherwise, this will fail if the GitRepo destination exists.

diff(src, dst; confirm=isinteractive())

If confirm, prompt the user whether they'd like to edit the diff between the files src and dst.

distro()

Return a Symbol describing the current linux distribution. This is primarily used for selecting a package manager, so Manjaro and Arch are equivalent, as are debian and ubuntu.

dotfilesdir!([dir])

Set the directory from which the configuration dotfiles will be installed. By default, this will be taken from the environment variable INSTALLER_DOTFILES_DIR.

downloads(p)

Perform all downloads for a Program object.

getdistroinfo()

Get a string which describes the current linux distribution. This is from scanning through /etc/ for files with -release in the name.

hasfuse()

Determines whether the FUSE device is available. If false, AppImages cannot be run without extracting.

help()

Display a useful help message. This is displayed when the package is started in interactive mode.

install(progs)
install(p)

Install a program or list of programs, performing all steps specified by that program's configuration. In interactive mode, installing a list of programs will prompt with a selection menu from that list.

install(p; confirm=isinteractive())

Install the program p. If confirm, the user will be asked for confirmation for potentially destructive actions such as overwriting files.

installconfig(cfg)

Install the configuration file cfg. This will copy it from the dotfilesdir() source dir to the same relative path in HOME.

installconfigs

Install all configs in a file, or all configs specified by a Program object.

issudo()

Determines whether the current user has sudo priveledges.

pminstall(args...)
pminstall(p::Program)

Perform a package manager installation. Arguments will be provided to the standard package manager install.

Will prompt before running if in interactive mode. Will skip if not sudo.

pminstall_command

Return the command for installing a program, depending on linux distro.

pmupdate_command

Return the command for performing a package manager update.

programs()

Get a list of all configured programs. This is obtained from a list of Program objects in the Programs submodule.

pull(file; confirm=isinteractive())

Copy a file from the home directory to the dotfiles directroy. This is useful for updating the dotfiles repo after changes have been made to the file on the system. If confirm and a file already exists, the user will be given the option whether to replace or edit a diff. The path of file should be given relative to the home directory.

pull(gr::GitRepo)

Pull the specified branch from origin. If the repo does not exist locally clone(gr) will be run first.

pullrepos(p)

Pull all repositories associated with the program config p, cloning if necessary. This will be done with the git pull command so any discrepancies need to be resolved manually later.

push(file; confirm=isinteractive())

Copy a file from the dotfiles directory to the home directory. If confirm and a file already exists, the user will be given the option to whether to replace or edit a diff. The path of file should be given relative to the home directory.

runcommand(cmd)

If in interactive mode, prompt whether or not a command should be run.

srcdstpaths(fname)

Generate source and destination file names for dotfiles.