Archive CLI

A simple and interactive command-line tool for creating and extracting archives. Features intelligent path completion and supports both tar.gz and zip formats.

Features

• Interactive prompts with tab completion for file/directory paths
• Dual format support: Create and extract tar.gz and zip archives
• Auto-generated naming: Archives and extraction directories use timestamp-based names
• Format detection: Automatically detects archive format when extracting
• Professional structure: Clean, modular codebase with separation of concerns

Installation

# Install dependencies
uv sync

# Install as a CLI tool (optional)
uv pip install -e .

Usage

Basic Commands

# Using uv run
PYTHONPATH=src uv run python -m archive_cli.archive_cli --help

# If installed as CLI tool
archive-cli --help

Creating Archives

# Start the archive command
PYTHONPATH=src uv run python -m archive_cli.archive_cli archive

# Or if installed as CLI tool
archive-cli archive

The tool will prompt you to:

1. Select a directory to archive (with tab completion)
2. Choose archive format (tar or zip)
3. Archives are created in current directory with format: {dirname}_{timestamp}.{ext}

Extracting Archives

# Start the unarchive command
PYTHONPATH=src uv run python -m archive_cli.archive_cli unarchive

# Or if installed as CLI tool
archive-cli unarchive

The tool will prompt you to:

1. Select an archive file to extract (with tab completion)
2. Archive format is auto-detected
3. Contents are extracted to: {archive_name}_{timestamp}/

Supported Formats

Archive Creation

• tar: Creates .tar.gz compressed archives
• zip: Creates .zip compressed archives

Archive Extraction

• tar: Supports .tar, .tar.gz, .tgz files
• zip: Supports .zip files

Examples

# Example workflow
PYTHONPATH=src uv run python -m archive_cli.archive_cli archive
# Enter path: ./my_project
# Choose format: tar
# Creates: my_project_20240916_143052.tar.gz

PYTHONPATH=src uv run python -m archive_cli.archive_cli unarchive
# Enter path: ./my_project_20240916_143052.tar.gz
# Extracts to: my_project_20240916_143127/

Development

This project uses uv for dependency management and follows a modular structure:

src/archive_cli/
\x00\x00 __init__.py
\x00\x00 archive_cli.py          # Main CLI entry point
\x00\x00 cmd/                    # Command implementations
   \x00\x00 __init__.py
   \x00\x00 archive.py         # Archive creation logic
   \x00\x00 unarchive.py       # Archive extraction logic
\x00\x00 lib/                   # Shared utilities
    \x00\x00 __init__.py
    \x00\x00 prompt.py          # Interactive prompt functions