pylistall 0.2.1

Copy file contents under a directory to clipboard with tree and optional git log.

pylistall

中文说明

pylistall is a cross-platform command-line tool that collects file contents under a directory and copies them to the system clipboard in a structured format.

It also prints the absolute path and a tree-style directory structure. If the directory contains a .git repository, it can optionally include the Git commit log.

This tool is designed for efficiently sharing project context with AI tools, debugging, documentation, or code review.

---

Features

• Copy file contents directly to clipboard

• Tree-style directory structure output (by default, only files in the current directory are included)

• Display absolute path

• Recursive traversal of subdirectories (optional, disabled by default)

• Include or exclude files using glob patterns (optional, includes all non-binary files by default)

• Include binary files (optional, disabled by default)

• Include Git log (optional, disabled by default)

• Cross-platform support:

  • macOS (pbcopy)
  • Windows (clip)
  • Linux (xclip or pyperclip fallback)

---

Installation

From the project root (where pyproject.toml is located):

python -m pip install .

Verify installation:

pylistall --help

Uninstall:

python -m pip uninstall pylistall

---

Usage

pylistall [path] [options]

If path is not provided, the current directory (.) is used.

---

Output Format

Example:

STRUCTURE:
/Users/example/project
├── main.py
└── utils.py

GIT LOG:
a1b2c3d (HEAD -> main) Initial commit

`main.py`:
```

print("Hello")

```

`utils.py`:
```

def func():
    pass

```

---

Options

Recursive traversal

-r, --recursive

Recursively include files in subdirectories. Optional, disabled by default. When enabled, both the tree structure and copied file contents will include files from the current directory, subdirectories, and all nested subdirectories.

Example:

pylistall -r

---

Include binary files

-b, --binary

Include binary files. Optional, disabled by default. When enabled, binary file contents will be included like regular files. Regardless of whether this option is enabled, binary file names will always appear in the tree structure.

Example:

pylistall -b

---

Include Git log

-g, --git-log [N]

Optional, disabled by default. Behavior depends on usage:

Command	Result
no -g	do not include Git log
-g	include all Git log entries
-g N	include the last N Git log entries

Examples:

pylistall -g

pylistall -g 5

When enabled, if the ROOT directory does not contain a .git folder, a message will be shown.

---

Include only specific files

-i, --include PATTERN

Include only files matching glob patterns. Optional, disabled by default. When enabled, both the tree structure and copied file contents will include only the selected files. Multiple patterns can be separated by commas.

Examples:

pylistall -i "*.py"

pylistall -i "*.py,README.md"

---

Omit specific files

-o, --omit PATTERN

Exclude files matching glob patterns. Optional, disabled by default. When enabled, both the tree structure and copied file contents will exclude the selected files. Multiple patterns can be separated by commas.

Examples:

pylistall -o "*.log"

pylistall -o "*.log,*.tmp"

---

Limit file read size

--max-bytes N

Limit the maximum number of bytes read per file. Optional, disabled by default. When enabled, reading of each file will be limited to at most N bytes.

Example:

pylistall --max-bytes 10000

---

Examples

Basic usage:

pylistall

Recursive traversal with Git log:

pylistall -r -g 3

Include binary files:

pylistall -b

Include only Python files:

pylistall -i "*.py"

Exclude test files:

pylistall -o "test_*"

---

Clipboard Support

Platform-specific clipboard backends:

Platform	Backend
macOS	pbcopy
Windows	clip
Linux	xclip / pyperclip

No additional configuration is required on macOS or Windows.

---

Requirements

Python 3.9 or higher

---

License

MIT License