prereq

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

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthResult

type AuthResult struct {
	OK     bool   `json:"ok"`
	Method string `json:"method,omitempty"` // "gh_cli", "GITHUB_TOKEN", "config", ""
}

AuthResult describes the GitHub authentication status.

type ConnectionsResult

type ConnectionsResult struct {
	Repos []string `json:"repos,omitempty"`
}

ConnectionsResult describes existing team connections.

type DirResult

type DirResult struct {
	OK   bool   `json:"ok"`
	Path string `json:"path"`
}

DirResult describes the ~/.scribe/ directory status.

type Result

type Result struct {
	GitHubAuth  AuthResult        `json:"github_auth"`
	ScribeDir   DirResult         `json:"scribe_dir"`
	Connections ConnectionsResult `json:"connections"`
	ConfigErr   string            `json:"config_error,omitempty"`
}

Result holds all prerequisite check outcomes.

func Check

func Check() Result

Check runs all prerequisite checks and returns the result. ConfigErr is non-nil if the config file exists but is malformed.

Jump to

Keyboard shortcuts

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