Skip to content

Support a .worktreeinclude file #490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
matthewbauer wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Support a .worktreeinclude file #490

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5df63c6
Support a .worktreeinclude file
matthewbauer Apr 1, 2026
906b5e0
Update
matthewbauer Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions agent-shell-worktree.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,34 @@ Or nil if not in a repo."
(unless (string-empty-p trimmed)
trimmed))))

(defcustom agent-shell-worktree-include-filename nil
Copy link
Copy Markdown
Owner

@xenodium xenodium May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like fairly specific behavior. How about we introduce a defcustom agent-shell-worktree-creation-functions abnormal hook, which is a little more versatile? It'll let you accomplish what you want but also enable anyone who may want a different behavior (ie. symlinks)?

"When non-nil, file that contains a list of untracked files in repository
to copy to new worktree.

This is formatted in \".gitignore\" style, so wildcards and similar are
allowed. See https://git-scm.com/docs/gitignore#_pattern_format for more information."
:type '(choice (const nil) (const ".worktreeinclude") string)
:group 'agent-shell)

(defun agent-shell-worktree--copy-worktree-include-files (original-repo worktree)
"Copy untracked files matching patterns in
`agent-shell-worktree-include-filename' from ORIGINAL-REPO to WORKTREE.

If `agent-shell-worktree-include-filename' is unset, does nothing."
(when agent-shell-worktree-include-filename
(let ((file (file-name-concat original-repo agent-shell-worktree-include-filename)))
(when (file-exists-p file)
(let* ((default-directory original-repo)
(output (shell-command-to-string
(format "git ls-files --others --ignored --exclude-from=%s"
(shell-quote-argument file)))))
(dolist (relative-file (split-string output "\n" t))
(let ((src (file-name-concat original-repo relative-file))
(dst (file-name-concat worktree relative-file)))
(when (file-exists-p src)
(make-directory (file-name-directory dst) t)
(copy-file src dst t t t t)))))))))

;;;###autoload
(defun agent-shell-new-worktree-shell ()
"Create a new git worktree and start an agent shell in it.
Expand Down Expand Up @@ -136,6 +164,7 @@ The user is prompted to confirm or edit the worktree path before creation."
(shell-quote-argument worktree-path)))))
(unless (file-exists-p worktree-path)
(user-error "Failed to create worktree: %s" output))
(agent-shell-worktree--copy-worktree-include-files repo-root worktree-path)
(let ((default-directory worktree-path))
(agent-shell '(4))))))

Expand Down