Advanced installation

Installation overview

Shusky requires a .shusky.yml file. This file must contain the hooks you want to install. If the hook is not defined in this file shusky is not going to install it. If you delete a hook from the .shusky.yml that was previously installed and run shusky install is going to delete it.

For installing shusky you must run:

swift run -c release shusky install

Flags

--all: Install all git hooks.

swift run -c release shusky install --all

--overwrite: Allow shusky to overwrite any git hook file when installing, if it already exists.

• If you want to delete your old git hooks and be replaced by shusky configuration use this:

swift run -c release shusky install --overwrite

• Can be combined with --all flag.

swift run -c release shusky install --all --overwrite

Subcommands

-h, --help: will display help

swift run -c release shusky install -h

--package-path: Set Swift Package Manager path, if Package.swift is not in the root.

swift run -c release --package-path BuildTools shusky install --package-path BuildTools