CLI
speakeasy
speakeasy
The Speakeasy CLI tool provides access to the Speakeasy.com platform
Details
Section titled “Details”Speakeasy
Section titled “Speakeasy”A CLI tool for interacting with the Speakeasy platform and its APIs.
AI Agents: run speakeasy agent context for structured documentation and project guidance.
Use this CLI to:
- Lint and validate OpenAPI specs
- Create, manage, and run Speakeasy workflows
- Configure GitHub Actions for Speakeasy workflows
- Suggest improvements to OpenAPI specs
Generate from OpenAPI Specs:
- Client and Server SDKs in GO, Python, TypeScript, Java, PHP, C#, Ruby
- Postman collections
- Terraform providers
- MCP Servers
Visit Speakeasy for more information
speakeasy [flags]Options
Section titled “Options” -h, --help help for speakeasy --logLevel string the log level (available options: [info, warn, error]) (default "info")Sub Commands
Section titled “Sub Commands”- speakeasy agent - Docs & guided workflows for AI coding agents (start here: speakeasy agent context)
- speakeasy ask - Starts a conversation with Speakeasy trained AI
- speakeasy auth - Authenticate the CLI
- speakeasy billing - Manage billing related operations
- speakeasy bump - Bumps the version of a Speakeasy Generation Target
- speakeasy clean - Speakeasy clean can be used to clean up cache, stale temp folders, and old CLI binaries.
- speakeasy configure - Configure your Speakeasy SDK Setup.
- speakeasy diff - Compare spec revisions and show SDK changes
- speakeasy lint - Lint/Validate OpenAPI documents and Speakeasy configuration files
- speakeasy merge - Merge multiple OpenAPI documents into a single document
- speakeasy openapi - Utilities for working with OpenAPI documents
- speakeasy overlay - Work with OpenAPI Overlays
- speakeasy patches - Debug and inspect pristine vs patched SDK files
- speakeasy pull - Pull a spec from the registry or list available specs/tags
- speakeasy quickstart - Guided setup to help you create a new SDK in minutes.
- speakeasy repro - Reproduce a failed generation locally
- speakeasy run - Run all the workflows defined in your workflow.yaml file. This can include multiple SDK generations from different OpenAPI sources
- speakeasy status - Review status of current workspace
- speakeasy suggest - Automatically improve your OpenAPI document with an LLM
- speakeasy tag - Add tags to a given revision of your API. Specific to a registry namespace
- speakeasy test - For each workflow target, starts the mock API server and runs testing.
- speakeasy update - Update the Speakeasy CLI to the latest version