Skip to content

Commit f37211e

Browse files
committed
Sync open source content 🐝 (from 68b3712e1a3862a0522ca143b62ca6faebfd8f45)
1 parent 3e1e51d commit f37211e

7 files changed

Lines changed: 6 additions & 37 deletions

File tree

docs/cli-generation/create-cli.mdx

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,15 @@ title: "Generate a CLI from an OpenAPI Document"
33
description: "Generate a production-ready command-line interface from an OpenAPI document using Speakeasy."
44
---
55

6-
import { Callout, Table } from "@/mdx/components";
6+
import { Table } from "@/mdx/components";
77

88
# Generate a CLI from an OpenAPI document
99

10-
<Callout type="warning" title="Alpha · Early Access">
11-
CLI generation is currently in **alpha** and available exclusively to **early
12-
access** customers. Features and configuration may change. [Contact
13-
us](/book-demo) for access.
14-
</Callout>
15-
1610
Speakeasy generates a fully functional command-line interface from an OpenAPI specification. The CLI is written in Go using [Cobra](https://cobra.dev/) and wraps a generated Go SDK, providing per-operation commands, built-in authentication, multiple output formats, shell completions, and cross-platform distribution tooling.
1711

1812
## Prerequisites
1913

2014
- The [Speakeasy CLI](/docs/speakeasy-reference/cli/getting-started)
21-
- Early access to CLI generation. [Contact sales](/book-demo) for access.
2215
- An API spec in a supported format:
2316

2417
<Table

docs/cli-generation/customize-cli.mdx

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,10 @@ title: "Customize a CLI"
33
description: "Customize command naming, authentication, output, interactivity, and release behavior of your generated CLI."
44
---
55

6-
import { Callout, Table } from "@/mdx/components";
6+
import { Table } from "@/mdx/components";
77

88
# Customize a CLI
99

10-
<Callout type="warning" title="Alpha · Early Access">
11-
CLI generation is currently in **alpha** and available exclusively to **early
12-
access** customers. Features and configuration may change. [Contact
13-
us](/book-demo) for access.
14-
</Callout>
15-
1610
The generated CLI can be customized through `gen.yaml`, shared OpenAPI-driven generation settings, and a small set of CLI-specific runtime defaults. This page focuses on the options that most directly affect generated CLI behavior. For the full set of target options, see the [CLI configuration reference](/docs/speakeasy-reference/generation/cli-config).
1711

1812
## CLI-specific generator settings

docs/cli-generation/distribute-cli.mdx

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,6 @@ import { Callout, Table } from "@/mdx/components";
77

88
# Distribute a CLI
99

10-
<Callout type="warning" title="Alpha · Early Access">
11-
CLI generation is currently in **alpha** and available exclusively to **early
12-
access** customers. Features and configuration may change. [Contact
13-
us](/book-demo) for access.
14-
</Callout>
15-
1610
<Callout type="info">
1711
CLI distribution currently uses generated GoReleaser configuration and release
1812
scripts rather than the standard `speakeasy configure publishing` workflow.

docs/cli-generation/index.mdx

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,10 @@ title: "CLI generation"
33
description: "Generate production-ready command-line interfaces from your OpenAPI specification."
44
---
55

6-
import { Callout, Table } from "@/mdx/components";
6+
import { Table } from "@/mdx/components";
77

88
# CLI generation
99

10-
<Callout type="warning" title="Alpha · Early Access">
11-
CLI generation is currently in **alpha** and available exclusively to **early
12-
access** customers. Features and configuration may change. [Contact
13-
us](/book-demo) for access.
14-
</Callout>
15-
1610
Speakeasy can generate a fully functional command-line interface (CLI) from an OpenAPI specification. The generated CLI is written in Go using [Cobra](https://cobra.dev/), wraps a generated Go SDK, and ships with human-friendly and automation-friendly interfaces out of the box.
1711

1812
## Getting started

docs/sdks/core-concepts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ A target refers to an SDK, agent tool, docs, or other code generated from source
3232
- **[Agent tools](/docs/standalone-mcp/build-server)** are a new surface for interacting with APIs. They provide a way for LLMs and other agentic platforms to interact with APIs. We support [MCP server generation](/docs/standalone-mcp/build-server) with other tools on the way.
3333
- **[Documentation](/docs/sdk-docs/code-samples/generate-code-samples)** is available in the form of an API reference. Generated docs will include with SDK code snippets for every API method. Code snippets can also be embedded into an existing documentation site.
3434
- **[Terraform providers](/docs/create-terraform)** can be generated from an annotated OpenAPI document. Terraform providers do not map 1:1 with APIs and so annotations are required to specify the Terraform entities and their methods.
35-
- **[CLI tools](/docs/cli-generation/create-cli)** (Alpha) can be generated from an OpenAPI document to provide a command-line interface for interacting with the API. The generated CLI is written in Go using Cobra and includes per-operation commands, multiple output formats, and cross-platform distribution tooling.
35+
- **[CLI tools](/docs/cli-generation/create-cli)** (Beta) can be generated from an OpenAPI document to provide a command-line interface for interacting with the API. The generated CLI is written in Go using Cobra and includes per-operation commands, multiple output formats, and cross-platform distribution tooling.
3636

3737
### Workflow file syntax
3838

docs/sdks/languages/maturity.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ data={[ { target: "[TypeScript](/docs/languages/typescript/methodology-ts)", mat
5353
{ target: "[Terraform](/docs/create-terraform)", maturity: "GA", support: "Level 2" },
5454
{ target: "Postman", maturity: "Alpha", support: "Level 1" },
5555
{ target: "MCP Typescript", maturity: "Beta", support: "Level 2" },
56-
{ target: "[CLI](/docs/cli-generation/create-cli)", maturity: "Alpha", support: "Level 1" },
56+
{ target: "[CLI](/docs/cli-generation/create-cli)", maturity: "Beta", support: "Level 1" },
5757
]}
5858
/>
5959

docs/speakeasy-reference/generation/cli-config.mdx

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,7 @@
1-
import { Table, Callout } from "@/mdx/components";
1+
import { Table } from "@/mdx/components";
22

33
# CLI configuration options
44

5-
<Callout type="warning" title="Alpha · Enterprise Only">
6-
CLI generation is currently in **alpha** and available exclusively to
7-
**Enterprise** customers. [Contact us](https://www.speakeasy.com/pricing) for
8-
access.
9-
</Callout>
10-
115
This section details the available configuration options for the CLI target. All configuration is managed in the `gen.yaml` file under the `cli` section.
126

137
Fields marked as required are always present in `gen.yaml` and auto-populated with defaults during `speakeasy quickstart`. They can be overridden but must not be removed.

0 commit comments

Comments
 (0)