projectfile

package
v1.5.0 Latest Latest
Warning

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

Go to latest
Published: May 13, 2026 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const Filename = ".scribe.yaml"

Filename is the conventional name for a Scribe project file.

Variables

This section is empty.

Functions

func Find

func Find(startDir string) (string, error)

Find walks upward from startDir looking for .scribe.yaml. It returns an empty string when no project file exists.

func Save

func Save(path string, pf *ProjectFile) error

Save writes a ProjectFile to path atomically.

Types

type ProjectFile

type ProjectFile struct {
	Kits       []string `yaml:"kits,omitempty"`
	Snippets   []string `yaml:"snippets,omitempty"`
	MCP        []string `yaml:"mcp,omitempty"`
	MCPServers []string `yaml:"mcp_servers,omitempty"`
	Add        []string `yaml:"add,omitempty"`
	Remove     []string `yaml:"remove,omitempty"`
}

ProjectFile declares which Scribe assets a project wants projected locally.

func Load

func Load(path string) (*ProjectFile, error)

Load reads a .scribe.yaml file from path. Missing or empty files are treated as no Scribe activity for the project.

func (*ProjectFile) MCPServerNames

func (pf *ProjectFile) MCPServerNames() []string

Jump to

Keyboard shortcuts

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