fresh

Build shell configuration and symlinks from freshrc

$ fresh

$ fresh update

$ fresh update --local

$ fresh update [username]

$ fresh search [keyword]

$ fresh edit

$ fresh clean

$ fresh show

fresh [command] [options]

fresh is a dotfiles manager that works like Bundler for your shell configuration. It aggregates aliases, functions, completions, and configuration files from your own dotfiles and from other users' GitHub repositories into a single built shell script and a set of symlinks.
Configuration is defined in ~/.freshrc using a simple DSL. Each line specifies a source file to include, optionally from a GitHub repository. When fresh runs, it concatenates all shell sources into ~/.fresh/build/shell.sh and creates symlinks for non-shell config files. You source the built file from your shell rc to activate everything.
Fresh supports three types of sourced content: shell files (concatenated into the build script), config files (symlinked via --file), and bin files (made executable via --bin).

install

Build shell configuration and create symlinks. This is the default when no command is given.

Fetch latest changes from source repositories and rebuild. Optionally filter by --local, a GitHub username, or username/repo.

Remove dead symlinks and unused source repositories.

Query the fresh directory wiki for configuration examples matching keyword.

Open ~/.freshrc in your default $EDITOR.

Display freshrc lines with their matching source files.

Show usage documentation.

Fresh uses ~/.freshrc as its configuration file. Sources are specified as:

$ # Local file from ~/.dotfiles/
fresh aliases.sh

# File from a GitHub repository
fresh jasoncodes/dotfiles shell/aliases/git.sh

# Non-GitHub git URL
fresh git://example.com/repo.git file.conf --file=~/.config/app.conf

# Executable script
fresh freshshell/fresh contrib/completion/fresh-completion.bash --bin

$ fresh-options --file=~/.vimrc --marker='"'
  fresh vim/mappings.vim
  fresh vim/plugins.vim
fresh-options

--file[=path]

Link or build a configuration file. With a path like --file=~/.vimrc, the file is symlinked to that location. Without a path, files are concatenated into ~/.fresh/build/ using their original name.

Create an executable symlink in ~/bin/ (or a custom path). The source file is made executable automatically.

Lock a source to a specific git branch, tag, or commit hash.

Pipe the source file through a shell command before including it (e.g. --filter="gpg -d").

Add comment markers around sourced content for identification in built files.

Suppress errors when a source file is not available.

Fresh requires git and bash to be installed. All shell sources are concatenated into a single file, so naming conflicts between sourced functions or aliases from different repositories must be managed manually. The built shell script must be explicitly sourced from your .bashrc or .zshrc — fresh does not modify these files automatically.

fresh was created by Jason Weathered (jasoncodes) and Scott Barron (twe4ked) as an open-source shell tool released under the MIT license. It was inspired by the concept of Bundler for Ruby, applying the same dependency-sourcing philosophy to dotfiles management across the shell ecosystem.

git(1), bash(1), stow(8), dotbot(1)