Repository navigation
docs(readme): say why, what and how, with two quick-start paths - #188
Merged
Merged
Conversation
Rework the README with the best ideas from HKUDS/CLI-Anything's README: three gains under the banner, a quick start from an API description and from a wirecat.config.ts, why a CLI and MCP with a table of agents, a pain-to-fix table, how it works from the description to cli-dev ready, the tests that come with it, the nine CLIs built with it, design principles, limitations and a roadmap. The banner, the GIF, the links row and the comparison stay. The only estimate (config coverage) is labelled as one. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- mcp add needs --allow-writes for a profile that may write, in the template's quick start and in a new CLI's README - an operation is a command the MCP server runs, not an MCP tool each - upgrade merges CI, release and agent files; cli-core brings code fixes - ask runs over MCP, so the profile served there wants readonly or deny - the api-to-cli skill runs new --spec-url, not --from-config - GraphQL: cli-base generates, cli-core's next release sends - src/hooks.ts is yours to add; the live check binds WireCat's CLIs - the coverage estimate gives the whole range, 42% to 87% - Discovery goes through --spec discovery, not --spec-url Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Why
The owner likes how HKUDS/CLI-Anything's README explains why, what and how in every section. This takes the best of it and keeps what ours already did well: the banner, the GIF, the links row (Docs · Reference · Discord, WC-DOC-23), the measured 16 s / 12 s and the comparison table from #168, #169, #171, #174 and #175.
What
wirecat.config.ts) and a third row for the agent skill; why a CLI and MCP, with a table of how each agent connects; a pain-to-fix table; what you get (the tree with the config files); how it works (description → config → hooks →cli-dev ready→ live check → release); the tests that come with it, with two real fault-case names from cli-core's CRM contract; the nine public CLIs made from the template; design principles; limitations (what stays hand-written, the live check needs a test account, config covers CRM only); a roadmap (GraphQL innew, configs for more categories, OAuth fromsecuritySchemes, RPC services).cliReadmeinkit/src/new.ts): says thatmcp addneeds--allow-writesfor a profile whose tools may write. Without it the printed command fails (cli-coremcp-command.js,probeStdio→potentialWrites).changes/docs-readme-why-what-how.md.Skipped from their README: news feed, star history, citation, translated READMEs, test-count badges (we have no measured count). The idea list with the reason for each is in cli-private (
plans/2026-11-16-cli-factory/readme-ideas.md).Testing
pnpm docs:check(docs rules, fragments, cspell, rumdl, markdownlint, kit docs): passed.pnpm vitest run kit(122 passed), biome andtsc -p kitonkit/src/new.ts: passed.askruns over MCP, GraphQL is not yet in a released cli-core,src/hooks.tsis not generated).Not released: docs and a one-paragraph seed change, the next release carries it.
🤖 Generated with Claude Code