agentskills

package

v0.12.0 Latest Latest Go to latest Published: Jul 29, 2026 License: AGPL-3.0 Imports: 6 Imported by: 0

Details

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

Repository

github.com/runbear-io/beardrive

Links

Open Source Insights

Documentation ¶

Overview ¶

Package agentskills installs the `beardrive` skill into the agent platforms a user works with, so their agent knows how to drive the CLI — including running `bdrive init` and `bdrive hooks install` itself, which is how hooks end up registered correctly without the user hand-copying commands.

SKILL.md is a cross-agent standard: every supported platform discovers skills the same way — a directory per skill under the platform's config dir, holding a SKILL.md with `name` + `description` frontmatter:

claude  ~/.claude/skills/beardrive/SKILL.md
codex   ~/.codex/skills/beardrive/SKILL.md
gemini  ~/.gemini/skills/beardrive/SKILL.md
hermes  ~/.hermes/skills/beardrive/SKILL.md

Installs are user-level on purpose: the skill is about the CLI, not about one folder, and a synced project folder should never carry it. The skill is the binary's own copy (embedded at build time), so upgrading bdrive and re-running install refreshes it — writes are idempotent and report whether anything changed.

Index ¶

Variables
func Detect(folder string) []string
func Installed(agent string) bool
func Path(agent string) string
type Result
- func Install(folder string, agents []string) ([]Result, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var Agents = []string{"claude", "codex", "gemini", "hermes"}

Agents is the supported platforms, in the order they are reported.

Functions ¶

func Detect ¶

func Detect(folder string) []string

Detect reports which agent platforms are in use, judged — like agenthooks.Detect — by their config dirs existing in the project or the home directory.

func Installed ¶

func Installed(agent string) bool

Installed reports whether an agent already has the current skill.

func Path ¶

func Path(agent string) string

Path returns where an agent reads (or would read) the beardrive skill. Empty if the agent is unknown or the home directory is undiscoverable.

Types ¶

type Result ¶

type Result struct {
	Agent   string
	Path    string // SKILL.md written (or already current)
	Changed bool   // false = the installed copy already matched
}

Result reports what Install did for one agent platform.

func Install ¶

func Install(folder string, agents []string) ([]Result, error)

Install writes the skill for the given agents ("auto"/empty = every detected platform). An outdated copy is overwritten — the file is ours.

Source Files ¶

View all Source files

agentskills.go

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