pypet-cli 0.5.0

A modern command-line snippet manager with Git synchronization, clipboard integration, and parameterized commands

pypet - Command Line Snippet Manager

pypet is a Python-based command-line snippet manager inspired by pet. It helps you organize and reuse command-line snippets efficiently, with a focus on simplicity and usability.

Features

• Store command snippets with descriptions and tags
• TOML-based storage (~/.config/pypet/snippets.toml)
• List and search your snippets with rich terminal output
• Interactive command execution with pre-execution editing
• Copy snippets to clipboard for easy pasting into other applications
• Shell aliases - create persistent bash/zsh aliases from snippets
• Git synchronization for backup and sharing across devices
• Parameterized snippets with default values
• Automatic backup and restore functionality
• Tag-based organization
• Modern Python implementation with type hints
• Comprehensive test coverage

Installation

PyPI (Recommended)

pip install pypet-cli

Development Installation

# Clone repository
git clone https://github.com/fabiandistler/pypet.git
cd pypet

# Install with uv (recommended)
uv pip install -e .

# Or with pip
pip install -e .

Requirements

• Python 3.10 or higher
• Git (for synchronization features)

Usage

Basic Commands

# List all snippets
pypet list

# Add a new snippet
pypet new "git commit -m" -d "Create a git commit" -t "git,version-control"

# Save clipboard content as a snippet
pypet save-clipboard -d "Description" -t "tag1,tag2"

# Save last command(s) from shell history
pypet save-last                    # Save last command
pypet save-last -n 3               # Save last 3 commands

# Search snippets
pypet search "git"

# Execute a snippet (interactive if no ID provided)
pypet exec [snippet-id]

# Execute with editing
pypet exec [snippet-id] -e

# Copy a snippet to clipboard
pypet copy [snippet-id]

# Execute with copy to clipboard option
pypet exec [snippet-id] --copy

# Edit a snippet
pypet edit <snippet-id>

# Edit the snippets configuration file directly
pypet edit --file

# Delete a snippet
pypet delete <snippet-id>

# Alias management
pypet alias add <snippet-id> <alias-name>    # Add alias to snippet
pypet alias list                              # List all aliases
pypet alias remove <snippet-id>               # Remove alias from snippet
pypet alias setup                             # Show setup instructions

# Git synchronization
pypet sync init                    # Initialize Git repository
pypet sync remote <repo-url>       # Add/update remote repository
pypet sync status                  # Show sync status
pypet sync commit -m "message"     # Commit changes
pypet sync pull                    # Pull from remote
pypet sync push                    # Push to remote
pypet sync sync                    # Full sync (commit + pull + push)

Parameterized Snippets

You can create snippets with customizable parameters:

# Create a snippet with parameters
pypet new "docker run -p {port}:80 -v {path}:/app -e NODE_ENV={env=development} {image}" \
    -d "Run a Docker container with custom settings" \
    -t "docker,container" \
    -p "port:Host port to bind,path:Volume path,env=development:Node environment,image:Docker image name"

# Execute with parameter values
pypet exec <snippet-id> -P port=3000 -P path=$PWD -P image=node:18-alpine

# Or execute interactively (will prompt for parameter values)
pypet exec <snippet-id>

Parameters can have:

• Required values: {name}
• Default values: {name=default}
• Descriptions (shown when prompting)

Example TOML storage for a parameterized snippet:

[snippets.unique-id]
command = "docker run -p {port}:80 -v {path}:/app -e NODE_ENV={env=development} {image}"
description = "Run a Docker container with custom settings"
tags = ["docker", "container"]
created_at = "2025-06-17T10:00:00+00:00"
updated_at = "2025-06-17T10:00:00+00:00"

[snippets.unique-id.parameters.port]
name = "port"
description = "Host port to bind"

[snippets.unique-id.parameters.path]
name = "path"
description = "Volume path"

[snippets.unique-id.parameters.env]
name = "env"
default = "development"
description = "Node environment"

[snippets.unique-id.parameters.image]
name = "image"
description = "Docker image name"

Saving Snippets from Clipboard and History

pypet provides convenient ways to save snippets from your clipboard or shell history:

Save from Clipboard

# Save current clipboard content
pypet save-clipboard -d "My command description" -t "docker,development"

# Interactive mode (prompts for description and tags)
pypet save-clipboard

This command automatically detects parameters in the clipboard content and prompts you to add descriptions for them.

Save from Shell History

# Save the last command from your shell history
pypet save-last

# Save multiple commands (creates separate snippets)
pypet save-last -n 3

# With description and tags
pypet save-last -d "Build command" -t "build,make"

The save-last command works with bash, zsh, and other popular shells. It reads from your shell history file and lets you save recent commands as snippets.

Shell Aliases

pypet can create persistent shell aliases from your snippets, making frequently-used commands instantly accessible without needing to run pypet exec.

Adding Aliases to Snippets

# Create a new snippet with an alias
pypet new "ls -la" -d "List all files" -a ll

# Add an alias to an existing snippet
pypet alias add <snippet-id> ll

# List all snippets with aliases
pypet alias list

# Show the generated alias definition
pypet alias show <snippet-id>

# Remove an alias from a snippet
pypet alias remove <snippet-id>

Setting Up Aliases

After creating aliases, you need to source the aliases file in your shell:

# Show setup instructions
pypet alias setup

# Copy the source command to clipboard
pypet alias setup --copy

Add this line to your shell profile (~/.bashrc for bash, ~/.zshrc for zsh):

source ~/.config/pypet/aliases.sh

Then reload your shell or run:

source ~/.config/pypet/aliases.sh

How Aliases Work

• Simple snippets (no parameters): Created as regular shell aliases

  pypet new "ls -la" -a ll
  # Generates: alias ll='ls -la'
  

• Parameterized snippets: Created as shell functions that call pypet exec

  pypet new "ssh {user}@{host}" -a myssh
  # Generates a function that prompts for parameters
  

Managing Aliases

# Regenerate the aliases file (useful after manual edits)
pypet alias update

# View all aliases
pypet alias list

The aliases are stored in ~/.config/pypet/aliases.sh and are automatically updated whenever you add or remove aliases.

Interactive Mode

When running pypet exec without a snippet ID, it enters interactive mode:

1. Shows a table of all available snippets
2. Lets you select a snippet by number
3. Optionally allows editing the command before execution
4. Asks for confirmation before running the command

Git Synchronization

pypet supports Git-based synchronization to backup and share your snippets across devices.

Setup

# Initialize Git repository for snippets
pypet sync init

# Initialize with remote repository
pypet sync init --remote https://github.com/username/pypet-snippets.git

# Or add remote to existing repository
pypet sync remote https://github.com/username/pypet-snippets.git

Basic Operations

# Check sync status
pypet sync status

# Commit current changes
pypet sync commit -m "Added new Docker snippets"

# Pull changes from remote
pypet sync pull

# Push changes to remote
pypet sync push

# Full sync (commit + pull + push)
pypet sync sync

Backup Management

# List available backups
pypet sync backups

# Restore from backup
pypet sync restore snippets_backup_20250101_120000.toml

Automatic Cleanup: pypet automatically manages your backups by keeping only the 5 most recent backup files. Old backups are cleaned up during sync operations to prevent disk space accumulation.

Workflow

1. Initial Setup: Run pypet sync init to create a Git repository
2. Add Remote: Use --remote option or manually configure Git remote
3. Regular Sync: Use pypet sync sync to keep snippets synchronized
4. Automatic Backups: Backups are created before pull operations

Development

This project uses uv for dependency management, pytest for testing, and includes pre-push git hooks for quality assurance.

Quick Setup

# Clone the repository
git clone https://github.com/fabiandistler/pypet.git
cd pypet

# Set up development environment with hooks (recommended)
make dev

This installs the package in development mode and sets up pre-push git hooks that automatically run linting and tests before each push.

Manual Setup

# Create virtual environment
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install package in development mode
uv pip install -e ".[dev]"

# Install git hooks (optional but recommended)
make hooks

Development Commands

# Format code with black
make format

# Check linting with ruff
make lint

# Run tests
make test

# Run all checks (format + lint + test)
make all

# Clean build artifacts
make clean

Testing

# Run all tests
pytest

# Run with verbose output
pytest -v

# Run specific test file
pytest tests/test_cli.py

# Run with coverage
pytest --cov=pypet

Git Hooks

Pre-push hooks automatically run before each push:

• Code formatting with black
• Linting with ruff
• Full test suite with pytest

To bypass hooks (use sparingly):

git push --no-verify

To skip only tests (for quick iterations):

SKIP_TESTS=1 git push

Storage Format

Snippets are stored in TOML format at ~/.config/pypet/snippets.toml:

[snippets.unique-id]
command = "git status"
description = "Check git status"
tags = ["git", "status"]
alias = "gs"
created_at = "2025-06-17T10:00:00+00:00"
updated_at = "2025-06-17T10:00:00+00:00"

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License - see the LICENSE file for details