Skip to content

installation.md

Latest commit

 

History

History
99 lines (66 loc) · 3.2 KB

installation.md

File metadata and controls

99 lines (66 loc) · 3.2 KB
Raw
tags
installation

Installation Guide

Using pip

Install StructKit with pip:

pip install structkit

!!! tip "Enable Auto-Completion" After installation, enable command-line auto-completion using static scripts generated by shtab. See the Command-Line Completion guide for per-shell instructions.

Using Homebrew

StructKit is published through the httpdss/homebrew-structkit tap (formula name: structkit). It is not a core Homebrew formula.

brew install httpdss/structkit/structkit

Equivalent two-step form:

brew tap httpdss/structkit
brew install structkit
structkit --help

Using Docker

Run StructKit without installing, using Docker:

docker run -v $(pwd):/workdir -u $(id -u):$(id -g) ghcr.io/httpdss/structkit:main generate file:///workdir/examples/python-cli/.structkit.yaml /workdir/example_output

Refer to the Quick Start guide for more options.

Linux packages (.deb / .rpm)

Native .deb (Debian/Ubuntu) and .rpm (Fedora/RHEL) packages are attached to each GitHub Release starting with 3.3.1. The build-linux-packages workflow builds them on every published release (and on manual workflow_dispatch with a tag) and uploads them to that release. A SHA256SUMS file is published alongside the packages. The same files are also kept as Actions artifacts (90-day retention).

Asset names include the version and architecture, for example:

  • structkit_3.3.1_amd64.deb / structkit_3.3.1_arm64.deb
  • structkit-3.3.1-1.x86_64.rpm / structkit-3.3.1-1.aarch64.rpm

Debian/Ubuntu (amd64):

curl -fsSL -o structkit_3.3.1_amd64.deb \
  https://github.com/httpdss/structkit/releases/download/v3.3.1/structkit_3.3.1_amd64.deb
sudo apt install ./structkit_3.3.1_amd64.deb

Fedora/RHEL (x86_64):

curl -fsSL -o structkit-3.3.1-1.x86_64.rpm \
  https://github.com/httpdss/structkit/releases/download/v3.3.1/structkit-3.3.1-1.x86_64.rpm
sudo dnf install ./structkit-3.3.1-1.x86_64.rpm

For arm64, download structkit_3.3.1_arm64.deb or structkit-3.3.1-1.aarch64.rpm from the same release URL and install the local file the same way. Replace 3.3.1 / v3.3.1 with the version you want.

To build packages locally instead, follow packaging/README.md.

GitHub Actions

To run arbitrary StructKit commands in CI, install with httpdss/structkit-setup:

- uses: httpdss/structkit-setup@v0
- run: structkit list

To validate or generate as a dedicated step, call setup first, then httpdss/structkit-action. The action does not install StructKit itself:

- uses: httpdss/structkit-setup@v0
- uses: httpdss/structkit-action@v0
  with:
    command: validate

See GitHub Integration for full workflow examples.

From Source

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