Installation Guide

Using pip

Install STRUCT with pip:

pip install git+https://github.com/httpdss/struct.git

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.

From Source

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

Using Docker

Run STRUCT without installing, using Docker:

docker run -v $(pwd):/workdir -u $(id -u):$(id -g) ghcr.io/httpdss/struct:main generate file:///workdir/example/structure.yaml /workdir/example_output

Refer to the Quick Start guide for more options.