docs(cli-generator): document the --schema flag - #6660
Open
fern-api[bot] wants to merge 1 commit into
Open
Conversation
Contributor
Author
|
Requested by: will.kendall |
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
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
Adds a dedicated page documenting the
--schemaflag on generated Fern CLIs, which emits the CLI's command surface as JSON for AI agents.The page covers the three scopes (
<bin> --schema,<bin> <resource> --schema,<bin> <resource> <method> --schema), the root object (globalFlags,sdkVariables,operations), the per-operation contract (input,output,defaultSelection,paginable,binaryResponse,streaming), property metadata (including thedefaultvsserverDefaultdistinction andbindingfor global flags / SDK variables / env vars), andjqrecipes. Content was verified against real output from a generated CLI.Also links to the new page from the Features page and the Overview "Runtime introspection" card, and adds it to CLI Generator navigation.
Requested by: Fern Support