README.md

   _____                                             
  / ___/____ ___  ______ _________  ____  ___  ____ _
  \__ \/ __ `/ / / / __ `/ ___/ _ \/ __ \/ _ \/ __ `/
 ___/ / /_/ / /_/ / /_/ / /  /  __/ /_/ /  __/ /_/ / 
/____/\__, /\__,_/\__,_/_/   \___/ .___/\___/\__, /  
        /_/                     /_/         /____/   

squarepeg

Run a docker run-style command as a Kubernetes Pod or Job, streaming its output like a local process and exiting with the container's exit code.

squarepeg run alpine echo "hello from a pod"

Install

pip install squarepeg

Docs

Full documentation lives in the wiki:

• Getting Started
• CLI Reference
• Configuration
• Environment Variable Interpolation
• Docker Compatibility
• Execution Lifecycle
• Troubleshooting
• Development

See also examples/config.yaml for a fully worked config file.

Development

pytest                        # unit tests
pytest -m integration         # integration tests, requires SQUAREPEG_INTEGRATION=1 and a kind cluster
ruff check .                  # lint