Quick Start
Get StructKit installed and generate your first project.
60-second quick start
Define a repo once — files, CI, Terraform, app layout — then generate it from the CLI, from CI, or through an assistant over MCP.
Terminalbash
# 1. install
pip install structkit
# 2. see what templates are available
structkit list
# 3. generate one
structkit generate --vars module_name=my-terraform-module \
terraform/modules/generic ./my-terraform-module
# 4. or expose the same templates to your AI assistant
structkit mcp --serverSee MCP integration for wiring the server into Claude, Cursor, Cline, or Continue.
1. Install StructKit
pip install structkitRequires Python 3.7+. You can also install via Homebrew, Docker, Linux release packages, or from source.
2. Create a Configuration File
Create a YAML file defining your project structure:
my-project.yamlyaml
# my-project.yaml
project_name: my-app
variables:
author: "Your Name"
version: "0.1.0"
structure:
- src/:
- __init__.py
- main.py:
content: |
"""{{ project_name }} v{{ version }}"""
# Author: {{ author }}
def main():
print("Hello from {{ project_name }}!")
if __name__ == "__main__":
main()
- utils/:
- helpers.py:
content: |
# Utility functions for {{ project_name }}
- tests/:
- test_main.py:
content: |
from {{ project_name }}.main import main
def test_main():
assert main is not None
- README.md:
content: |
# {{ project_name }}
Version: {{ version }}
Author: {{ author }}
- setup.py
- .gitignore:
content: |
__pycache__/
*.pyc
.env
dist/3. Generate Your Project
# Preview what will be created
structkit generate my-project.yaml --dry-run
# Generate the project
structkit generate my-project.yaml4. Verify the Output
my-app/
├── src/
│ ├── __init__.py
│ ├── main.py
│ └── utils/
│ └── helpers.py
├── tests/
│ └── test_main.py
├── README.md
├── setup.py
└── .gitignoreNext Steps
- Learn about all configuration options
- Browse real-world examples
- Explore advanced features like hooks, remote content, and mappings
Related
- Installation — Install StructKit via pip, Homebrew, Docker, Linux packages, or from source.
- YAML Configuration — Full YAML reference: structures, file content, variables, hooks, mappings, and remote sources.
- Examples — Real-world YAML configs for Python apps, monorepos, Docker stacks, and Terraform modules.