Repository navigation
docs: add DESIGN.md, the portable bash + skills design - #29
Merged
Merged
Conversation
Add docs/DESIGN.md, which states how agy-staff is designed as a portable agent CLI tool: bash plus skills, with no hard dependency on a host, a worker CLI or a runtime library. Link it from both READMEs with a copyable prompt for building the same kind of tool for another CLI. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Add a mermaid state diagram of the job lifecycle to DESIGN.md. Move the DESIGN.md prompt out of "Core design" into its own README section, "Build one for another CLI", linked from the top navigation in both languages. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This branch is waiting to be deployed
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.
What
Add
docs/DESIGN.md, which states how agy-staff is designed as a portable agent CLI tool: bash plus skills, with no hard dependency on a host, a worker CLI or a runtime library. Both READMEs get a new section, "Build one for another CLI" (「为其他 CLI 做一个」), with a copyable prompt for building the same kind of tool for another agent CLI. The top navigation links to it.Closes #28.
Why
The design was spread across the README, REFERENCE.md, the skills, the templates and the release notes. Each is accurate for its reader, but none states the design as a whole or the reasons behind it. The same kind of delegation tool keeps being rebuilt for other CLIs, and agy-staff's answers to the shared lifecycle problems were only written in agy terms.
Design
--helpto section 11, list unsupported principles before writing code, and ask before any call that spends model quota. The prompt stays in English in both READMEs, like the install prompt. The Chinese README notes that DESIGN.md is in English.Verification
npm run check:skills: Pi and OpenCode generated skills are unchanged.npm pack --dry-run:docs/DESIGN.mdis not packed. Installed plugins on Claude Code, Codex, Pi and OpenCode are unchanged.git diff --checkpassed.Release
No version bump. Only documentation outside the npm
fileslist changes. The README prompt reads DESIGN.md from GitHub master, so it takes effect on merge.🤖 Generated with Claude Code