docs: document pnpm install as unsupported (#24)#25
Merged
siddhant573 merged 3 commits intoLambdaTest:mainfrom May 7, 2026
Merged
Conversation
…g note Users installing @testmuai/kane-cli via pnpm hit a silent exit with status 2 because the v16-runner resolver in dist/index.js only searches three levels above the package's dist/ directory, while pnpm places the project-root node_modules/ four levels up. Without KANE_DEV_MODE=1 the CLI produces no stdout or stderr, which makes the failure mode hard to recognise. This change only documents the user-visible symptom and the workaround; the actual resolver fix lives in the downstream runtime and is tracked in issue LambdaTest#24. - docs/user-guide/installation.md: new "Install with pnpm or yarn" subsection that lists pnpm as unsupported, points at the new troubleshooting entry, and re-states the three supported install paths (npm global, Homebrew, shell installer). - docs/user-guide/troubleshooting.md: new "CLI exits with code 2 and no output" entry covering the two common causes (missing auth/setup, pnpm install) and the KANE_DEV_MODE=1 diagnostic. Refs: LambdaTest#24
Replaces the "one level deeper" phrasing (which depends on whether pnpm is in hoisted or isolated mode) with a mode-independent explanation: pnpm stores packages under node_modules/.pnpm/ and the resolver does not search far enough up the tree to reach that layout. Refs: LambdaTest#24
Brings the troubleshooting entry in line with the structural explanation now used in installation.md (pnpm's node_modules/.pnpm/ store is the layout the resolver does not yet traverse), so the two pages describe the same limitation in the same terms. Refs: LambdaTest#24
Collaborator
|
Thanks @gaurav0107 — going to merge this as the stopgap. The docs accurately capture the current failure mode and give users a clear workaround, which is what we need until the v16-runner resolver picks up pnpm's nested node_modules/ layout. We'll track the actual pnpm support fix under #24 and circle back to update these sections (or remove the "unsupported" framing) once that lands |
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
2 participants
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.
Summary
Documents the failure mode reported in #24 so users installing
@testmuai/kane-clivia pnpm can recognise and work around it, without pretending to fix the underlying resolver bug (which lives in the downstream runtime).Two new sections:
docs/user-guide/installation.md→ "Install with pnpm or yarn" — explains why pnpm currently fails (itsnode_modules/layout is one level deeper than thev16-runnerresolver searches), lists the three already-supported install paths (npm global, Homebrew,install.sh), and flags yarn as unverified.docs/user-guide/troubleshooting.md→ "CLI exits with code 2 and no output" — covers the two common causes (missing auth/setup, unsupported package manager) and points atKANE_DEV_MODE=1as the diagnostic that converts a silent exit into an actionable error line.The two sections cross-reference each other, and both link back to #24 so the runtime fix and the docs can converge cleanly. Nothing outside
docs/user-guide/is touched, so there is no overlap with PR #12 (README) or PR #14 (CI).Test plan
installation.md→troubleshooting.md#cli-exits-with-code-2-and-no-outputtroubleshooting.md→installation.md#install-with-pnpm-or-yarntroubleshooting.md→#authentication-failed(existing section in the same file)README.md's whole-file links to both files continue to work, andtroubleshooting.md's existinginstallation.md#updateslink is unaffected.KANE_DEV_MODE=1behaviour,SCREENSHOT_SAS_OKlog marker context).CONTRIBUTING.mdscope: documentation improvements are explicitly in scope; code is not touched.Refs: #24