Installation Guide

Using pip

Install StructKit with pip:

pip install structkit

Using Homebrew

StructKit is published through its own tap, httpdss/homebrew-structkit (it is not a core Homebrew formula, so the tap is required):

brew tap httpdss/structkit
brew install structkit

structkit --help

Using Docker

Run StructKit without installing it, using the official image ghcr.io/httpdss/structkit:main:

docker run --rm -v "$(pwd):/workdir" ghcr.io/httpdss/structkit:main \
  generate --vars module_name=my-terraform-module terraform/modules/generic ./my-terraform-module

Refer to the Quick Start guide for more options.

Linux packages (.deb / .rpm)

.deb and .rpm packages (amd64 and arm64) are built by the build-linux-packages workflow on each release. Download them from that workflow run's artifacts on GitHub Actions (kept for 90 days), or build them locally with packaging/README.md.

Artifacts: structkit-VERSION-amd64-deb, structkit-VERSION-arm64-deb, structkit-VERSION-amd64-rpm, structkit-VERSION-arm64-rpm.

Debian / Ubuntu

sudo dpkg -i structkit_VERSION_amd64.deb
# if needed: sudo apt-get install -f

Fedora / RHEL

sudo dnf install ./structkit-VERSION-1.x86_64.rpm
# or: sudo rpm -ivh structkit-VERSION-1.x86_64.rpm

Both packages ship a vendored virtual environment at /usr/lib/structkit/venv/ and a shim at /usr/bin/structkit, so no system Python packages are touched.

structkit --help

Editor & CI integrations

• Pre-commit hooks — validate and lint StructKit YAML on every commit.
• VS Code / Cursor extension — schema validation and autocomplete for *.structkit.yaml.
• GitHub Actions — install with httpdss/structkit-setup@v0, then run validate or drift detection with httpdss/structkit-action@v0.

From Source

Clone the repository and install locally. See the Development page for details.

git clone https://github.com/httpdss/structkit.git
cd structkit
pip install -e .