API Reference Trebejo v#2.0.0

Copy Markdown View Source

Modules

Trebejo — Shell command wrappers and system utilities.

OTP application entry point for Trebejo.

Circuit-breaker integration for Trebejo commands.

Universal compression and archive utilities.

Single-file compression algorithms: zstd, xz, bzip2.

Detects archive/compression format from file extensions and lists archive contents.

GZIP compression and decompression.

RAR archive operations — create and extract.

7-Zip archive operations — create and extract.

TAR archive operations — create and extract with optional compression.

ZIP archive operations — create and extract.

Docker / Podman container lifecycle management.

Typed error wrapper for Trebejo command failures.

File system watching backed by Apero.File.Watcher and Arrea.WorkerSupervisor.

I/O operations that depend on shell commands.

Git utilities for repository management, configuration and synchronisation.

Git credential and SSH key configuration helpers.

Local Git operations — clone, commit, pull, push, branch, stash, merge, etc.

Git branch operations — checkout, current branch, stash, create, delete.

Git repository cloning, update and existence-check operations.

Git configuration operations — reading and writing config values, user info, system info and hostname.

Git history operations — log, blame, diff, churn, commit info.

Git merge conflict operations — conflict detection, merge abort, marking files as resolved, and related merge/revert/squash operations.

Git repository synchronization operations — checkout, fetch and pull.

Utility functions for Git operations — command execution, shell quoting, CLI availability checks, and credential setup.

GitHub CLI wrapper around gh.

Shell-based image operations: sixel rendering, ASCII conversion, and format conversion via external tools.

Thin wrapper over kubectl for common operations.

Test-only mocking layer for Trebejo command execution.

Network operations: TCP port checks and ICMP ping.

Operating system information utilities (shell-based).

Package installation and querying — via Arrea.Command.

PostgreSQL client wrapper around psql, pg_dump, and pg_restore.

Process and executable utilities (shell-based operations).

Redis client wrapper around redis-cli.

Behaviour for executing external commands.

SSH wrapper for remote command execution and file transfer.

Safe wrapper around Arrea.Command.execute/2.

Streaming wrapper around Port.open/2 for long-running commands.

Shared utilities for Trebejo modules.