Getting Started

worktree streamlines common Git worktree tasks into a repeatable workflow.

Install

Install globally:

npm install -g @northguild/worktree

pnpm add -g @northguild/worktree

yarn global add @northguild/worktree

bun add -g @northguild/worktree

Or run directly without global install:

npx @northguild/worktree —help

pnpm dlx @northguild/worktree —help

yarn dlx @northguild/worktree —help

bunx @northguild/worktree —help

Initial Configuration

Run once inside your repository:

worktree config

Common values:

• defaultSourceBranch: usually origin/main
• codeEditor: usually code

First Workflow

Create your first branch worktree:

worktree branch feature/improve-readme

This command will:

1. Branch from your configured source branch.
2. Create a worktree under <repo>.worktrees/feature/improve-readme.
3. Copy .env and .env.local from your main repository.
4. Open the new worktree in your configured editor.

Requirements

• Git available on your PATH
• Node.js installed
• Existing Git repository

If you use automatic editor opening, ensure your editor command is available in your shell (for example, code).

Next

• Command Reference
• Configuration
• Guides