Quick Start

June 27, 2026 ยท View on GitHub

Quick Start Using Docker

  1. Pick one of the polished examples in examples/.
  2. Run the following command to generate the Python CLI example:
docker run \
  -v $(pwd):/workdir \
  -u $(id -u):$(id -g) \
  ghcr.io/httpdss/structkit:main generate \
  file:///workdir/examples/python-cli/.struct.yaml \
  /workdir/example_output

Quick Start Using Docker Alpine

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

For testing, you can run an alpine Docker container and install the script inside it:

docker run -it --entrypoint="" python:3.10-alpine sh -l

Inside the container:

apk add python-pip git vim
pip install structkit
mkdir example
cd example/
touch structure.yaml
vim structure.yaml # or copy one of the examples from the examples/ directory
structkit generate structure.yaml .

Note: The file:// protocol is automatically added for .yaml files, so structure.yaml and file://structure.yaml work identically. Additionally, if your file is named .struct.yaml in the current directory and you want to generate into the current directory, you can just run structkit generate.

Discovering Available Structures

Before generating, see what structures are available:

structkit list

This shows all built-in structures you can use.

!!! tip "Auto-Completion" If you've enabled auto-completion, you can press Tab after structkit generate to see all available structures!

First Example

After installing StructKit, try this simple example:

structkit generate --vars module_name=my-terraform-module terraform/modules/generic ./my-terraform-module

This will create a new terraform module structure in the ./my-terraform-module directory.

Or try a simple project structure:

structkit generate project/nodejs ./my-node-app

Bootstrap a new project

Start with a minimal .struct.yaml:

structkit init

This writes a basic .struct.yaml with hooks, a README, and a reference to the run-structkit workflow.

Next Steps