scaffold

package

v0.0.2 Latest Latest Go to latest Published: Sep 17, 2026 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/blechschmidt/cloop

Links

Open Source Insights

Documentation ¶

Overview ¶

Package scaffold implements AI-powered project scaffolding from a cloop plan. It reads the active plan's goal and task list, asks the AI to generate a complete project skeleton (directory tree, stub files, config templates, README), and writes the result to the target output directory.

Index ¶

type ScaffoldFile
type ScaffoldPlan
- func Generate(ctx context.Context, prov provider.Provider, model string, plan *pm.Plan, ...) (*ScaffoldPlan, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ScaffoldFile ¶

type ScaffoldFile struct {
	Path    string `json:"path"`
	Content string `json:"content"`
}

ScaffoldFile represents a single file to be written.

type ScaffoldPlan ¶

type ScaffoldPlan struct {
	Dirs  []string       `json:"dirs"`
	Files []ScaffoldFile `json:"files"`
}

ScaffoldPlan is the manifest returned by the AI describing the project skeleton.

func Generate ¶

func Generate(ctx context.Context, prov provider.Provider, model string, plan *pm.Plan, outputDir string, dryRun bool) (*ScaffoldPlan, error)

Generate calls the AI provider to produce a ScaffoldPlan, then writes all directories and files to outputDir (unless dryRun is true, in which case it only returns the plan without writing anything).

Source Files ¶

View all Source files

scaffold.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL