Module Index

Overview of all Copybara modules with their primary functions.

Core Modules

Module	Key Functions	Description
core	workflow, move, replace, remove, copy	Workflows and file transformations
git	origin, destination, github_origin, github_pr_origin	Git endpoints and operations
metadata	squash_notes, scrubber, map_author, expose_label	Commit message transformations
authoring	pass_thru, overwrite, allowed	Author handling modes

File & Archive Modules

Module	Key Functions	Description
glob	glob(include, exclude)	File pattern matching
archive	create, extract	ZIP, TAR, JAR operations
patch	apply, quilt_apply	Apply patch files

Build System Modules

Module	Key Functions	Description
buildozer	create, delete, modify, cmd	Bazel BUILD manipulation
go	Go-specific operations	Go module handling
rust	Rust-specific operations	Cargo/crate handling
python	parse_metadata	PyPI metadata parsing

Data Format Modules

Module	Key Functions	Description
format	buildifier	Code formatting
toml	TOML parsing	Config file handling
xml	XML operations	XML transformations
html	xpath	HTML element selection

Network & Remote Modules

Module	Key Functions	Description
http	HTTP operations	API interactions
remotefiles	Remote file fetching	Download dependencies

Utility Modules

Module	Key Functions	Description
re2	compile, quote	Regex patterns
datetime	now, fromtimestamp	Date/time handling
hashing	path_sha256_sum, str_sha256_sum	Checksums

Common Patterns

Basic Workflow

core.workflow(
    name = "default",
    origin = git.origin(url = "...", ref = "main"),
    destination = git.destination(url = "..."),
    origin_files = glob(["src/**"]),
    authoring = authoring.pass_thru("Bot <bot@example.com>"),
    transformations = [...],
)

File Operations

transformations = [
    core.move("old/path", "new/path"),
    core.copy("src/template", "src/generated"),
    core.remove(glob(["**/*.bak"])),
    core.replace(before = "old", after = "new"),
]

Metadata Operations

transformations = [
    metadata.squash_notes(prefix = "Import:\n"),
    metadata.scrubber("CONFIDENTIAL:.*"),
    metadata.add_header("Source: internal"),
]

CLI Quick Reference

# Run workflow
copybara migrate copy.bara.sky [workflow-name]

# Dry run
copybara migrate copy.bara.sky --dry-run

# From specific revision
copybara migrate copy.bara.sky --last-rev abc123

# Ignore no-op
copybara migrate copy.bara.sky --ignore-noop

# Validate config
copybara validate copy.bara.sky

Next Steps

• CLI reference - Complete command options
• Glossary - Term definitions