| name | daft-worktree-workflow |
| description | Guides the daft worktree workflow for compartmentalized Git development. Use when working in daft-managed repositories (repos with a .git/ bare directory and branch worktrees as sibling directories), when setting up worktree environment isolation, or when users ask about worktree-based workflows. Covers daft commands, hooks automation via daft.yml, and environment tooling like mise, direnv, nvm, and pyenv. |
daft Worktree Workflow
Core Philosophy
daft treats each Git worktree as a compartmentalized workspace, not just a
branch checked out to disk. Each worktree is a fully isolated environment with
its own:
- Working files and Git index
- Build artifacts (
node_modules/, target/, venv/, .build/)
- IDE state and configuration (
.vscode/, .idea/)
- Environment files (
.envrc, .env)
- Running processes (dev servers, watchers, test runners)
- Installed dependencies (potentially different versions per branch)
This means creating a new worktree is not just "checking out a branch" -- it is
spinning up a new development environment. Automation (via daft.yml hooks)
should install dependencies, configure environment tools, and prepare the
workspace so the developer can start working immediately.
Never use git checkout or git switch to change branches in a daft-managed
repo. Navigate between worktree directories instead.
Detecting a daft-managed Repository
daft supports multiple layouts. The most common is the contained layout:
my-project/
+-- .git/ # Bare repository (shared Git metadata)
+-- main/ # Worktree for the default branch
| +-- src/
| +-- package.json
+-- feature/auth/ # Worktree for a feature branch
| +-- src/
| +-- package.json
+-- bugfix/login/ # Worktree for a bugfix branch
Other layouts you may encounter:
- Sibling (default):
my-project/ + my-project.feature-auth/ as siblings
- Nested:
my-project/.worktrees/feature-auth/ hidden inside the repo
- Centralized: worktrees stored in
~/.local/share/daft/worktrees/
Key indicators of any daft-managed repository:
- Use
git rev-parse --git-common-dir from any worktree to find the shared Git
directory
- Run
daft layout show to see which layout the repo uses
- For contained layout:
.git/ at the project root is a bare repository
(directory, not a file) with branch worktrees as sibling directories
- For other layouts: the main checkout looks like a normal Git repo, but
worktrees are managed by daft elsewhere
If you see any of these patterns, the user is using daft. Apply worktree-aware
guidance throughout the session.
Layouts
daft supports four built-in layouts that control where worktrees are placed:
| Layout | Template | Description |
|---|
contained | {{ repo_path }}/{{ branch }} | Worktrees inside the repo directory |
sibling | {{ repo }}.{{ branch | sanitize }} | Worktrees next to the repo (default) |
nested | {{ repo }}/.worktrees/{{ branch | sanitize }} | Worktrees in a hidden subdirectory |
centralized | {{ daft_data_dir }}/worktrees/{{ repo }}/{{ branch | sanitize }} | Worktrees in a central data directory |
Layout commands:
| Command | Description |
|---|
daft layout show | Show resolved layout for the current repo |
daft layout list | List all available layouts |
daft layout transform <layout> | Convert repo to a different layout |
daft layout default [layout] | View or set global default layout |
Layout is selected at clone time via --layout flag, daft.yml layout field,
global config default, or the built-in default (sibling). Users can also define
custom layouts with templates in ~/.config/daft/config.toml.
The daft.yml file can specify a layout field alongside hooks to set the
team-recommended layout:
layout: contained
hooks:
worktree-post-create:
jobs:
- name: install-deps
run: npm install
Invocation Forms
daft commands can be invoked in three ways:
| Form | Example | Requires |
|---|
| Git subcommand | git worktree-checkout feature/auth | git-worktree-checkout symlink on PATH |
| Direct binary | daft worktree-checkout feature/auth | Only the daft binary |
| Verb alias | daft go feature/auth | Only the daft binary |
| Shortcut alias | gwtco feature/auth | Shortcut symlink on PATH |
The git subcommand form (git worktree-*) is what users type in their terminals
and what documentation references. Shortcuts are optional short aliases managed
via daft setup shortcuts.
Verb Aliases
daft provides short verb aliases for common commands:
| Verb Alias | Equivalent Command |
|---|
daft go | daft worktree-checkout |
daft start | daft worktree-checkout -b |
daft clone | daft worktree-clone |
daft init | daft worktree-init |
daft carry | daft worktree-carry |
daft exec | daft worktree-exec |
daft merge | daft worktree-merge |
daft list | daft worktree-list |
daft update | daft worktree-fetch |
daft prune | daft worktree-prune |
daft remove | daft worktree-branch -d |
daft rename | daft worktree-branch -m |
daft sync | daft git-worktree-sync |
daft adopt | daft worktree-flow-adopt |
daft eject | daft worktree-flow-eject |
Agent execution rule: When running daft commands, always use the direct
binary form (daft <subcommand>) or verb aliases. The git subcommand form
requires symlinks and shell wrappers that are not available in most agent shell
sandboxes. When explaining daft usage to users, reference the git subcommand
form (git worktree-*), verb aliases, or shortcuts, as these are what users
interact with in their configured terminals.
After creating a worktree with daft, the shell does not automatically cd
into it (that requires shell wrappers). Navigate to the new worktree using the
layout convention: cd ../<branch-name>/ relative to any existing worktree.
When running daft repo remove from inside the repo being deleted, the agent's
cwd will be invalidated mid-operation. Either pass an explicit path
(daft repo remove /path/to/repo) and stay outside, or cd to a safe ancestor
first. The binary writes a redirect path to $DAFT_CD_FILE for shell wrappers,
but agent shells typically don't have that wrapper installed, so follow-up
commands will fail with chdir: no such file or directory until the agent's cwd
is fixed.
Command Reference
All commands below use the daft binary form for agent execution. Users know
these as git subcommands (e.g., daft worktree-checkout is
git worktree-checkout to the user).
Worktree Lifecycle
| Command | Description |
|---|
daft worktree-clone <url> [--layout <LAYOUT>] | Clone a remote repository into daft's worktree layout (use --layout to choose: contained, sibling, nested, centralized, or custom) |
daft worktree-init <name> [--layout <LAYOUT>] | Initialize a new local repository in worktree layout (use --layout to choose layout) |
daft worktree-checkout <branch> | Create a worktree for an existing local or remote branch; pass --local to skip the remote fetch even when daft.checkout.fetch is enabled |
daft worktree-checkout -- - | Switch to the previous worktree (cd - style toggle) |
daft worktree-checkout -s <branch> | Same as above, but auto-creates branch if not found (also daft.go.autoStart) |
daft worktree-checkout -b <new-branch> [base] | Create a new branch and worktree from current or specified base; by default does not push (see daft.checkout.push); pass --local to skip remote even when push is enabled |
daft worktree-branch -d <branch> | Safely delete a branch: its worktree and local branch ref; remote branch is deleted only when daft.branchDelete.remote is enabled; pass --local to skip remote, --remote to delete only the remote branch |
daft worktree-branch -D <branch> | Force-delete a branch bypassing safety checks; for the default branch, removes worktree only (preserves branch ref and remote) |
daft worktree-prune [-f] [-v|-vv] [--stat summary|lines] | Remove worktrees whose remote branches have been deleted (-v hook details, -vv full sequential) |
daft worktree-carry <targets> | Transfer uncommitted changes to one or more other worktrees |
daft worktree-fetch [targets] | Update worktree branches from remote (supports refspec syntax source:destination) |
daft worktree-branch -m <source> <new-branch> | Rename a branch, move its worktree, and rename the remote branch |
daft git-worktree-sync [-f] [-v|-vv] [--rebase BRANCH [--autostash]] [--push [--force-with-lease]] [--include VALUE]... [--stat summary|lines] | Synchronize all worktrees: prune stale + update all + optional rebase + optional push (-f/--prune-dirty for dirty worktrees, -v hook details, -vv full sequential). By default, rebase and push apply only to branches you own (matching git config user.email). Use --include to add more branches: unowned for all, an email address for a teammate's branches, or a branch name for one specific branch. |
daft worktree-merge [SOURCE...] [--into <TARGET>] [--merge|--squash|--rebase|--rebase-merge] [-s <STRAT>] [--adopt-target|--no-adopt-target] [-y] [-r] [--set-default] | Merge one or more source branches into a target worktree's branch. Without --into, the target is the current worktree. With --into <target>, merges into another worktree without changing directories. Multiple sources trigger octopus. -r removes the source worktree and branch after success. --adopt-target creates an ephemeral worktree when the target branch has no worktree. --set-default writes style and cleanup to git config --local. Finish with daft worktree-merge --abort|--continue|--quit [<worktree>]. |
Adoption and Ejection
| Command | Description |
|---|
daft worktree-flow-adopt [path] | Convert a traditional repository to daft's worktree layout |
daft worktree-flow-eject | Convert back to a traditional repository layout |
Management
| Command | Description |
|---|
daft worktree-list [--format <FMT>] [-b|-r|-a] [--stat summary|lines] [--columns COLS] | List all worktrees with branch (โฆ = default), path (relative to cwd), base ahead/behind, file status (+N staged, -N unstaged, ?N untracked), remote status (โกN unpushed, โฃN unpulled), branch age, and commit info. Use -b/-r/-a to include local/remote branches without worktrees. Use --format json for machine-readable output; JSON includes is_default_branch, staged, unstaged, untracked, remote_ahead, remote_behind, branch_age, owner_name, owner_email fields. When user.email is configured, output is split into two sections (your branches / other branches) based on the resolved owner per daft.ownership.strategy. Use --columns owner or --columns +owner to show the Owner column (author name of the resolved owner). |
daft worktree-exec [TARGETS]... [--all] [-x CMD]... [-- CMD ARGS]... | Run command(s) across one or more worktrees: positional/glob targets, --all for every worktree, -x for repeatable shell pipelines, trailing -- for direct argv. Parallel by default; --sequential/--keep-going for serial modes. Multi-worktree runs show a live progress row per worktree; failed worktrees' output is dumped to stdout after all complete. |
daft config remote-sync [--on|--off|--status|--global] | Configure remote sync behavior: toggle fetch, push, and remote delete globally or per-repo; no args opens interactive TUI |
daft layout [show|list|transform|default] | Manage worktree layouts: show current, list available, transform between layouts, set global default |
daft hooks <subcommand> | Manage hooks trust and configuration (trust, prompt, deny, status, run, install, validate, dump, migrate, jobs) |
daft hooks jobs [--format <FMT>] [logs|cancel|retry|prune [--dry-run] [--older-than <DUR>]] | Manage background hook jobs: list, view logs, cancel, retry, prune old records. Listing includes a Size column (and size_bytes JSON field) for output.log. prune removes whole invocation records (invocation.json + per-job metadata + logs) past retention; supports --dry-run (preview) and --older-than <DUR> (override retention). An automatic background cleanup (daft __clean-logs) runs at most once every 24h, auto-disabled in CI; opt out with DAFT_NO_LOG_CLEAN=1. Use --format json (or ndjson/tsv/csv/yaml/toon/markdown) for machine-readable output; the listing is a flat table with one row per job carrying invocation context (invocation_id, invocation_short, worktree, hook_type, trigger_command, invocation_created_at). |
daft doctor | Diagnose installation and configuration issues; --fix auto-repairs symlinks, shortcuts, refspecs, hooks; --fix --dry-run previews fixes |
daft setup shortcuts <subcommand> | Manage command shortcut symlinks |
daft repo remove [<path>] [--force|-y] [--dry-run] [-v] | Remove a Git repository entirely: git dir, every checked-out worktree, and the trust marker. Runs worktree-pre-remove and worktree-post-remove lifecycle hooks per worktree. Prompts before deletion unless --force. Refuses paths that are not inside a Git repository. Path defaults to cwd. Note: worktree-post-remove fires AFTER the worktree directory is gone โ $DAFT_WORKTREE_PATH no longer exists at that point. |
daft shell-init <shell> | Generate shell integration wrappers |
daft completions <shell> | Generate shell tab completions |
All worktree commands can be run from any directory within any worktree.
They find the project root automatically via git rev-parse --git-common-dir.
Ad-hoc Commands vs Hooks
For ad-hoc commands across worktrees (without creating a hook), use
daft worktree-exec. For recurring per-worktree automation, use daft.yml
hooks.
Post-setup Command Execution (-x/--exec)
The clone, init, and checkout commands support -x/--exec to run
commands in the new worktree immediately after setup:
daft worktree-clone https://github.com/org/repo -x 'mise install' -x 'npm run dev'
daft worktree-checkout -b my-feature -x claude
daft worktree-init my-project -x 'echo "ready"'
The option is repeatable -- commands run sequentially in the worktree directory,
after hooks complete. Execution stops on first failure. Interactive programs
(claude, vim) work because stdio is fully inherited.
Cross-worktree Merges (daft merge)
daft merge (= daft worktree-merge) performs git merge without forcing you
to git switch into the target branch first. Use it whenever you would
otherwise cd into the target worktree, run git merge, and cd back.
daft merge feature/api --no-edit
daft merge feature/api --into main --no-edit
daft merge feature/a feature/b feature/c --into main --no-edit
daft merge --squash feature/api
daft merge --squash --no-edit feature/api
daft merge --squash -r feature/done --into main --no-edit
daft merge --rebase feature/api --into main
daft merge --rebase-merge feature/api --into main --no-edit
daft merge -s ours --into release feature/old --no-edit
daft merge feature/done --into main -r --no-edit
daft merge feature/done --into main -r --squash --set-default --no-edit
daft merge feature/hotfix --into release/1.2 --adopt-target --no-edit
daft merge feature/hotfix --into release/1.2 -y --no-edit
When to reach for it:
- Landing a feature branch into
main (or another long-lived branch) while you
keep working in the feature worktree.
- Octopus merges across many worktrees without context-switching.
- Scripting merges (
-y auto-accepts prompts; --adopt-target /
--no-adopt-target make adoption explicit).
- Tidy up after a merge (
-r removes the source worktree and branch).
- Persisting workflow preferences with
--set-default.
Common pitfalls to communicate to the user:
- Default style is always-merge-commit. Unlike plain
git merge which
fast-forwards when possible, daft merge always creates a merge commit. Use
--rebase for linear (FF) history. Always pass --no-edit in CI or non-TTY
contexts to avoid an editor prompt.
--squash always commits by default. An editor opens pre-populated with
the squash message. Pass --no-edit to use the message verbatim, or -m to
supply your own. Use --no-commit to stage without committing (incompatible
with -r). Without a TTY and without --no-edit/-m, daft refuses before
merging.
- Target must be clean. By default
daft.merge.requireCleanTarget=true
refuses to merge when the target worktree has uncommitted changes. Ask the
user to commit, stash, or carry those changes first (daft carry <target> is
a natural fit).
- Conflicts do not hijack the shell. On conflict, daft reports the
conflicted files and the exact
--continue / --abort command โ your shell
stays where it was. Resolve in the target worktree, git add, then run
daft merge --continue [<target>]. To bail out, run
daft merge --abort [<target>].
- Squash-staged state. If the squash commit editor is closed without saving,
the squash changes remain staged (squash-staged state). Use
daft merge --continue to re-open the editor, or daft merge --abort to
reset the index.
- Octopus aborts on conflict. Multi-source merges are all-or-nothing;
there's no mid-flight resolution.
-r removes both worktree and branch. For regular merges, uses
git branch -d (safe) semantics. For squash + commit, uses branch -D โ safe
because daft has content-equivalence proof. If the source branch moved during
the editor session, cleanup is refused and a hint is shown.
- Ephemeral target behavior. With no worktree for the target, the default is
to prompt.
--adopt-target accepts without asking; --no-adopt-target
refuses. Configure the default with daft.merge.adoptTargetOnDemand =
prompt | yes | no.
pre-merge and post-merge hooks (see the Hooks section below) fire around the
merge with DAFT_MERGE_* env vars describing sources, target, mode, strategy,
and result.
Shell Integration
Shell integration is important because the daft binary creates worktrees
internally, but the parent shell stays in the original directory. Shell wrappers
solve this by reading the CD target from a temp file (DAFT_CD_FILE) and
running cd in the parent shell.
eval "$(daft shell-init bash)"
daft shell-init fish | source
eval "$(daft shell-init bash --aliases)"
Disable auto-cd per-command with --no-cd or globally with
git config daft.autocd false.
Hooks System (daft.yml)
Hooks automate worktree lifecycle events. The recommended approach is a
daft.yml file at the repository root.
Hook Types
| Hook | Trigger | Runs From |
|---|
post-clone | After daft worktree-clone | New default branch worktree |
worktree-pre-create | Before new worktree is added | Source worktree |
worktree-post-create | After new worktree is created | New worktree |
worktree-pre-remove | Before worktree is removed | Worktree being removed |
worktree-post-remove | After worktree is removed | Current worktree |
pre-merge | After pre-flight checks, before the merge runs | Target worktree |
post-merge | After the merge completes (success or conflict) | Target worktree |
worktree-pre-remove and worktree-post-remove also fire when daft merge -r
cleans up a source worktree after a successful merge. In that context
DAFT_COMMAND=merge (not branch-delete), so scripts can distinguish merge
cleanup from a standalone daft remove.
During daft worktree-clone, hooks fire in this order: post-clone first
(one-time repo bootstrap), then worktree-post-create (per-worktree setup).
This lets post-clone install foundational tools that worktree-post-create
may depend on.
pre-merge aborts the merge on failure (default fail mode: abort);
post-merge logs warnings on failure but never rolls back the merge (default:
warn). Both expose DAFT_MERGE_* env vars: SOURCES, TARGET_BRANCH,
TARGET_PATH, MODE (merge/ff/squash/octopus), STRATEGY,
EPHEMERAL, CROSS_WORKTREE, SOURCE_SHAS (space-separated SHA list of source
tips captured before merge). post-merge additionally gets RESULT
(success/conflict/already-up-to-date/aborted), COMMIT_SHA,
CONFLICTED_FILES (newline-separated), and PROMOTED_FROM_EPHEMERAL.
RESULT=aborted fires when a squash commit is abandoned (editor closed without
saving, pre-commit hook fail, GPG-sign fail); COMMIT_SHA is empty in this
case. Neither hook fires when the merge is a no-op (already up to date).
daft.yml Format
min_version: "1.5.0"
hooks:
worktree-post-create:
parallel: true
jobs:
- name: install-deps
run: npm install
- name: setup-env
run: cp .env.example .env
Config File Locations (first match wins)
daft.yml, daft.yaml, .daft.yml, .daft.yaml, .config/daft.yml,
.config/daft.yaml
Additionally: daft-local.yml for machine-specific overrides (not committed),
and per-hook files like worktree-post-create.yml.
Execution Modes
Set one per hook (default is parallel):
| Mode | Field | Behavior |
|---|
| Parallel | parallel: true | All jobs run concurrently |
| Piped | piped: true | Sequential; stop on first failure |
| Follow | follow: true | Sequential; continue on failure |
Job Fields
- name: job-name
description: "Install npm dependencies"
run: "npm install"
runner: "bash"
root: "frontend"
env:
NODE_ENV: development
tags: ["build"]
skip: CI
only: DEPLOY_ENABLED
os: linux
arch: x86_64
needs: [install-npm]
tracks: [path, branch]
interactive: true
priority: 1
fail_text: "Setup failed"
background: true
background_output: log
log:
retention: "7d"
path: "./logs/job.log"
Job Dependencies
hooks:
worktree-post-create:
jobs:
- name: install-npm
run: npm install
- name: install-pip
run: pip install -r requirements.txt
- name: build
run: npm run build
needs: [install-npm]
- name: test
run: npm test
needs: [build, install-pip]
Independent jobs (install-npm, install-pip) run in parallel. Dependent jobs
wait for their dependencies.
Background Jobs
Jobs with background: true run asynchronously after the command returns, so
the user can start working while long-running tasks complete. A coordinator
process manages background jobs and writes output to log files.
hooks:
worktree-post-create:
jobs:
- name: install deps
run: pnpm install
- name: warm build cache
run: cargo build
background: true
needs: [install deps]
Key behaviors:
- Background jobs participate in the DAG. If a foreground job depends on a
background job, the background job is promoted to foreground automatically.
needs: between background jobs is honored at runtime โ the coordinator
schedules them in topological wave order. A background job with
needs: [other-bg-job] does not start until other-bg-job has terminated.
- If a
needs: dependency fails or is cancelled, the dependent background job
does not run; it is recorded as Skipped in daft hooks jobs listings.
background: true can be set at the hook level as a default for all jobs.
DAFT_NO_BACKGROUND_JOBS=1 promotes all background jobs to foreground (useful
in CI or for debugging).
daft hooks jobs lists, cancels, retries, and prunes old background-job
records.
- When a worktree is removed, running background jobs for it are cancelled.
When generating daft.yml configurations, mark jobs as background: true when
they warm caches, pre-build, or perform other tasks whose results are not needed
immediately.
Groups
A job can contain a nested group with its own execution mode:
- name: checks
group:
parallel: true
jobs:
- name: lint
run: cargo clippy
- name: format
run: cargo fmt --check
Template Variables
Available in run commands:
| Variable | Description |
|---|
{branch} | Target branch name |
{worktree_path} | Path to the target worktree |
{worktree_root} | Project root directory |
{source_worktree} | Path to the source worktree |
{git_dir} | Path to the .git directory |
{remote} | Remote name (usually origin) |
{job_name} | Name of the current job |
{base_branch} | Base branch (for checkout -b commands) |
{repository_url} | Repository URL (for post-clone) |
{default_branch} | Default branch name (for post-clone) |
{old_worktree_path} | Previous worktree path (move hooks only) |
{old_branch} | Previous branch name (move hooks only) |
Skip and Only Conditions
skip: CI
skip: true
skip:
- merge
- rebase
- ref: "release/*"
- env: SKIP_HOOKS
- run: "test -f .skip-hooks"
desc: "Skip file exists"
only:
- env: DEPLOY_ENABLED
- ref: "main"
Trust Management
Hooks from untrusted repos do not run automatically. Manage trust with:
daft hooks trust
daft hooks prompt
daft hooks deny
daft hooks status
daft hooks install
daft hooks validate
daft hooks dump
daft hooks run <type>
Manual Hook Execution
Run hooks on demand, bypassing trust checks (the user is explicitly invoking):
daft hooks run worktree-post-create
daft hooks run worktree-post-create --job "mise"
daft hooks run worktree-post-create --tag setup
daft hooks run worktree-post-create --dry-run
daft hooks run worktree-post-create --verbose
Use cases: re-running after a failure, iterating during hook development, or
bootstrapping existing worktrees that predate the hooks config.
Move Hooks
When a worktree is moved (rename via daft worktree-branch -m, layout transform
via daft layout transform, or adopt via daft worktree-flow-adopt), daft
replays identity-tracked hooks to tear down the old environment and set up the
new one.
Flow: worktree-pre-remove (old identity) -> worktree-post-remove (old
identity) -> move on disk -> worktree-pre-create (new identity) ->
worktree-post-create (new identity). Only tracked jobs run.
tracks field: Declares which attributes a job depends on.
- name: link-output
run: ln -sf {worktree_path}/dist /opt/builds/current
tracks: [path]
- name: set-branch-env
run: echo "BRANCH={branch}" > .env.branch
tracks: [branch]
- name: install-deps
run: npm install
Implicit tracking: If tracks is omitted, daft infers it from template
usage -- {worktree_path} implies path, {branch}/{worktree_branch}
implies branch. Explicit tracks overrides inference.
Dependency pull-in: Jobs listed in needs of a tracked job are included in
the move even if not tracked themselves.
Failure handling: Hook failures during moves produce warnings, not errors.
The move always completes.
Move-only template variables: {old_worktree_path}, {old_branch} --
available only when DAFT_IS_MOVE is true.
Move-only environment variables: DAFT_IS_MOVE (true during move hooks),
DAFT_OLD_WORKTREE_PATH, DAFT_OLD_BRANCH_NAME.
Environment Variables in Hooks
All hooks receive: DAFT_HOOK, DAFT_COMMAND, DAFT_PROJECT_ROOT,
DAFT_GIT_DIR, DAFT_REMOTE, DAFT_SOURCE_WORKTREE.
Worktree hooks add: DAFT_WORKTREE_PATH, DAFT_BRANCH_NAME.
Creation hooks add: DAFT_IS_NEW_BRANCH, DAFT_BASE_BRANCH.
Clone hooks add: DAFT_REPOSITORY_URL, DAFT_DEFAULT_BRANCH.
Removal hooks add: DAFT_REMOVAL_REASON (remote-deleted, manual, or
ejecting).
Move hooks add: DAFT_IS_MOVE, DAFT_OLD_WORKTREE_PATH,
DAFT_OLD_BRANCH_NAME.
Environment Tool Detection and Setup
When working in a daft repo, detect environment tools by their marker files and
suggest daft.yml hooks to automate setup for new worktrees.
Tool Detection Table
| Tool | Marker Files | Purpose |
|---|
| mise | .mise.toml, .tool-versions | Polyglot runtime manager (Node, Python, Ruby, Go, etc.) |
| direnv | .envrc | Per-directory environment variables |
| nvm / fnm | .nvmrc, .node-version | Node.js version management |
| pyenv | .python-version | Python version management |
| rbenv | .ruby-version | Ruby version management |
| Docker | Dockerfile, docker-compose.yml, compose.yml | Containerized development |
| npm | package.json, package-lock.json | Node.js dependencies |
| yarn | yarn.lock | Node.js dependencies (Yarn) |
| pnpm | pnpm-lock.yaml | Node.js dependencies (pnpm) |
| pip | requirements.txt, pyproject.toml, setup.py | Python dependencies |
| Cargo | Cargo.toml, Cargo.lock | Rust dependencies |
| Go modules | go.mod, go.sum | Go dependencies |
| Bundler | Gemfile, Gemfile.lock | Ruby dependencies |
| Composer | composer.json, composer.lock | PHP dependencies |
Hook Jobs for Detected Tools
mise (if .mise.toml or .tool-versions exists):
- name: mise-install
run: mise install
direnv (if .envrc exists):
- name: direnv-allow
run: direnv allow .
nvm (if .nvmrc or .node-version exists):
- name: nvm-use
run: |
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"
nvm install
npm (if package.json exists):
- name: npm-install
run: npm install
pip with venv (if requirements.txt exists):
- name: pip-install
run: |
python -m venv .venv
. .venv/bin/activate
pip install -r requirements.txt
Cargo (if Cargo.toml exists):
- name: cargo-build
run: cargo build
Comprehensive Example
For a project using mise, direnv, and npm:
hooks:
post-clone:
piped: true
jobs:
- name: mise-install
run: mise install
- name: direnv-allow
run: direnv allow .
- name: npm-install
run: npm install
needs: [mise-install]
- name: setup-env
run: cp .env.example .env
worktree-post-create:
jobs:
- name: mise-install
run: mise install
- name: direnv-allow
run: direnv allow .
- name: npm-install
run: npm install
needs: [mise-install]
Suggesting Tooling for Repos That Lack It
When a daft-managed repo has no daft.yml, check for dependency files and
suggest creating one. A worktree-post-create hook that installs dependencies
is the most impactful automation to add.
Starter Configurations
Node.js project (detected via package.json):
hooks:
worktree-post-create:
jobs:
- name: install-deps
run: npm install
Python project (detected via requirements.txt or pyproject.toml):
hooks:
worktree-post-create:
jobs:
- name: install-deps
run: |
python -m venv .venv
. .venv/bin/activate
pip install -r requirements.txt
Rust project (detected via Cargo.toml):
hooks:
worktree-post-create:
jobs:
- name: build
run: cargo build
Go project (detected via go.mod):
hooks:
worktree-post-create:
jobs:
- name: download-deps
run: go mod download
When suggesting daft.yml, also remind the user to trust the repo:
daft hooks trust.
Workflow Guidance for Agents
When working in a daft-managed repository, apply these translations:
| User intent | Correct daft approach |
|---|
| "Create a branch" | daft worktree-checkout -b <name> -- creates branch + worktree + pushes |
| "Branch from main" | daft worktree-checkout -b <name> main -- branches from the specified base |
| "Switch to branch X" | Navigate to the worktree directory: cd ../X/ |
| "Go back" | daft worktree-checkout -- - -- toggles to the previous worktree |
| "Check out a PR" | daft worktree-checkout <branch> -- creates worktree for existing branch |
| "Delete a branch" | daft worktree-branch -d <branch> -- removes worktree, local branch, and remote tracking branch |
| "Clean up branches" | daft worktree-prune -- removes worktrees for deleted remote branches |
| "Wrong branch" | daft worktree-carry <correct-branch> -- moves uncommitted changes |
| "Update from remote" | daft worktree-fetch -- updates current or specified worktrees (use source:dest for cross-branch) |
| "Run my build on these worktrees" | daft worktree-exec feat/a feat/b -- <cmd> or daft exec --all -- <cmd> for every worktree |
| "Adopt existing repo" | daft worktree-flow-adopt -- converts traditional repo to daft layout |
Per-worktree Isolation
Each worktree has its own node_modules/, .venv/, target/, etc. When a
new worktree is created without daft.yml hooks, dependencies are not installed
automatically. If the user creates a new worktree and encounters
missing-dependency errors, the fix is to run the appropriate install command in
that worktree (e.g., npm install, pip install -r requirements.txt).
Navigating Worktrees
From any worktree, sibling worktrees are at ../<branch-name>/. The project
root (containing .git/) is at .. relative to any top-level worktree. Use
git rev-parse --git-common-dir to programmatically find the root.
Modifying Shared Files
Files like daft.yml, .gitignore, and CI configuration live in each worktree
independently (they are part of the Git-tracked content). Changes to these files
in one worktree must be committed and merged to propagate to other worktrees.
Shortcuts
daft supports three shortcut styles as symlink aliases for faster terminal use:
| Style | Shortcuts | Example |
|---|
| Git (default) | gwtclone, gwtinit, gwtco, gwtcb, gwtbd, gwtprune, gwtcarry, gwtfetch, gwtls, gwtsync | gwtco feature/auth |
| Shell | gwco, gwcob | gwco feature/auth |
| Legacy | gclone, gcw, gcbw, gprune | gcw feature/auth |
The gwtcb, gwcob, and gcbw shortcuts map to git-worktree-checkout -b
(branch creation mode).
Default-branch shortcuts (gwtcm, gwtcbm, gwcobd, gcbdw) are available
via shell integration only (daft shell-init). They resolve the remote's
default branch dynamically and use git-worktree-checkout -b.
Shell integration also provides gwtrn (maps to daft rename) and gwtsync
(maps to git-worktree-sync) as shell functions with cd behavior.
Manage with daft setup shortcuts list, enable <style>, disable <style>,
only <style>.
When a user asks how to use daft more efficiently, mention shortcuts as a
convenience option. Agents should never execute shortcuts directly -- always use
the daft binary form (see Invocation Forms).
Configuration Reference
Key git config settings:
Local-first defaults: daft does not contact the remote by default. Remote
operations are opt-in via daft config remote-sync or the individual settings
below. Use daft config remote-sync --on to re-enable all remote operations at
once, or --local on any command to suppress remote operations for a single
invocation.
| Key | Default | Description |
|---|
daft.autocd | true | CD into new worktrees via shell wrappers |
daft.remote | "origin" | Default remote name |
daft.checkout.fetch | false | Fetch from remote before checking out an existing branch |
daft.checkout.push | false | Push new branches to remote after creation |
daft.branchDelete.remote | false | Delete the remote branch when removing a local branch |
daft.checkout.upstream | true | Set upstream tracking |
daft.checkout.carry | false | Carry uncommitted changes on checkout |
daft.checkoutBranch.carry | true | Carry uncommitted changes on branch creation |
daft.update.args | "--ff-only" | Default pull arguments for update (same-branch mode) |
daft.prune.cdTarget | "root" | Where to cd after pruning (root or default-branch) |
daft.list.stat | "summary" | Statistics mode for list (summary or lines) |
daft.sync.stat | "summary" | Statistics mode for sync (summary or lines) |
daft.prune.stat | "summary" | Statistics mode for prune (summary or lines) |
daft.list.columns | (all columns) | Default columns for daft list (same syntax as --columns) |
daft.sync.columns | (all columns) | Default columns for daft sync summary table |
daft.prune.columns | (all columns) | Default columns for daft prune summary table |
daft.list.sort | "+branch" | Default sort order for daft list (same syntax as --sort) |
daft.sync.sort | "+branch" | Default sort order for daft sync |
daft.prune.sort | "+branch" | Default sort order for daft prune |
daft.go.autoStart | false | Auto-create worktree when branch not found in go |
daft.hooks.enabled | true | Master switch for hooks |
daft.hooks.defaultTrust | "deny" | Default trust for unknown repos |
daft.hooks.timeout | 300 | Hook timeout in seconds |
daft.ownership.strategy | "recency-plurality" | Strategy for deducing branch ownership from base..branch commits. Values: tip, any, first, plurality, majority, recency-plurality. |
Branch ownership
Branch ownership in list / sync / prune is deduced from the base..branch
commit range using a user-configurable strategy (git config
daft.ownership.strategy, default recency-plurality). The Owner column shows
the author name of the resolved owner. daft sync --rebase/--push only
operate on branches owned by you (matching user.email). Use
--include <email> / --include unowned to override.
Available strategies:
tip โ author of the newest commit. Simple, but flips on any drive-by
commit.
any โ you own the branch if any commit in range is yours.
first โ author of the oldest commit ("who started this branch").
plurality โ author with the most commits in range.
majority โ author with strictly more than 50% of commits; no owner
otherwise.
recency-plurality (default) โ highest recency-weighted score; each
commit at rank k from tip contributes weight 1/(k+1). Robust to drive-by
commits while still favoring recent work.
JSON "owner" field is {name, email} or null (breaking change: the field
previously carried just the tip-author email string).
Column Selection (--columns)
The list, sync, and prune commands support a --columns flag to control
which columns appear in the output table and in what order.
Valid column names
Default columns (shown unless removed): annotation, branch, path,
base, changes, remote, age, owner, last-commit
Optional columns (must be explicitly added): size, hash
The size column shows the disk size of each worktree folder in human-readable
format (e.g. 42K, 1.3M, 2.5G). When visible, a summary footer row displays
the total size across all worktrees.
The hash column shows the abbreviated (7-char) commit hash of each worktree's
HEAD commit.
Two modes
Replace mode โ provide an exact comma-separated list; only those columns
appear, in that order:
daft list --columns branch,path,age
daft sync --columns branch,path,status,age
Modifier mode โ prefix columns with + (add) or - (remove) to adjust the
defaults:
daft list --columns -annotation,-last-commit
daft list --columns +base,-age
daft list --columns +size
Modifier mode is detected automatically when every entry starts with + or -.
Pinned columns on sync and prune
The status column (showing pruned/updated/skipped) is always displayed on
sync and prune and cannot be controlled via --columns.
Persistent defaults via git config
Set a default so you never need to pass the flag manually:
git config daft.list.columns "branch,path,age"
git config daft.sync.columns "-annotation,-last-commit"
git config daft.prune.columns "branch,path,age"
The --columns flag overrides the git config value for that invocation.
Sorting (--sort)
The list, sync, and prune commands support a --sort flag to control the
sort order of the output.
Sortable columns
branch, path, size, age, owner, hash, activity, commit
activity considers both committed and uncommitted file changes (working tree
mtime). commit (alias: last-commit) sorts by last commit time only.
Syntax
Prefix with + (ascending, the default) or - (descending). Multiple columns
can be comma-separated for multi-level sort:
daft list --sort branch
daft list --sort -activity
daft list --sort -commit
daft list --sort +owner,-size
You can sort by columns not shown in the output (e.g., --sort -size without
--columns +size). The sort data is collected automatically.
Persistent defaults via git config
git config daft.list.sort "-activity"
git config daft.sync.sort "+owner,-size"
git config daft.prune.sort "+branch"
The --sort flag overrides the git config value for that invocation.
Structured output
Seven daft commands emit machine-readable output via --format:
- Flat-list:
list, hooks trust list, layout list
- Document:
release-notes
- Matrix:
shared status
- Sectioned:
multi-remote status, hooks run (listing mode)
Valid formats: json, ndjson, tsv, csv, yaml, toon, markdown.
Unsupported combinations print a clear error listing the supported set.
Use --template '<tera-template>' for custom output. Tera syntax: {{ var }},
{% for x in items %}...{% endfor %}, {% if %}...{% endif %}.
Cache files
daft list writes content-addressed JSON caches under
<git-common-dir>/.daft/cache/<kind>/ so warm-cache runs avoid re-forking slow
git commands. Each entry's filename embeds the SHAs that fully define its inputs
(e.g. <base_sha>-<head_sha>.json for ahead/behind counts), so a cache hit is
provably correct โ there is no TTL or manual invalidation. The cache is safe to
delete at any time; daft will re-populate it on the next run.
Cached cells: base/remote ahead-behind, base/remote line stats, last-commit
metadata. Working-tree-dependent cells (Changes, Size) are NOT cached
because their inputs cannot be captured as a SHA โ they always recompute and
show the ยท skeleton glyph until the result arrives.