guide

package

v0.2.0 Latest Latest Go to latest Published: Oct 18, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ghostbranch-labs/ghostbranch

Links

Open Source Insights

Documentation ¶

Overview ¶

Package guide is the agent guide: embedded in the binary so it always matches it, with its code tables rendered from the contract registry, plus the small user-level skill that points agents at it.

Index ¶

Constants
func AgentTokenLink() string
func Install(path string, dryRun bool) (string, error)
func Render(entries []contract.Entry) string
func Skill() string
func SkillPath(target string, getenv func(string) string, home func() (string, error)) (string, error)
func Uninstall(path string, dryRun bool) (string, error)
type InstallResult
type Printed

Constants ¶

View Source

const Marker = "Installed by `ghostbranch guide --install`."

Marker identifies a SKILL.md that Ghostbranch wrote and may replace or remove.

Variables ¶

This section is empty.

Functions ¶

func AgentTokenLink ¶ added in v0.1.1

func AgentTokenLink() string

AgentTokenLink is Strict isolation's pre-filled link for an agent's shadow-only token, with <shadow-owner> and <repo> for the agent to fill.

func Install ¶

func Install(path string, dryRun bool) (string, error)

Install writes the skill to path and says what it did (or, with dryRun, what it would do): installed, updated or unchanged.

func Render ¶

func Render(entries []contract.Entry) string

Render returns the guide with its exit and error tables filled from entries.

func Skill ¶

func Skill() string

func SkillPath ¶

func SkillPath(target string, getenv func(string) string, home func() (string, error)) (string, error)

SkillPath is where the skill for target goes. It is always a user-level path, never inside a repo checkout: a committed skill file would reveal that a shadow repo exists.

func Uninstall ¶

func Uninstall(path string, dryRun bool) (string, error)

Uninstall removes a skill Ghostbranch wrote, and its folder when empty.

Types ¶

type InstallResult ¶

type InstallResult struct {
	Target  string           `json:"target"`
	Path    string           `json:"path"`
	Action  string           `json:"action"`
	Preview *preview.Preview `json:"preview"`
}

InstallResult is `ghostbranch guide --install/--uninstall` output.

type Printed ¶

type Printed struct {
	Markdown string `json:"markdown"`
}

Printed is `ghostbranch guide` output.

Source Files ¶

View all Source files

guide.go

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