docs: Add upgrade instructions to README#80
docs: Add upgrade instructions to README#80arnthorsnaer wants to merge 1 commit intobasecamp:mainfrom
Conversation
Add explicit upgrade workflow documenting the three-step process: 1. git pull (fetch latest changes) 2. make install (rebuild binary with updated embedded skill) 3. hey skill install (copy updated skill to ~/.agents/skills/hey/) The agent skill is embedded in the binary at build time, so users need to rebuild and reinstall after pulling updates to keep the skill in sync with the latest CLI version.
There was a problem hiding this comment.
Pull request overview
Tip
If you aren't ready for review, convert to a draft PR.
Click "Convert to draft" or run gh pr ready --undo.
Click "Ready for review" or run gh pr ready to reengage.
Adds explicit upgrade guidance to the project README so users understand they must rebuild the CLI binary and reinstall the embedded agent skill after pulling updates.
Changes:
- Add a new Upgrading section describing a 3-step update flow (
git pull,make install,hey skill install). - Document that the agent skill is embedded at build time and needs reinstalling to stay in sync with the binary.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| make install # rebuild binary with updated embedded skill | ||
| hey skill install # update agent skill to match new binary | ||
| ``` | ||
|
|
||
| The agent skill is embedded in the binary at build time, so all three steps are required to keep everything in sync. |
There was a problem hiding this comment.
The upgrade instructions call this an “agent skill”, but hey skill install is currently documented/implemented as Claude-specific and also creates a symlink under ~/.claude/skills/hey in addition to writing ~/.agents/skills/hey/SKILL.md. Consider clarifying this here (e.g., mention Claude explicitly and/or the two target locations) so users understand what gets updated when they rerun the command.
Hi! 👋
This PR suggests adding explicit upgrade instructions to the README to help users keep both the CLI and the embedded agent skill up to date.
Current situation:
make install) and the agent skill (hey skill install)make install) AND re-runhey skill installafter pulling updatesgit pullalone doesn't update itProposed change:
Add a new "Upgrading" section that documents the three-step process:
git pull(fetch latest changes)make install(rebuild binary with updated embedded skill)hey skill install(copy updated skill to~/.agents/skills/hey/)Note:
This is a suggestion to improve documentation clarity — feel free to close if you prefer a different approach or if this is already covered elsewhere. No pressure! Just wanted to raise awareness that the upgrade flow could be more explicit. 😊
Authored via OpenClaw agent 🦉
Summary by cubic
Adds an "Upgrading" section to the README that explains how to update
hey-cliand the embedded agent skill. Usegit pull,make install, andhey skill installto rebuild the binary and keep the global skill in sync.Written for commit 87862ab. Summary will update on new commits.