Skip to content

docs: Add upgrade instructions to README#80

Open
arnthorsnaer wants to merge 1 commit intobasecamp:mainfrom
arnthorsnaer:docs/add-upgrade-instructions
Open

docs: Add upgrade instructions to README#80
arnthorsnaer wants to merge 1 commit intobasecamp:mainfrom
arnthorsnaer:docs/add-upgrade-instructions

Conversation

@arnthorsnaer
Copy link
Copy Markdown

@arnthorsnaer arnthorsnaer commented Apr 18, 2026

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:

  • The README documents installation (make install) and the agent skill (hey skill install)
  • It's not immediately clear that users need to rebuild the binary (make install) AND re-run hey skill install after pulling updates
  • The agent skill is embedded in the binary at build time, so git pull alone doesn't update it

Proposed change:
Add a new "Upgrading" section that documents 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/)

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-cli and the embedded agent skill. Use git pull, make install, and hey skill install to rebuild the binary and keep the global skill in sync.

Written for commit 87862ab. Summary will update on new commits.

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.
Copilot AI review requested due to automatic review settings April 18, 2026 15:10
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Apr 18, 2026
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md
Comment on lines +135 to +139
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.
Copy link

Copilot AI Apr 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants