docs

package

v1.260331.0 Latest Latest Go to latest Published: Mar 31, 2026 License: MIT Imports: 12 Imported by: 0

Documentation ¶

Index ¶

Variables
func DocsCommand() *ffcli.Command
func DocsInitCommand() *ffcli.Command
func DocsListCommand() *ffcli.Command
func DocsShowCommand() *ffcli.Command
func NewInitReferenceCommand(flagSetName, commandName, shortUsage, shortHelp, longHelp, errorPrefix string) *ffcli.Command
type InitOptions
type InitResult
- func InitReference(opts InitOptions) (InitResult, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrASCReferenceExists indicates ASC.md already exists and --force was not set.
	ErrASCReferenceExists = errors.New("ASC.md already exists")
	// ErrInvalidASCReferencePath indicates --path does not target ASC.md or a directory.
	ErrInvalidASCReferencePath = errors.New("path must target ASC.md or a directory")
)

Functions ¶

func DocsCommand ¶

func DocsCommand() *ffcli.Command

DocsCommand returns the docs command group.

func DocsInitCommand ¶

func DocsInitCommand() *ffcli.Command

DocsInitCommand returns the docs init subcommand.

func DocsListCommand ¶

func DocsListCommand() *ffcli.Command

DocsListCommand returns the docs list subcommand.

func DocsShowCommand ¶

func DocsShowCommand() *ffcli.Command

DocsShowCommand returns the docs show subcommand.

func NewInitReferenceCommand ¶

func NewInitReferenceCommand(flagSetName, commandName, shortUsage, shortHelp, longHelp, errorPrefix string) *ffcli.Command

NewInitReferenceCommand builds an init-style command that writes ASC.md references.

Types ¶

type InitOptions ¶

type InitOptions struct {
	Path  string
	Force bool
	Link  bool
}

InitOptions controls ASC reference generation.

type InitResult ¶

type InitResult struct {
	Path        string   `json:"path"`
	Created     bool     `json:"created"`
	Overwritten bool     `json:"overwritten"`
	Linked      []string `json:"linked,omitempty"`
}

InitResult describes the output of an init run.

func InitReference ¶

func InitReference(opts InitOptions) (InitResult, error)

InitReference generates ASC.md in the target repo and links agent files.

Source Files ¶

View all Source files

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