init.md is a general initialization protocol. It inspects a target, determines what that target needs to become operational, creates and configures only what applies, validates the result, and reports the outcome. It works for software projects, AI agents, servers, services, workspaces, and any other system that needs to go from incomplete to operational.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/bitwikiorg/init.md/llms.txt
Use this file to discover all available pages before exploring further.
Introduction
Understand what init.md is, what it solves, and when to use it.
Quickstart
Copy init.md or a template and run your first initialization in minutes.
Protocol
Explore the six-stage sequence and the design principles behind it.
Templates
Choose from five canonical templates for common target types.
The Six-Stage Sequence
Every initialization follows the same high-level sequence regardless of target type. The implementation details come from the target and the selected template.1 · Inspect
Read what exists — files, configuration, instructions, and constraints.
2 · Determine
Decide what is needed, which template applies, and which outputs are useful.
3 · Create
Create only the artifacts that apply — no universal bundles.
4 · Configure
Connect paths, settings, dependencies, tools, and instructions.
5 · Validate
Run a relevant check proving the target can actually operate as intended.
6 · Report
State what became operational, what changed, and what remains blocked.
Choose a Template
init.md ships with five canonical templates. Pick the one closest to your target, copy it, and adapt what applies.Minimal
One clear gap. The smallest reasonable initialization pass.
Dry Run
Inspect and plan without changing anything.
Development Project
Codebases, repositories, libraries, CLIs, and websites.
Agent
AI agents, agent workspaces, and tool-using assistant environments.
Server
Servers, service hosts, and deployment environments.
Guides
For Humans
How to identify targets, pick templates, and run the procedure manually.
For Agents
How AI agents read and execute init.md and its templates.
For Developers
Build, run, and extend the init.md website locally.
Writing Custom Templates
Create target-specific templates that follow the init.md spec.