Quick Start

1. Install forge

See Installation.

2. Initialise a config

In the root of your git repo:

forge init --preset go        # Go project
forge init --preset php       # PHP project
forge init --preset node      # Node project
forge init --preset php-node  # PHP + Node monolith
forge init --preset minimal   # Commit-msg policy only

This creates forge.toml. Review and adjust it.

3. Install hook shims

forge install

forge writes thin shell scripts to .forge/hooks/ and sets git's core.hooksPath to that directory. If you cloned a repo that already commits .forge, you still need to run forge install once to set the local Git hook path.

4. Verify

forge doctor

doctor checks that the binary is on PATH, the config is valid, and hook shims exist for every configured hook.

5. Commit

git add .
git commit -m "chore: add forge"

Your hooks fire. If anything fails, the commit is aborted with a clear error message.

Skip a tool once

SKIP_ESLINT=1 git commit -m "wip: quick save"

Skip a hook once

SKIP_PRECOMMIT=1 git commit -m "wip: quick save"

See also

• Configuration
• Hooks
• Environment Variables