scaffold

Documentation

Overview

Package scaffold generates the standard Plumtree app layout for `pt new`:

<name>/
  go.mod
  plumtree.json                 committed app manifest
  .gitignore                    ignores local env and deploy metadata
  README.md                     human-facing project quickstart
  AGENTS.md                     agent-facing project instructions
  app/main.go                   the app entrypoint (TUI or CLI)

Index

• func New(parentDir, name string, kind Kind) (string, error)
• func NewWithAccess(parentDir, name string, kind Kind, access string) (string, error)
• func ValidateName(name string) error
• type Kind

Functions

func New

func New(parentDir, name string, kind Kind) (string, error)

New scaffolds an app named name of the given kind under parentDir, creating the directory <parentDir>/<name>. It refuses to overwrite an existing non-empty directory. It returns the created project directory.

func NewWithAccess

func NewWithAccess(parentDir, name string, kind Kind, access string) (string, error)

NewWithAccess is the clean scaffold entry point. Access is written into the manifest so deployment never has an implicit public/restricted default.

func ValidateName

func ValidateName(name string) error

ValidateName reports whether name is an acceptable app handle.

Types

type Kind

type Kind string

Kind is the app type.

const (
	TUI Kind = "tui"
	CLI Kind = "cli"
)