Installation

NAT can be installed via pip (Python package), Docker, or used directly in GitHub Actions without a local install.

System requirements

pip install nat-engine installs the full NAT engine including the CLI, local report generation, and self-hosted server mode.

pip install nat-engine

nat --version
# nat-engine 1.x.x

pip install --upgrade nat-engine

pip install nat-engine==1.2.0

python -m venv .venv
source .venv/bin/activate   # macOS/Linux
# .venv\Scripts\activate    # Windows
pip install nat-engine

docker pull natengine/nat:latest
docker run --rm natengine/nat:latest nat --version

See the Docker Deployment guide for production Docker setup.

No local installation needed — use the official nat-action in your workflow:

- uses: bg-playground/nat-action@v1
  with:
    api-url: https://api.example.com
    api-key: ${{ secrets.NAT_API_KEY }}

See the CI/CD Integration guide for the full workflow reference.

After installing via pip, you can run NAT as a local server that exposes a REST API and dashboard:

nat server start --port 8080

Navigate to http://localhost:8080 in your browser.

Variable	Description	Default
`NAT_PORT`	Server listen port	`8080`
`NAT_HOST`	Bind address	`127.0.0.1`
`NAT_DATA_DIR`	Directory for scan data and reports	`~/.nat/data`
`NAT_LOG_LEVEL`	Log verbosity (`debug`, `info`, `warn`, `error`)	`info`
`NAT_SECRET_KEY`	Secret used to sign session tokens	Auto-generated

See the Self-Hosted Setup guide for a complete production deployment walkthrough.

pip uninstall nat-engine

To also remove stored data and configuration:

rm -rf ~/.nat