docs: killer README + install/update system#23
Open
james-s-hedwig[bot] wants to merge 4 commits intomainfrom
Open
docs: killer README + install/update system#23james-s-hedwig[bot] wants to merge 4 commits intomainfrom
james-s-hedwig[bot] wants to merge 4 commits intomainfrom
Conversation
- Rewrote README.md from scratch: leads with the pain, code demo first, key concepts table, use cases, agent section, performance context - Added docs/QUICKSTART.md: permissions, first 5 commands, troubleshooting - Added docs/AGENT-GUIDE.md: snapshot→act loop, refs, pipe, error handling, OpenClaw skill example, best practices - Added docs/INSTALL.md: all install methods, update instructions, PATH setup - Added `cua update` command: checks GitHub releases API, downloads and installs latest version, prints status - Added version notice: checks cache on each `cua` invocation, prints upgrade notice if a newer version is available; background API check max once per 24h, stored in ~/.cua/version-check.json - Polished install.sh: shows version being installed, detects shell for PATH suggestion (bash/zsh/fish), added --version flag - Updated skills/computer-use/SKILL.md: added wait/assert commands, cua update reference, screen-locked tip
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Complete overhaul: human-first README, definitions table, use cases, agent guide, docs structure,
cua updatecommand, install.sh polish.Changes
README.md — complete rewrite
cuad,cua, ref, snapshot, pipe, transport, AX, CDP, AppleScript)cua updatedocs/QUICKSTART.md (new)
docs/AGENT-GUIDE.md (new)
pipevs snapshot+actdocs/INSTALL.md (new)
cua update, Homebrew, re-run install.shcua --version, update noticecua updatecommand (new)cua update— checks GitHub releases API, compares with current version, downloads and installs if newercua update --check— check without installingcuainvocation, checks~/.cua/version-check.jsoncache, prints notice if newer version available~/.cua/version-check.jsoninstall.sh — polished
--versionflag: prints latest available version without installingcua updateanytime to get the latest version"armsteadj1/claw-useskills/computer-use/SKILL.md — updated
waitandassertcommand referencecua updateandcua update --checkto maintenance section