diff --git a/.goreleaser.yml b/.goreleaser.yml index 3caddde..a0949a7 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -40,6 +40,12 @@ homebrew_casks: git: url: git@github.com:eyra/homebrew-tap.git private_key: '{{ index .Env "HOMEBREW_TAP_DEPLOY_KEY" }}' + caveats: | + Install the flux skill for your AI coding agents with one or more of: + flux install claude + flux install omp + flux install codex + Rerun them after `brew upgrade flux-cli` to update the skill. hooks: post: install: | diff --git a/README.md b/README.md index 07d47a2..dc20287 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,22 @@ Or with Go: go install github.com/eyra/flux-cli@latest ``` +### Agent skill + +The binary carries the flux skill for AI coding agents. Install it for the +agents you use, and rerun after upgrading flux: + +```bash +flux install claude # Claude Code: ~/.claude/skills/flux (CLAUDE_CONFIG_DIR replaces ~/.claude) +flux install omp # omp: ~/.omp/agent/skills/flux (PI_CODING_AGENT_DIR replaces ~/.omp/agent) +flux install codex # Codex: ~/.agents/skills/flux +``` + +omp also reads `~/.agents/skills`, so `flux install codex` makes the skill +available to omp too. A `SKILL.md` that differs from the installed version is +first backed up to `SKILL.md.bak-