Installation¶

Poing AI can be installed as a command-line tool, used as a GitHub Action, or run in a Docker container.

1. Local CLI Installation (PyPI)¶

Install the official Python package from PyPI:

pip install --upgrade poing-ai

Verify installation:

poing --version

(Both poing and poing-ai CLI commands are available).

To use Poing AI inside GitHub Actions workflows, reference the action directly:

- name: Run Poing AI
  uses: poingstudios/poing-ai@v1
  with:
    gemini-api-key: ${{ secrets.GEMINI_API_KEY }}

See the Quick Start Guide for complete workflow examples.

Pull the pre-built image from GitHub Container Registry (GHCR):

docker pull ghcr.io/poingstudios/poing-ai:latest

Run locally inside your git repository:

docker run --rm -it \
  -v $(pwd):/workspace \
  -w /workspace \
  -e GEMINI_API_KEY="your-api-key" \
  ghcr.io/poingstudios/poing-ai:latest --local