docs: document the real install path and CLI surface - #17
Merged
Conversation
README still described the package as "under construction. Initial
scaffolding only" and listed `pip install yertle[cli] # planned`. yertle
0.2.0 has been on PyPI since today; the scaffolding language predates the
first release.
Replaces it with the install path users are actually pointed at:
uv tool install "yertle[sre,mcp]"
uv rather than Homebrew, because the tap is macOS-only, lags each release by
a formula PR, and — since Homebrew 6.0 — greets new users with an "untrusted
tap" error before anything installs. The brew formula is itself a wrapper
around this exact command. The tap keeps working for anyone already using it;
it is simply no longer the documented default.
The command table lists what the CLI actually ships (version, login, orgs,
auth status), verified against `yertle --help` rather than written from
memory — the first draft of this table claimed node operations the CLI does
not have.
Also marks the Homebrew step in docs/mcp/OVERVIEW.md's cutover plan as done,
since it shipped in homebrew-yertle PR #1.
Co-Authored-By: Claude Opus 5 (1M context) <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
1 participant
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
README.mdstill said:and listed
pip install yertle[cli] # + \yertle` commandunder **Planned shape**.yertle` 0.2.0 has been on PyPI since today — the scaffolding language predates the first release.What it says now
uv tool install "yertle[sre,mcp]"uv rather than Homebrew because the tap is macOS-only, lags every release by a formula PR, and — since Homebrew 6.0 — greets new users with an
untrusted taperror before anything installs. The formula is itself a wrapper around this exactuv tool installcommand, so brew was buying a trust prompt and a release lag in front of a one-liner.The tap keeps working. It's just no longer the documented default.
Plus a
pip install yertlesection for SDK-as-a-library use, and a short note on credential resolution pointing atyertle auth status.A correction worth noting
My first draft of the command table claimed
yertledoes "orgs, auth, and node operations." It doesn't — there are no node commands. Fixed by diffing againstyertle --helprather than trusting my own summary:Also
docs/mcp/OVERVIEW.md's cutover plan listed "Update Homebrew tap to wrap the PyPI package" as pending; it shipped in homebrew-yertle PR #1 on 2026-08-14. Marked done, with a note that uv is now the documented path.Testing
make checkgreen (81 tests). Docs-only change; no source touched.🤖 Generated with Claude Code