scaffold

package
v0.23.13 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 29, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package scaffold creates the project directory tree on disk from an initech config. It writes CLAUDE.md files for each role, root CLAUDE.md, AGENTS.md, .gitignore, and the four project documents (prd, spec, systemdesign, roadmap).

All file writes are idempotent: existing files are not overwritten unless force is true. This lets users safely re-run initech init without losing their customizations.

This package does not know about git or beads. It only creates directories and writes files.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Run 

func Run(p *config.Project, opts Options) ([]string, error)

Run creates the full project directory tree from the given config. Returns a list of paths that were created (for summary output).

Types

type Options 

type Options struct {
	// Force overwrites existing files when true.
	Force bool
	// Progress is called with a short description for each created item.
	// Nil disables progress output.
	Progress func(msg string)
}

Options controls scaffold behavior.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.