Overplane
Guide v0.0.8

Reference

Spec

Spec reference covers the YAML frontmatter metadata. The example is assembled from JSON Schema annotations.

specs/*.md

Every Overplane spec is a numbered Markdown document in the project's specs directory. Its YAML frontmatter (metadata) identifies the spec for readers and tooling.

static/files/schema/spec-metadata.schema.json

metadata

YAML frontmatter metadata for an Overplane specification document. The base fields identify, classify, and summarize the spec; advisory extensions connect the document to the target repository area and spec format revision.

Metadata lives in YAML frontmatter at the top of a spec document and identifies the spec for readers, tooling, and later migration.

Required

description

string default "Replace with a one-paragraph summary of this spec's purpose and deliverable."

Human-readable summary of the specification's purpose and deliverable.

min length 1

id

string default "#0001"

Stable spec identifier. Use a hash-prefixed four-digit id for repository-local specs.

pattern ^#[0-9]{4}$

parent

array<string> default []

Parent spec ids that this spec extends or depends on.

tags

array<string> default ["bootstrap"]

Lowercase topic labels used for discovery and grouping.

title

string default "Bootstrap"

Short display title for the spec.

min length 1

Optional

created

string default "2026-06-10"

Advisory creation date in ISO calendar form.

format date

target_dir

string

Advisory repository-relative directory this spec targets.

min length 1

spec_version

integer default 1

Advisory integer version of the spec document format.

min 1

extra_files

array<string>

Additional file paths, relative to the spec file's directory, appended to the spec body when the spec is loaded.

agent_config

string

Named agent configuration from overplane.yaml agents to use for this spec instead of the project default.

pattern ^[a-z0-9][a-z0-9._-]*$