Config files
Put default flags in a config file, one per line:
--hyperlink--ignore=*.snap,fixtures/--budget 4000Where Sprout looks
Section titled “Where Sprout looks”Files are read in this order, and later ones win:
- User:
$SPROUT_CONFIG, else$XDG_CONFIG_HOME/sprout/config, else~/.config/sprout/config. On Windows it’s%AppData%\sprout\config. - Project: the nearest
.sproutrcin the target directory or above it. - The command line, which always wins. Turn a boolean off with
--git=false.
--ignore and --only patterns add up across all three rather than replacing each other.
- One flag per line:
--depth 3or--depth=3. Lines starting with#are comments. - Config files can only set flags, not a path.
- A mistake names the file and line:
.sproutrc:1: expected a flag like --depth 3. --no-configskips both files for one run.- When you map a remote repository, its
.sproutrcis ignored.
.sproutignore
Section titled “.sproutignore”.sproutignore isn’t a config file. It holds extra gitignore-style patterns for the directory it’s in, and applies on every run.