Configuration
worktree stores config in local Git config under northguild.worktree.*.
Common Keys
defaultSourceBranch(example:origin/main)codeEditor(example:code)github.token(GitHub personal access token)jira.host(Your Jira workspace URL, example:https://company.atlassian.net)jira.email(Your Jira email address)jira.apiToken(Jira API token)branchPrefix.feature(example:feature/)branchPrefix.bugfix(example:fix/)branchPrefix.chore(example:chore/)
Commands
worktree config --list
worktree config --missing
worktree config --missing --names defaultSourceBranch,github.token
worktree config defaultSourceBranch origin/main
worktree config codeEditor code
worktree config github.token <token>
worktree config jira.host https://company.atlassian.net
worktree config jira.email your-email@example.com
worktree config jira.apiToken <api-token>
worktree config branchPrefix.feature feature/
worktree config branchPrefix.bugfix fix/
worktree config branchPrefix.chore chore/GitHub Integration Notes
worktree branch --github <issue-number>reads issues from the current repository remote.- Branch prefix keys are optional. If missing,
worktreeuses no prefix. - If
github.tokenis missing,worktreecan attempt to usegh auth tokenand then prompt.
Jira Integration Notes
worktree branch --jira <issue-id>reads issues from your configured Jira workspace.- All three Jira config keys (
jira.host,jira.email,jira.apiToken) are required. - Branch prefix keys are optional. If missing,
worktreeuses no prefix. - Issue IDs are case-insensitive (both
dev-123andDEV-123work).
Recommended Team Baseline
- Agree on one source branch (
origin/mainfor most teams). - Standardize branch naming conventions.
- Keep editor command consistent across local setups.
- For Jira integration, share workspace URL and branch prefix conventions.
Last updated on