docs: document fern generate --pack and --pack-mode - #6468
docs: document fern generate --pack and --pack-mode#6468devin-ai-integration[bot] wants to merge 1 commit into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
🌿 Preview your docs: https://fern-preview-devin-1785431301-document-fern-generate-pack.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
|
Closing as superseded by #6497. fern-api/fern#17307 renamed |
Summary
fern generate --packis a new CLI flag that turns anylocal-file-systemSDK output into the installable package artifact for that language (npm tarball, Python wheel, JAR,.nupkg, gem, Composer zip, crate, Go source zip), written to afern-dist/folder inside the output directory.--pack-mode dockerruns each language's packaging toolchain inside its official container image, so no host toolchains are required.This matters for teams that want to hand a generated SDK to internal consumers without publishing to a public registry. Previously the CLI only produced source directories, so someone had to build the artifact by hand with the right toolchain installed.
Pages changed
fern/products/cli-api-reference/pages/commands.mdx— canonical reference. Adds[--pack] [--pack-mode <mode>]to thefern generateusage line plus### packand### pack-modesections: per-language artifact table,fern-dist/location, full-project implication (pyproject.toml,README.md, etc.), aggregatedPackaging failed for: ...behavior and empty-dir cleanup, Swift's source-package warning,--runner podmanfor docker mode, and the rejected combinations (--packwith--previewor--docs,--pack-modewithout--pack).fern/products/sdks/reference/generators-yml-reference.mdx— one-sentence pointer in thelocal-file-systemoutput accordion.fern/products/sdks/deep-dives/self-hosted.mdx— one-sentence pointer in the "Run generation locally" step.Go is documented as producing a module source archive rather than a source-distribution warning, per the follow-up fern-api/fern#17293, which shipped in the same CLI release (5.86.0) as #17284.
No changelog entry: this is a CLI/SDK change, not a Docs-product feature.
Verification
pre-commit run --files <changed files>— Vale passed; no new findings on changed lines.cd fern && npx fern-api@5.59.0 check --warnings— 0 errors.Link to Devin session: https://app.devin.ai/sessions/8e890e1535f64065a937b9f6eee77709