Function: installHooks()

August 8, 2026 · View on GitHub

installHooks(config?, options?): object

Defined in: src/hooks/install.ts:89

Install Praxis hook scripts into .git/hooks/.

If existing hooks are found, they're renamed to .pre-praxis and the Praxis hook chains to them.

Parameters

Partial Praxis hooks configuration (merged with defaults)

Installation options: repoRoot, force (overwrite), verbose

boolean

string

boolean

object

Lists of installed, skipped, and chained hook names

chained: GitHookName[]

installed: GitHookName[]

skipped: GitHookName[]