forkguarddocs

Environment variables

Four variables. All optional.

On this page
VariableWhat it does
FORKGUARD_SKIP=1Skips the automatic check for one command. Only read by the shell hooks.
GITHUB_TOKEN, GH_TOKENUsed to talk to GitHub when the GitHub CLI is not available. Needed by --mine, and by pr for opening the pull request.
NO_COLOR=1Turns off colors in the output.

#Skipping once

Git Bash, macOS or Linux:

FORKGUARD_SKIP=1 npm install

PowerShell:

$env:FORKGUARD_SKIP='1'; npm install

#A token for GitHub

The GitHub CLI is tried first (gh auth token). If it is not installed or not logged in, GITHUB_TOKEN and then GH_TOKEN are used. A token needs permission to read your repos for --mine, and to push and open pull requests for pr.

Where to next

Edit this page on GitHub View as Markdown

Type to search. Use the arrow keys and Enter.