Skip to content

docs(kane-cli): sync the Kane CLI docs with the GitHub user guide - #3563

Merged
Ishavyas9 merged 1 commit into
LambdaTest:stagefrom
anubhavsinghmaar:docs/kane-cli-github-parity-sep
Sep 20, 2026
Merged

Ishavyas9 merged 1 commit into
LambdaTest:stagefrom
anubhavsinghmaar:docs/kane-cli-github-parity-sep

Conversation

@anubhavsinghmaar

Copy link
Copy Markdown
Contributor

Why

The public Kane CLI docs had drifted from their source of truth, LambdaTest/kane-cli docs/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

Page From What it covers
Remote Runs — kane-cli-remote-execution.md remote-execution.md testrun 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 events
Sharing with Your Team — kane-cli-assurance-sharing.md assurance/sharing.md Sharing a .context store 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 thing

Corrections on existing pages

Mobile commands (the Slack report, same fixes as the Mintlify PR #3544):

Old, still live today Current
kane-cli doctor --install kane-cli doctor --target emulator|simulator --install
kane-cli doctor kane-cli doctor --target emulator|simulator
kane-cli doctor --targets kane-cli devices list --target <kind>
--device <id> --device-name <name> + --os-version <version>
kane-cli config set-device kane-cli config set-device-name + set-os-version
"Mobile is not supported in a batch run" Mobile tests are normal testrun members, locally and with --remote

Applied 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:

  • Unresolved variables — a run now refuses to start when an authored step references a {{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.
  • --env removed from run, testrun run, testmd sync, evidence serve, evidence merge and generate, matching the guide.
  • Context sync — environment variables on Configuration, four entries on Troubleshooting, a CI recipe on CI/CD, and the agent event contract on Agents & CI.
  • Remote runs referenced where relevant: Installation (plugins), Evidence (packs sealed on the grid), Test.md running (a runner with no Chrome), Mobile Testing (the cloud-grid path).

Sidebar

  • Remote Runs sits inside Batch Runs (testrun), which becomes a category that keeps its own page via link, the same shape as Test.md and Troubleshooting.
  • Sharing with Your Team sits inside Assurance, between Maintaining the Suite and Agents & CI.

Verified after npx docusaurus clear and a restart, since sidebar changes do not hot-reload.

Verified

  • Coverage: all 43 GitHub user-guide files map to a page, and every GitHub section was confirmed present by content (README.md is that repo's index, deliberately unported).
  • Nothing lost from Mintlify: every section of all 60 live Mintlify Kane CLI pages is present here.
  • Commands: every kane-cli command and flag on the changed lines checked against kane-cli --help, including flags the CLI marks required.
  • Links: all 233 internal links and anchors in the changed and new pages resolve.
  • Rendering: the site compiles, both new pages render, and the sidebar nesting was checked in the browser.

Notes for the Kane CLI team

GitHub's testmd/overview.md still says a grid simulator test needs an uploaded APP… id, while the newer remote-execution.md says a local build is uploaded automatically for both platforms. This PR follows the newer page.

🤖 Generated with Claude Code

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
Ishavyas9 merged commit 7e33717 into LambdaTest:stage Sep 20, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants