Module settings 

Every stk-owned git config key and its resolution logic, in one place.

Constants

ABSORB_INCLUDE_UNSTAGED_KEY

CHECK_TIMEOUT_KEY

CLEAN_CLOSED_KEY

DEFAULT_CHECK_TIMEOUT_SECS

How long merge --wait polls a review’s checks before giving up, unless stk.checkTimeout overrides it. Generous so a slow-but-real CI is not cut off; the point is to bound a pipeline that never settles, not a long one.

DEFAULT_REMOTE

FETCH_BEFORE_RESTACK_KEY

GITEA_HOST_KEY

GITHUB_STACKS_KEY

Register a submitted stack with GitHub’s native stacked pull requests. Off by default: the feature is in public preview, so creating a stack on someone’s behalf is opt-in.

GITLAB_HOST_KEY

MERGE_STRATEGY_KEY

MERGE_WAIT_KEY

NO_UPDATE_CHECK_KEY

PROVIDER_KEY

PUSH_ON_RESTACK_KEY

PUSH_ON_SUBMIT_KEY

REMOTE_KEY

SETTINGS

Every [stk] setting the tool reads, with its default behavior. Shown by git stk config.

SUBMIT_DRAFT_KEY

SUBMIT_STACK_KEY

UPDATE_REFS_KEY

USE_PR_TEMPLATE_KEY

WORKTREE_DIR_KEY

Functions

bool_setting

A boolean setting’s value, defaulting to false when unset.

check_timeout

How long merge --wait keeps polling a review’s checks before giving up, from stk.checkTimeout (whole seconds). 0 waits indefinitely; unset uses DEFAULT_CHECK_TIMEOUT_SECS.

fetch_enabled

Resolve a --fetch/--no-fetch flag pair against stk.fetchBeforeRestack.

gitea_host

A self-hosted Gitea/Forgejo host (e.g. gitea.example.com) to recognize as Gitea alongside gitea.com and codeberg.org (stk.giteaHost). tea reads the host from the git remote itself, so this only widens stk’s detection.

gitlab_host

A self-hosted GitLab host (e.g. gitlab.example.com) to recognize as GitLab alongside gitlab.com (stk.gitlabHost). glab reads the host from the git remote on its own, so this only widens stk’s provider detection.

merge_strategy

The merge strategy for git stk merge: squash, rebase, or merge.

push_enabled

Resolve a --push/--no-push flag pair against its config-key default.

remote

The remote used for provider detection, trunk discovery, and pushes.

use_pr_template

Whether to seed a new review’s body from the repo’s PR/MR template (stk.usePrTemplate). Defaults to true - unlike most bool settings - so the template is honored out of the box; set false to opt into a lean, git-stk-only body.

worktree_dir

Where new --worktree puts a branch’s worktree. From stk.worktreeDir, or a sibling of the repo root named <repo>-worktrees - outside the repo, so the worktrees do not land in its own file watchers, ignore rules, or git status.

worktree_path_for

The worktree directory for branch, under worktree_dir. Branch names nest as real directories, so feat/a lands at <dir>/feat/a and its basename still matches the branch tail - the way git’s own path-to-branch guessing reads a worktree path.