18/02/2026
Initstack User Guide
Version: 2.0.0
CLI Alias: ink
---
1. What Is Initstack?
Initstack is a universal project initialization CLI designed to help developers start new projects consistently, safely, and fast.
Instead of manually copying boilerplates or fighting with outdated templates, Initstack uses validated templates and plugins to generate clean project structures with a single command.
Initstack is:
Environment-aware
Plugin-driven
Validation-first
Lightweight and framework-agnostic
---
2. What Initstack Does
Initstack helps you:
Initialize new projects from templates
Validate templates before use
Diagnose your environment
Manage and validate plugins
Maintain consistent project structure across teams
It does not replace frameworks, package managers, or build systems.
It focuses only on project initialization and structure.
---
3. Core Concepts
Templates
A template defines:
Folder structure
Starter files
Metadata (name, version, description)
Templates can be:
Built-in
Provided by plugins
Custom-created
---
Plugins
Plugins are installable template packages stored locally.
Each plugin includes:
template.json (metadata)
Template files and directories
Plugins are validated against a JSON schema to ensure correctness.
---
CLI Alias (ink)
ink is the short alias for Initstack.
All commands can be run using:
ink
---
4. Installation
Install Initstack in a Python environment:
pip install initstack
Verify installation:
ink --help
---
5. CLI Commands Overview
Command Description
ink list List available templates
ink new Create a new project
ink doctor Check environment health
ink plugin validate Validate a plugin template
---
6. Using Initstack
List Available Templates
ink list
Example output:
Available templates:
- fastapi
---
Create a New Project
ink new fastapi my_project
This will:
Create a new directory
Apply the template structure
Generate starter files
---
Check Environment Health
ink doctor
Doctor checks:
Python executable
Python version
Platform
Home directory
Installed plugins
This command is useful for:
Debugging
CI validation
Environment verification
---
Validate a Plugin
ink plugin validate fastapi
This ensures:
template.json exists
Schema is valid
Required fields are present
Validation prevents broken templates from being used.
---
7. How Initstack Works (Internals Overview)
1. CLI command is invoked (ink new, ink doctor, etc.)
2. Initstack resolves the template or plugin
3. Plugin metadata is validated
4. Files are copied to the target directory
5. Environment checks are optionally performed
No background services.
No daemon.
No system dependencies.
---
8. Key Benefits
Consistency
Every project starts with the same structure.
Safety
Templates are validated before ex*****on.
Speed
One command replaces manual setup.
Extensibility
Plugins allow unlimited customization.
Environment Friendly
Works in containers, CI, and restricted systems.
---
9. Recommended Use Cases
API starters
Microservices
Internal tooling
Open-source project scaffolding
Team-standard repositories
---
10. Best Practices
Always run ink plugin validate on new plugins
Use ink doctor in CI pipelines
Version-control templates and plugins
Keep templates minimal and focused
---
11. What Initstack Is NOT
Not a framework
Not a package manager
Not a build system
Not opinionated about architecture
Initstack only solves project initialization.
---
12. Versioning & Stability
Initstack follows semantic versioning:
MAJOR: breaking CLI or plugin changes
MINOR: new features
PATCH: fixes and improvements
v2.0.0 introduces:
Plugin validation
Stable CLI
ink alias
Improved diagnostics
---
13. Summary
Initstack helps developers start projects the right way, every time.
If you:
Start many projects
Work in teams
Care about structure and consistency
Initstack belongs in your toolbox.
--
