docs: document packageIdentity config for the CLI generator - #6467
Merged
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
🤖 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:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1785431223-cli-generator-package-identity.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Describe the template crate identity as the default rather than as wrong. Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Replace the field/Cargo-key table with indented per-field ParamFields, matching the nested-object pattern used elsewhere in the reference docs. Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
devalog
approved these changes
Aug 11, 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
1 participant
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
The CLI generator now accepts an opt-in
packageIdentityblock in itsconfig, which sets the Cargo[package]metadata of the generated crate: name, description, license, repository, homepage, authors, and keywords. By default the generated crate uses the template's identity (fern-cli-sdk, plus Fern's repository and authors), so customers publishing a branded CLI need a way to make the crate theirs.Changes:
fern/products/cli-generator/configuration.mdx: new<ParamField path="packageIdentity">underconfigoptions, matching the page's existing pattern. Covers the YAML example, a field-to-Cargo-key table, the crate-name validation (fails at generation time rather than atcargo build), theCargo.lockrename socargo build --lockedstill resolves, and that[lib] nameis intentionally not configurable.fern/products/cli-generator/publishing.mdx: one-sentence pointer noting the npm package name is separate from the crate identity, linking to the reference rather than duplicating it.No Docs-product changelog entry (CLI/SDK-side change).
Source: fern-api/fern#17282
Checks:
pre-commit run --files <changed>passes (only pre-existing Vale warnings on untouched lines), andfern check --warningsreports 0 errors.Link to Devin session: https://app.devin.ai/sessions/3438a7cadeaa4f3ba6367f81f71986a5