-
Notifications
You must be signed in to change notification settings - Fork 7
Add CLI generator overview page (pre-release) #5292
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
fern-api
wants to merge
6
commits into
main
Choose a base branch
from
fern/cli-generator-page
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+56
−1
Open
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
15c95c7
Add CLI generator overview page (pre-release)
fern-api[bot] f6bf504
Condense CLI generator page and add development callout
fern-api[bot] 6a672c4
Reframe CLI generator page based on blog post — agents + humans
fern-api[bot] a48af3c
condense and clarify
devalog 3fa256c
change to beta/early access
devalog 31cb0da
new product
devalog File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| title: CLI generator | ||
| description: Generate a fully functional command-line interface from your API definition. Give your users a CLI experience alongside your SDK. | ||
| --- | ||
|
|
||
| <Note title="In Development"> | ||
| The CLI generator is currently in development. [Contact us](https://buildwithfern.com/contact) to learn more or request early access. | ||
| </Note> | ||
|
|
||
| Fern's CLI generator produces a command-line tool from your API definition — the same source that powers your SDKs. Instead of asking users to write curl commands or integrate an SDK for quick tasks, you give them a native CLI they can install and run immediately. | ||
|
|
||
| ## Why generate a CLI | ||
|
|
||
| **Automation without code.** Teams that manage infrastructure or run CI/CD pipelines prefer a CLI over writing SDK code. A generated CLI works in shell scripts, cron jobs, and pipelines out of the box. | ||
|
|
||
| **Consistent developer experience.** Commands map directly to your API endpoints. Users who know your API can predict CLI behavior, and you avoid maintaining a separate command structure that drifts over time. | ||
|
|
||
| **Faster time to first API call.** Users authenticate once and start making calls immediately — no project setup, no dependencies, no boilerplate. | ||
|
|
||
| ## Common use cases | ||
|
|
||
| | Use case | Example | | ||
| | --- | --- | | ||
| | CI/CD automation | Deploy services, trigger builds, or sync configurations in pipelines | | ||
| | Infrastructure management | Create, update, and delete resources from the terminal | | ||
| | Data operations | Export records, run batch updates, or stream logs | | ||
| | Internal tooling | Give operations teams a purpose-built tool for common tasks | | ||
|
|
||
| ## How it fits with SDKs | ||
|
|
||
| The CLI generator complements your SDKs. SDKs are the right choice when users build applications on top of your API. The CLI is the right choice for discrete operations — quick lookups, one-off mutations, or scripted workflows. Both are generated from the same source and stay in sync as your API evolves. | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[FernStyles.Current] Avoid time-relative terms like 'currently' that become outdated