# 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.

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

# Just do this:
ginx format
```

**Why Use Ginx?**

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Simplify Complex Workflows</strong></td><td>Stop copy-pasting commands from README files. Define your build, test, deploy, and maintenance scripts once and run them consistently across your team.</td><td><a href="/files/fwc52d4fXa0DP8MshIvv">/files/fwc52d4fXa0DP8MshIvv</a></td></tr><tr><td><strong>Boost Developer Productivity</strong></td><td>Turn long, error-prone commands into simple shortcuts so new team members can get productive fast no need to memorize complex conventions.</td><td><a href="/files/mfj6kaHJ59BT0F5H5Lo6">/files/mfj6kaHJ59BT0F5H5Lo6</a></td></tr><tr><td>Self-Documenting Projects</td><td>Your <code>ginx.yaml</code> file becomes the single source of truth for all project scripts, with built-in descriptions and organized workflows.</td><td><a href="/files/t0z4HhJ3L56IttqFfqF1">/files/t0z4HhJ3L56IttqFfqF1</a></td></tr></tbody></table>

**What Problems Does Ginx Solve?**

Before Ginx 😰

```bash
# 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 😎

```bash
# 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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://ginx.gitbook.io/ginx/ginx-introduction.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
