Repository navigation
feat(runner): move the runner guide into the CLI's help - #1652
Merged
Erzhan Torokulov (erzhtor) merged 1 commit intoOct 6, 2026
Merged
Conversation
This was referenced Oct 6, 2026
Erzhan Torokulov (erzhtor)
marked this pull request as ready for review
October 6, 2026 11:52
Erzhan Torokulov (erzhtor)
added this pull request to stack #1653
October 6, 2026 12:29
Matt Teran (matt-teran)
approved these changes
Oct 6, 2026
Erzhan Torokulov (erzhtor)
force-pushed
the
erzhan/age-5384-runner-guide-in-help
branch
from
October 6, 2026 15:22
f51557b to
e18d76c
Compare
Erzhan Torokulov (erzhtor)
deleted the
erzhan/age-5384-runner-guide-in-help
branch
October 6, 2026 15:32
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.
Relates to AGE-5384. Stacked on #1651. Supersedes #1649.
Overview of Changes
references/runner.mdwas a 668-line hand-written guide next to the commands it described, so it drifted. Itsrunner actionssection still said sequences take notap,swipeorfillafter 1.39.0 shipped them (fixed in #1649, which this folds in). Tester never read it at all: its platform skill restates the rules instead.This PR moves that knowledge into the CLI, so it ships with the version that runs it:
--help, after its examples (execsays the value never comes back and how to read it fromevents console,runcovers what travels, env vars and the unreachable-runner trap, and so on). Sources are unwrapped text files insrc/commands/runner/guides/, laid out like the rest of--helpbyformatGuide.workflow.md.declareReferenceGuideattaches it torunner, and onlyqawolf help ref runnerprints it, soqawolf runner --helpstays short.references/runner.mdis now generated fromqawolf help ref runnerbybun run generate, and a test fails if it drifts. It stays in place for agents that can't run the CLI and for the GitHub URL older skills link to.qawolf help ref runnerfirst, with the file and URL as fallbacks.runner actionstakestap,swipe,fillandtypeon mobile, and on mobile, sendtapandswipe, neverclickordrag.Size:
help ref runneris about 62 KB, up from 25 KB of help plus a 39 KBrunner.mdread separately.Stack:
qawolf help ref [command...]prints a command subtree's full help as Markdownrunner.md's knowledge moves into each runner command's--help;runner.mdis generated fromqawolf help ref runnerqawolf-cliskill points at the CLI's help instead of restating itMerge after #1651; both ship together in 1.40.0. qawolf/platform#34845 waits for that release.
Testing
The
--helpsnapshots changed only by the appended guides. New tests coverformatGuide, the ref-only guide and its heading levels, and the drift check betweenrunner.mdandhelp ref runner. The generatedrunner.mdis stable underoxfmt. All tests pass except 3 keychain tests that also fail onmainon this machine.Checklist