Quick Start Guide

Get Ginx running in your project in less than 2 minutes! This guide will take you from installation to running your first scripts.

Prerequisites

• Python 3.7+ - Ginx is built for modern Python projects

• pip - For installing Ginx and managing dependencies

• Git (optional) - For version control examples

Want to learn about version control, check here.

1

Install Ginx

Install Ginx globally or in your project's virtual environment:

pip install ginx

Verify the installation:

ginx version

2

Initialize Your Project

Navigate to your project directory and create a Ginx configuration:

cd your-project
ginx init

This creates a ginx.yaml file with sample scripts. Let's see what was created:

ginx list

This will list all the commands registered inside the ginx.yaml file.

3

Run Your First Script

Let's try running a few scripts to see Ginx in action:

Say hello to Ginx

ginx hello-ginx

Run in Dry-Run Mode

ginx hello-ginx --dry-run

The --dry-run flag shows you what would be executed without actually running it.

What's Next?

Congratulations! You now have Ginx running in your project.