# StructKit

> StructKit is an open-source command-line tool that scaffolds project files and directories from a single YAML configuration, with template variables, remote content fetching, and lifecycle hooks.

StructKit is written in Python and installed via `pip install structkit`. It generates project structures from a single YAML file rather than a nested template repository, making it language-agnostic — it scaffolds Python, Terraform, Next.js, Kubernetes, and microservice projects from the same tool. It is a modern alternative to Cookiecutter, Copier, and Yeoman. MIT licensed. Current release: v3.0.0.

## Documentation

- [Quick Start](https://structkit.app/docs/quickstart): Install StructKit and generate your first project in under two minutes
- [Installation](https://structkit.app/docs/installation): Install via pip, Docker, or from source
- [Usage](https://structkit.app/docs/usage): Core commands and common workflows
- [Configuration](https://structkit.app/docs/configuration): The YAML configuration format reference
- [Schema](https://structkit.app/docs/schema): Full schema reference for YAML configs
- [CLI Reference](https://structkit.app/docs/cli-reference): All CLI commands, flags, and options
- [Examples](https://structkit.app/docs/examples): Real-world example configurations
- [Template Variables](https://structkit.app/docs/template-variables): Jinja2-style variables and project-wide variable injection
- [File Handling](https://structkit.app/docs/file-handling): Files, directories, symlinks, permissions, inline and external content
- [Hooks](https://structkit.app/docs/hooks): Pre/post-generation lifecycle hooks for running shell commands
- [Mappings](https://structkit.app/docs/mappings): Mapping syntax for complex structures
- [Custom Structures](https://structkit.app/docs/custom-structures): Building reusable custom structure definitions
- [Environment Variables](https://structkit.app/docs/environment-variables): Supported environment variables and configuration
- [GitHub Integration](https://structkit.app/docs/github-integration): Pulling templates from GitHub repos and Gists
- [MCP Integration](https://structkit.app/docs/mcp-integration): Using StructKit with the Model Context Protocol

## Project

- [GitHub Repository](https://github.com/httpdss/structkit): Source code, issues, releases, and discussions
- [Discussions](https://github.com/httpdss/structkit/discussions): Q&A and community ideas
- [Issues](https://github.com/httpdss/structkit/issues): Bug reports and feature requests
- [Contributing Guide](https://structkit.app/docs/contributing): How to contribute to StructKit
- [Development Setup](https://structkit.app/docs/development): Local development environment setup
- [Blog](https://structkit.app/blog): Announcements, tutorials, and updates

## Optional

- [Known Issues](https://structkit.app/docs/known-issues): Current limitations and workarounds
- [Shell Completion](https://structkit.app/docs/completion): Bash, Zsh, and Fish completion setup
- [Funding](https://structkit.app/docs/funding): How to support StructKit development
- [Articles](https://structkit.app/docs/articles): External articles about StructKit