docs(kane-cli): sync the Kane CLI docs with the GitHub user guide - #3563
Merged
Ishavyas9 merged 1 commit intoSep 20, 2026
Merged
Conversation
Brings the public Kane CLI docs level with LambdaTest/kane-cli
docs/user-guide, which changed in 21 files since the last sync.
Two pages had no public counterpart and are added:
- Remote Runs (remote-execution.md): running a suite on HyperExecute with
testrun run --remote, for grid browsers and grid emulators or simulators.
- Sharing with Your Team (assurance/sharing.md): sharing a .context store
through a GitHub repository, an S3-compatible bucket or a folder.
Corrections on existing pages, the mobile commands first:
- doctor takes --target emulator|simulator, also with --install
- doctor --targets is replaced by devices list --target <kind>
- --device and config set-device become --device-name plus --os-version
and config set-device-name plus config set-os-version
- apps list --target <kind> documented for uploaded builds
- mobile tests run in a testrun batch, locally and on the grid
- a run refuses to start on an unresolved {{variable}}, with the receipt
- --env removed from five commands, as the guide no longer documents it
- context sync: environment variables, four troubleshooting entries, a CI
recipe and the agent event contract
Sidebar: Remote Runs sits inside Batch Runs (testrun), which keeps its own
page through link, and Sharing with Your Team sits inside Assurance.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Ishavyas9
approved these changes
Sep 20, 2026
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 public Kane CLI docs had drifted from their source of truth,
LambdaTest/kane-clidocs/user-guide, which changed in 21 files since the last sync on 3 September. Two of those files had no public page at all, and the mobile pages carried commands that fail on the current CLI (reported on Slack).This is one PR that brings Docusaurus level with GitHub.
New pages
kane-cli-remote-execution.mdremote-execution.mdtestrun run --remote: one HyperExecute job for a whole suite, grid browsers for web suites and grid emulators or simulators for mobile, prerequisites, the device catalog, how the app reaches the grid, what one job can hold, what comes back, failure triage, CI, and the NDJSON eventskane-cli-assurance-sharing.mdassurance/sharing.md.contextstore through a GitHub repository, an S3-compatible bucket or a folder: setup, the push and pull loop, what travels, the refusal table, and the decisions when two people change the same thingCorrections on existing pages
Mobile commands (the Slack report, same fixes as the Mintlify PR #3544):
kane-cli doctor --installkane-cli doctor --target emulator|simulator --installkane-cli doctorkane-cli doctor --target emulator|simulatorkane-cli doctor --targetskane-cli devices list --target <kind>--device <id>--device-name <name>+--os-version <version>kane-cli config set-devicekane-cli config set-device-name+set-os-versiontestrunmembers, locally and with--remoteApplied on Mobile Testing, CLI Reference, Configuration, Modes, Test.md, Batch Runs and Troubleshooting, including the structured-data copies on those pages.
Everything else from the guide:
{{name}}with no value, with a receipt naming the variable, the file and the step. Documented on Modes, Test.md running, Variables & Context, Batch Runs preflight, Troubleshooting and CI/CD.--envremoved fromrun,testrun run,testmd sync,evidence serve,evidence mergeandgenerate, matching the guide.Sidebar
link, the same shape as Test.md and Troubleshooting.Verified after
npx docusaurus clearand a restart, since sidebar changes do not hot-reload.Verified
README.mdis that repo's index, deliberately unported).kane-clicommand and flag on the changed lines checked againstkane-cli --help, including flags the CLI marks required.Notes for the Kane CLI team
GitHub's
testmd/overview.mdstill says a grid simulator test needs an uploadedAPP…id, while the newerremote-execution.mdsays a local build is uploaded automatically for both platforms. This PR follows the newer page.🤖 Generated with Claude Code