A cross-platform Python CLI and library for structured file copying and archiving,
powered by .gitignore-style .cp_ignore rules.
Ideal for transferring clean file sets to cloud storage, portable drives, or mobile devices
without pushing .git or build artifacts — while keeping directories tidy.
- Copy or archive files using
.cp_ignorerules (fully.gitignorecompatible) - Built-in exclusion groups for logs, archives, and databases
- Supports
.zip,.tar,.tar.gz(.tgz) - Unified CLI and Python API (
jh_cp_main) - Zero external dependencies (only
tomliauto-installed on Python 3.10)
✅ Requires Python ≥ 3.10
jh_cp now uses a proper module-folder + __init__.py layout,
so both standard pip install and PEP 517 builds work cleanly.
git clone https://github.com/JeongHan-Bae/jh_cp.git
cd jh_cp
pip install .python -m build
pip install dist/jh_cp-3.0.0-py3-none-any.whljh_cp provides four primary subcommands:
| Command | Purpose |
|---|---|
cp |
Copy files/directories with ignore rules |
archive |
Create .zip/.tar/.tar.gz archives |
cp_ignore |
Manage or edit ignore rules |
tree |
Visualize directory structure with ignore filters |
jh_cp --helpEach subcommand supports --help, e.g. jh_cp archive --help.
jh_cp cp ./my_project ./backup --exclude-log --create-subdirOptions
| Flag | Description |
|---|---|
--create-subdir |
Place contents in a subdirectory named after source |
--exclude-zip |
Skip archives (*.zip, *.tar.gz, *.7z, etc.) |
--exclude-log |
Skip log files (*.log, *.err, *.out) |
--exclude-db |
Skip database files (*.db, *.sqlite, *.sql, etc.) |
-ignore FILE |
Use a custom ignore file instead of .cp_ignore |
jh_cp archive ./src release.tar.gz --exclude-zipSupports .zip, .tar, and .tar.gz (.tgz) formats.
Uses the same ignore/exclude logic as cp.
The tree command lets you easily visualize a project's directory structure —
perfect for documentation, AI-assisted code analysis, or quick inspection.
# Draw structure for current directory (default)
jh_cp tree ./
# Draw structure for a specific folder
jh_cp tree ./include
# Use an existing .gitignore file for filtering
jh_cp tree ./include -ignore .gitignore
jh_cp tree ./src -ignore .gitignoreExample output:
include/
└── jh/
├── core/
│ └── pool.h
└── macros/
└── platform.h
Notes
- Uses the exact same ignore logic as
jh_cp cpandjh_cp archive - Any ignore file (
.gitignore,.cp_ignore, etc.) can be used via-ignore - Supports
--max-depth Nto limit recursion depth - Produces clean, AI-friendly, documentation-ready tree output
jh_cp cp_ignore -ignore '*.tmp' '*.bak'
jh_cp cp_ignore -register 'README.md'
jh_cp cp_ignore -export myrules.txt
jh_cp cp_ignore -reset
jh_cp cp_ignore -nano-ignore— add patterns to ignore-register— add patterns to include (!PATTERN)-export/-reset— manage rule sets-nano— open the ignore file in nano (Unix-like systems only)
Each command performs one action only; do not mix options.
Located at jh_cp/jh_cp_tools/.cp_ignore
Implements .gitignore-style glob patterns and inclusion rules (!pattern).
Extend to see details of .cp_ignore
# ----------------------------------------
# jh_cp Ignore Rules File (.cp_ignore)
# ----------------------------------------
# This file defines which files and directories should be ignored
# when using jh_cp's copy or archive commands.
# Patterns here follow glob-style matching.
# Lines starting with "!" are exceptions (inclusions).
# ----------------------------------------
# ----------------------------------------
# Python bytecode & metadata
# ----------------------------------------
*.py[cod] # Python compiled bytecode (pyc, pyo, etc.)
*.pyc # Explicit .pyc files
*.pyo # Obsolete compiled files
__pycache__/ # Python cache directory
*.egg-info/ # Package metadata (setuptools)
*.egg # Python egg files
pip-wheel-metadata/ # pip build cache
.pytest_cache/ # pytest cache
# ----------------------------------------
# Build & virtual environment directories
# ----------------------------------------
*build*/ # Build directories (wildcard for case-insensitive match)
*Build*/
*BUILD*/
dist/ # Distribution output (wheels, tarballs, etc.)
venv/ # Common virtual environment folder
env/ # Alternative venv folder name
# ----------------------------------------
# System-generated files
# ----------------------------------------
Thumbs.db # Windows thumbnail cache
.DS_Store # macOS folder view settings
*.swp # Vim swap files
*.swo # Vim temporary swap files
*.bak # Backup files
# ----------------------------------------
# Native & compiled binary artifacts
# ----------------------------------------
bin/ # Binary output directory
obj/ # Object files directory
out/ # Output directory
*debug*/ # Debug builds
*release*/ # Release builds
# ----------------------------------------
# Development & project settings
# ----------------------------------------
.vscode/ # VS Code config
.idea/ # JetBrains IDE config
.git/ # Git repo metadata
.svn/ # Subversion metadata
.tox/ # Tox testing environments
.coverage # Coverage report data
node_modules/ # Node.js dependenciesLocated at jh_cp/jh_cp_tools/exclude-rules.ini
Defines grouped patterns for quick exclusions:
[exclude-zip]
patterns = *.zip, *.7z, *.tar, *.tar.gz, *.rar, *.tgz
[exclude-log]
patterns = *.log, *.err, *.out
[exclude-db]
patterns = *.db, *.sqlite, *.sql, *.pg, *.mdbfrom jh_cp import jh_cp_main
jh_cp_main(["cp", "src", "dest", "--exclude-log"])
jh_cp_main(["archive", "src", "output.tar.gz", "--exclude-zip"])
jh_cp_main(["tree", "src"])CLI and API share the same logic and output pipeline.
Color and error handling are performed by Host.print().
pip uninstall jh_cpCleanly removes the CLI and package from your environment.
jh_cp/
├── jh_cp/
│ ├── jh_cp_tools/
│ │ ├── .cp_ignore
│ │ └── exclude-rules.ini
│ ├── __init__.py
│ ├── jh_cp.py
│ └── jh_cp.pyi
├── LICENSE
├── MANIFEST.in
├── pyproject.toml
├── README.md
└── setup.py
- Python ≥ 3.10
- No external dependencies (except
tomlion 3.10) - Works on Windows, macOS, and Linux
For development:
pip install setuptools wheel buildLicensed under the Apache License 2.0 © 2025 JeongHan Bae