Ship README and LICENSE in the npm packages - #135
Merged
Conversation
The published 1.1.0 launcher tarball contains only bin/cli.js and package.json, so npmjs.com renders a blank page for @elevenlabs/cli and reports all six packages as unlicensed. The launcher takes the repository README and LICENSE from the tagged checkout. Platform packages take LICENSE from the archive they already download and verify, and get a short README saying not to install them directly — the full CLI README would be misleading on a package users are not meant to install. npm ships README and LICENSE regardless of the files array, so no files change is needed. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
PaulAsjes
enabled auto-merge (squash)
August 27, 2026 19:22
kraenhansen
approved these changes
Aug 28, 2026
kraenhansen
left a comment
kraenhansen
left a comment
Member
There was a problem hiding this comment.
Just a thought - nothing blocking 👍
| # empty and npm reports the package as unlicensed. | ||
| LICENSE_SRC=$(find extract -type f -name LICENSE -print -quit) | ||
| if [[ -n "${LICENSE_SRC}" ]]; then | ||
| install -m 0644 "${LICENSE_SRC}" "${PKG_DIR}/LICENSE" |
Member
There was a problem hiding this comment.
Used Linux as primary OS for many years and I've never used the install command (https://manpages.ubuntu.com/manpages/jammy/man1/install.1.html) - seems valuable when copying the binary above as its able to set the +x flag in a single invocation, but here it's kind of weird to not simply use a cp 🤔
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.
The 1.1.0 launcher tarball published yesterday contains exactly two files:
No README, so npmjs.com/package/@elevenlabs/cli renders a blank page, and no LICENSE, so npm reports all six packages as unlicensed. The
filesarray is["bin/"], and the platform packages have the same gap.This carried over from the generated workflow — worth reporting upstream, since any CLI built with the Fern generator will publish blank npm pages.
Changes
Launcher — copies the repository
README.mdandLICENSEfrom the tagged checkout, so the page users land on shows the CLI documentation.Platform packages — take
LICENSEfrom the archive the job already downloads and attestation-verifies, located with the samefind -type f -namelookup used for the binary rather than an assumed path, and skipped if absent. They get a short generated README saying not to install them directly; the full CLI README would be misleading on a package nobody should install by hand.No
fileschange: npm always ships README and LICENSE regardless of that array. Verified by packing a fixture withfiles: ["bin/"]— both were included, an unrelated file was not.Testing
Simulated both steps against the real v1.1.0 release archives.
Platform package, from the
.tar.gz:The
.ziplayout was checked separately, since it holds its files at the archive root rather than insideelevenlabs-cli-<target>/—findlocates bothLICENSEandelevenlabs.execorrectly there.Launcher:
The generated README renders correctly, with the escaped backticks and link surviving the heredoc.
Not fixed here
1.1.0 cannot be repaired — npm versions are immutable and the README lives in the tarball. The page stays blank until 1.2.0, which is the deliberate choice: publishing an npm-only 1.1.1 would put npm a patch ahead of Homebrew and Scoop again.