Welcome to the comprehensive documentation for StructKit - the Automated Project Structure Generator.
- Installation Guide - How to install StructKit
- Quick Start - Get up and running quickly
- Basic Usage - Core functionality and commands
- YAML Configuration - Complete configuration reference
- Template Variables - Working with dynamic content
- File Handling - Managing files and permissions
- Environment Variables -
STRUCTKIT_*defaults and overrides
- Custom Structures - Creating your own templates
- Hooks - Pre and post-generation automation
- Mappings - Using external data mappings
- GitHub Integration - Automation with GitHub Actions
- MCP / AI Agent Workflow - Model Context Protocol for approved-template scaffolding with AI assistants
- Agent Skills - Installable StructKit workflow skill for AI assistants
- Development Setup - Contributing to StructKit
- Command-Line Completion - Auto-completion setup
- CLI Reference - Complete command documentation
- Schema Reference - YAML validation and IDE support
- Examples - Practical examples and use cases
Companion install paths for StructKit (not separate products):
- structkit-setup — install StructKit on
PATHin GitHub Actions (httpdss/structkit-setup@v0), then run anystructkitcommand - structkit-action — validate, generate, or drift-check as a GitHub Actions step (
httpdss/structkit-setup@v0, thenhttpdss/structkit-action@v0) - structkit-pre-commit — validate structures before they land
- vscode-structkit — schema and autocomplete for
.structkit.yaml - homebrew-structkit —
brew install httpdss/structkit/structkit - backstage-plugin-structkit — scaffolder actions for platform teams
- structkit-skills — inspect, preview, generate, and validate from an assistant
- hermes-plugin-structkit — safe StructKit tools inside Hermes