Introduction

Ginx. is a command-line script runner that transforms the way you manage project workflows. Instead of remembering complex commands, maintaining shell scripts, or hunting through documentation, Ginx lets you define all your project scripts in a simple YAML file and run them with intuitive commands.

# Instead of this:
python -m black src/ && isort src/ && flake8 src/

# Just do this:
ginx format

Why Use Ginx?

Cover

Simplify Complex Workflows

Stop copy-pasting commands from README files. Define your build, test, deploy, and maintenance scripts once and run them consistently across your team.

Cover

Boost Developer Productivity

Turn long, error-prone commands into simple shortcuts so new team members can get productive fast no need to memorize complex conventions.

Cover

Self-Documenting Projects

Your ginx.yaml file becomes the single source of truth for all project scripts, with built-in descriptions and organized workflows.

What Problems Does Ginx Solve?

Before Ginx 😰

# Developers struggle with:
python -m build --sdist --wheel --outdir dist/
black src/ tests/ && isort src/ tests/ --check-only
pytest tests/ -v --cov=src --cov-report=html
twine upload --repository testpypi dist/*
git add . && git commit -m "Release v1.2.3" && git push

After Ginx 😎

# Clean, simple commands:
ginx build
ginx format
ginx test
ginx publish
ginx release

Ginx turns your project's complex commands into simple, memorable shortcuts. Focus on building great software, not remembering command-line incantations.

Last updated