Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions fern/products/sdks/generators/cli/overview.mdx
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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'currently' that become outdated

</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.
7 changes: 7 additions & 0 deletions fern/products/sdks/sdks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,13 @@ navigation:
- page: Publishing to Postman
path: ./generators/postman/publishing-to-postman.mdx
slug: publishing
- section: CLI
slug: cli
availability: pre-release
contents:
- page: Overview
path: ./generators/cli/overview.mdx
slug: overview
- section: SDK design
slug: deep-dives
collapsed: true
Expand Down
Loading